@genie-solutions/eslint-config-genie

ESLINT CONFIG GENIE

This is our shareable eslint configuration to be used for all JavaScript and TypeScript projects.

It enforces some sensible code styling guidelines and encourages consistency across our projects.

How to Use

run: npm install @genie-solutions/eslint-config-genie --save-dev

then create .eslintrc.js:

module.exports = {
  extends: [ "@genie-solutions/eslint-config-genie" ]
}

Contributing

Start by socialising the change you would like to make with other developers, and when it seems like the general consensus is that it would be a positive one, continue with this process.

• Add an example file showcasing the practical implications of the change you would like to make. See the "Examples" section below for more details.
• Make the necessary changes to the .eslintrc.js file.
• Run the test suite to ensure your config changes have the desired effect. See the "Test Suite" section below for more details.
• Open a merge request and get it merged.

Examples

The examples directory contains examples of good and bad code according to the eslint config.

It is intended to serve as a showcase of the practical application of the rules being enforced.

Try to keep the files related to a single rule or concept.

Sometimes there are errors or warnings which get in the way of simplicity, for example in the following code eslint will complain if you do not assign the array to a variable, and if you do assign it to a variable then it will complain that the variable is not used anywhere. It is obviously necessary to disable this warning to prevent writing a whole bunch of code which is not useful here.

// This allows expressions (like arrays and hashes / objects) without assigning or returning.
/* eslint-disable no-unused-expressions */
[{
    message1: 'hi',
    message2: 'bye',
}];
/* eslint-enable no-unused-expressions */

Test Suite

The test framework for this project is a bash script which runs the examples (in "examples" dir) through eslint. The "good" examples pass if no errors are raised, and the "bad" examples pass if errors are raised.

Simply execute test.sh to run the tests.

Deploying

TODO