aesop-code-styles

The goal of this project is to locate the linting and formatting rules we use in one location. These exported configurations can then be used by our various code bases to provide consistent code.

Usage

Installation

npm install -D @aesop-engineering/code-styles

Eslint

This library exports different eslint configurations for different environments (node, browser) and languages (JS, TS). The exported configurations are:

• node
• node-ts
• browser
• browser-ts

In your eslint config file extend the eslint configuration most relevant to your package using one of the above. For example, for a frontend written in TS

// .eslintrc.js

module.exports = {
  extends: ['./node_modules/@aesop-engineering/code-styles/eslint/browser-ts.js'],
};

Note: the environment for the browser eslint configurations does not include Node. This will cause eslint to complain when module.exports or Node global variables such as __dirname are accessed. This is intentional to prevent using them in the code that will be shipped to the browser. To correctly address this for files that run in Node, such as babel.config.js please do one of:

1. Add this comment to the top of the file /* eslint-env node */

2. Override the default behaviour for those files to manually set the environment by adding the following to the eslint config in the project

   "overrides": [
       {
         "files": ["babel.config.js", "other files running in Node"],
         "env": {
           "node": true
         }
       }
     ]

Prettier

In your prettier config file, import the prettier configuration exported by this package

// .prettierrc.js

module.exports = {
  ...require('@aesop-engineering/code-styles/.prettierrc'),
};

Stylelint

In your stylelint config file, extend the stylelint configuration exported by this package

// stylelint.config.js

module.exports = {
  extends: ['@aesop-engineering/code-styles/stylelint.config.js'],
};

Contributing

This repo enforces commit message formats as they are used to automatically version the package using semantic versioning.

To add/or change the rules in this repo:

1. branch off from main
2. make the changes you wish to make. Ensure you use the correct commit type, otherwise the version might not be incremented
3. raise a PR to main, ensuring to get reviews from as many members of the dev team as possible
4. merge and wait for a new version to be published

Publishing new versions

To publish to NPM this repo uses the X_NPM_TOKEN from the Aesop org secrets.

Note that this secret will expire on 1st June 2024.