Ready-to-use TypeScript Configuration

with Security-first and ESLint settings by default

🦄 About 🦄

Description

Project Links

• Homepage
• Repository
• Documentation
• Issues

Minimum Viable Product: What is what we want?

• What are the goals?
  • Goal #1
  • Goal #2
  • Goal #3
• Sense (Why do these goals exist?)
  • Explanation #1
  • Explanation #2
  • Explanation #3
• Purpose (What should be done with it?)
  • Use Case #1
  • Use Case #2
  • Use Case #3

🚀 Getting Started 🚀

💪 Installation 💪

npm install --safe-dev typescript @bootcamp-project/typescript-config
# or
yarn add --dev typescript @bootcamp-project/typescript-config

🤩 Usage 🤩

TBCP Best Practice

See TBCP default TypeScript settings

// tsconfig.json
{
    "extends": "@bootcamp-project/typescript-config/src/tsconfig.json",
    "include": [
        "src/**/*"
    ],
    "exclude": [
        "node_modules/*"
    ],
    "compilerOptions": {
        "target": "es5", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
        "removeComments": false, /* Disable emitting comments. */
        "module": "commonjs", /* Specify what module code is generated. */
        "outDir": "./dist", /* Specify an output folder for all emitted files. */
        "declarationDir": "./dist/@types", /* Specify the output directory for generated declaration files. */
        "declaration": true, /* Generates corresponding '.d.ts' file. */
        "declarationMap": false, /* Generates a sourcemap for each corresponding '.d.ts' file. */
        "sourceMap": false, /* Create source map files for emitted JavaScript files. */
        "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
        "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
    }
}

🤓 Static Analysis 🤓

// .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 ⭐️

• Latest preinstalled Dependencies by default
• 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: TypeScript Configuration:

• TypeScript

📑 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. Fork the Project
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