DevSecOps Academy Eslint Profile

This package contains the default eslint configuration for all Javascript coding done in DevSecOps academy

It is primarily based on the AirBnB styleguide/ruleset with any deviations listed and explained in the later section

FAQ

How to I install/configure this for my repo?

Install this package (and eslint if you haven't already):

npm install --save-dev @devsecopsacademy/eslint-config

you can then install the required peerdependencies with:

npx install-peerdeps --dev @devsecopsacademy/eslint-config

then Simply tell configure it in your .eslintrc.js file:

module.exports = {
    extends: '@devsecopsacademy' 
    // Note: we use the shorthand, but you can handle it in other ways if you want: https://eslint.org/docs/developer-guide/shareable-configs#npm-scoped-modules
};

It's also recommended to add the following scripts to your package.json:

{
    "scripts": {
        "lint": "eslint ./",
        "lint:fix": "npm run lint -- --fix"
    }
}

so you can run them as npm run lint (or npm run lint:fix to auto fix some of the issues)

Frontend package

You can also use our frontend specific configuration, also based on Airbnb's rules.

This can be accessed as: @devsecopsacademy/eslint-config/frontend in your eslintrc.js

module.exports = {
    extends: '@devsecopsacademy/eslint-config/frontend' 
};

Variance from AirBnB

You will notice some additional rules in the ./index.js file that have been added/changed.

TODOs

• [x] Publish to the npm organisation
• [ ] Write out the variances from the AirBnB base config.