@bootcamp-project/eslint-config

Ready-to-use ESLint Configuration

with best practice settings by default

About

ESLint is a static code analysis tool that we use to analyze our Node.js / JavaScript, TypeScript and Svelte repositories. With this package we offer all our best practice settings.

Project Links

• Homepage
• Repository
• Documentation
• Issues

Minimum Viable Product: What is what we want?

• What are the goals?
  • Offer a single package with all the necessary dependencies and the safest possible linting settings.
• Sense (Why do these goals exist?)
  • To provide easy management of the linting settings for various repositories
• Purpose (What should be done with it?)
  • There should be a central code base for linting settings

Getting Started

Installation

yarn add --dev eslint @bootcamp-project/eslint-config

Usage

See TBCP ESLint settings

// .eslintrc.js
'use strict';

const ESLintConfig = require('@bootcamp-project/eslint-config').ESLintConfig
module.exports = ESLintConfig

...with security-first

// .eslintrc.js
'use strict';

const ESLintSecurity = require('@bootcamp-project/eslint-config').ESLintSecurity
module.exports = ESLintSecurity

and, if you want more...

// .eslintrc.js
'use strict';

const ESLintSecurity = require('@bootcamp-project/eslint-config').ESLintSecurity
module.exports = {
  ...ESLintSecurity,  // Takes the TBCP base settings
  // ...
  // Place to specify ESLint settings. Can be used to overwrite rules specified from the extended configs
  // ...
  rules: {
    // e.g. "no-secrets/no-secrets": "error",
		'no-secrets/no-secrets': 'error',
		'pii/no-email': 'error',
		'pii/no-dob': 'warn',
		'pii/no-ip': 'error',
		'pii/no-phone-number': 'error'
  }
}

️ Features ️

• Latest preinstalled Dependencies by default
• Standard compatibility with JavaScript and TypeScript
• Security-first production ready configuration by default
• Extensive configuration documentation

Built With

Acknowledgements

Thanks for these awesome resources that were used during the development of the Bootcamp: ESLint Configuration:

• ESLint
• prettier/eslint-plugin-prettier
• nodesecurity/eslint-plugin-security
• mozilla/eslint-plugin-no-unsanitized
• nickdeis/eslint-plugin-no-secrets
• shiva-hack/eslint-plugin-pii
• RTFM.page: ESLint

Changelog

See CHANGELOG for more information.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contribute

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Please read the contribution guidelines first.

1. Give us a star, it's really important!
2. Fork the Project: (git clone https://gitlab.com/the-bootcamp-project/configurations/eslint.git)
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

License

See LICENSE for more information.

Contact

Bootcamp contributors - contributors @ bootcamp-project .com