TypeScript icon, indicating that this package has built-in type declarations

2.3.2 • Public • Published

Ready-to-use TypeScript Configuration

with Security-first settings, ESLint and TSDoc 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] Create a best possible configuration for using TypeScript at disposal

🚀 Getting Started 🚀

Project Links

💪 Installation 💪

yarn add @bootcamp-project/typescript-config


npm install @bootcamp-project/typescript-config

🤩 Usage 🤩

See @bootcamp-project/typescript-config preselections

Best practice TypeScript Config Example

// .eslintrc.js
'use strict';

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

If you want more...

// .eslintrc.js
'use strict';

const ESLintConfig = require('@bootcamp-project/typescript-config').ESLintTypeScript
module.exports = {
  ...ESLintConfig, // Takes the TBCP base settings
  // ...
  // add your own ESLint settings here
  // ...

⭐️ Features ⭐️

😎 Built With 😎

TypeScript tbcp

🏆 Acknowledgements 🏆

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

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


npm i @bootcamp-project/typescript-config

DownloadsWeekly Downloads






Unpacked Size

50.4 kB

Total Files


Last publish


  • bootcamp-project