@terminal-nerds/typescript-config

➡️ Extendable TypeScript configuration, part of the terminal-nerds/configs project.

Prerequisites

ℹ️ This configuration package require these tools to use locally on your device(s):

1. Latest Node.js LTS (Long-Term Support) version
2. One of Node.js package managers:
   • pnpm
   • yarn
   • npm
3. Latest TypeScript version

Basic usage

👣 Follow the steps below:

1. Install it with the Node.js package manager of your choice (in our case, we use pnpm).

    pnpm install --save-dev eslint @terminal-nerds/eslint-config

2. Create an TypeScript configuration file - tsconfig.json.

3. Extend this module package configuration.

   {
   	"$schema": "https://json.schemastore.org/tsconfig",
   	"extends": "@terminal-nerds/typescript-config"
   }

📖 For the TypeScript CLI usage, please refer to its documentation.

Available options

| Name | Purpose | | ----------- | ------------------------------------------------------- | | base | For the general usage | | browser | For a project which is related to building a web app | | common-js | For building a Node.js package in CommonJS format | | es-module | For building a Node.js package in ES Modules format |

Used configurations & plugins

None, so far.

Security

🔐 For more information, please refer to the Security section at the root of the terminal-nerds/configs monorepo.

Contributing

🤝 Contributions of any kind are welcome!

Please refer to the monorepo (terminal-nerds/configs) project's CONTRIBUTING file for more information if you wish to get involved.

License

⚖️ For more information, please refer to the License section at the root of the terminal-nerds/configs monorepo.