Commencis JS Toolkit

This project is a comprehensive suite of internal packages designed to elevate JavaScript coding standards at Commencis.

The repository is structured as a monorepo, which allows for managing all the packages together in a unified manner. Please follow the information given in each package's own README file for integrations and configurations.

Package Index

Package	NPM
@commencis/commitlint-config
@commencis/eslint-config
@commencis/eslint-plugin
@commencis/stylelint-config
@commencis/prettier-config

For Contributors:

Prerequisites

Node.js

Before you begin, ensure you have node: >= 20.17 installed on your system.

pnpm

This project uses pnpm: >= 9.10.0 as the package manager. You can install it either by activating with corepack which is the recommended way:

corepack prepare pnpm@latest --activate
corepack enable pnpm

or install globally on your system with npm.

npm install -g pnpm

Installation

Run the following command to install project dependencies:

pnpm install

Development

You can run the following command to start development environment:

pnpm run dev

Contribution

We welcome contributions to improve this project. Feel free to open issues or pull requests to suggest enhancements or report any issues.

Important

For developers contributing to this project, it's important to familiarize yourself with these tools, as they are integral to the workflow and code quality standards.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

© Commencis, 2024. All rights reserved.