@bootcamp-project/eslinttier

Ready-to-use ESLint & Prettier Configuration

with best practice settings by default

🦄 About 🦄

Minimum Viable Product: What is what we want?

The creation and deployment of a centralized sharable configuration, with the most well-known best practice approaches.

• What are the goals?
  • [X] Automation of publishing, testing, linting and packaging with GitLab-CI
  • [X] Provide understandable documentation for the use of the configuration
  • [X] Test the return of the configuration with unit tests and the validation of the configuration structure with smoke tests.
  • [X] For the greatest possible compatibility we provide TypeScript definitions
  • [X] Use the unified ESLint and Prettier configuration for static analysis of the source code
  • [X] Choose the known best practices to configure ESLint and Prettier so that the source code is uniformly and security-consciously linted

🚀 Getting Started 🚀

Project Links

• Homepage
• Documentation
• Repository
• Issues

💪 Installation 💪

yarn add @bootcamp-project/eslinttier

or

npm install @bootcamp-project/eslinttier

🤩 Usage 🤩

See @bootcamp-project/eslinttier preselections

Best practice ESLint & Prettier Config Example

// .eslintrc.js
'use strict';

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

If you want more...

// .eslintrc.js
'use strict';

const ESLintConfig = require('@bootcamp-project/eslinttier').ESLintConfig
module.exports = {
  ...ESLintConfig,  // 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'
  }
}

Prettier Config Example

// .prettierrc.js
'use strict';

const PrettierConfig = require('@bootcamp-project/eslinttier').PrettierConfig
module.exports = PrettierConfig

If you want more...

// .prettierrc.js
'use strict';

const PrettierConfig = require('@bootcamp-project/eslinttier').PrettierConfig
module.exports = {
  ...PrettierConfig, // Takes the TBCP base settings
  // ...
  // add your own Prettier settings here
  // ...
}

⭐️ Features ⭐️

• TypeScript definitions (@types) included
• Smoke and Unit-tested modules
• Latest Dependencies preinstalled Batteries included!
• Security-first production-ready configurations by default
• Extensive documentation

😎 Built With 😎

🏆 Acknowledgements 🏆

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

• Library: ESLint
• Library: Prettier
• How-to: RTFM.page: ESLint & Prettier
• How-to: RTFM.page: Mocha + Chai
• How-to: RTFM.page: TypeScript
• How-to: TBCP-Framework: Modern Web Application

📑 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.

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

📜 License 📜

See LICENSE for more information.

💌 Contact 💌

Bootcamp contributors - contributors @ bootcamp-project .com