Skip to content
This repository has been archived by the owner on Jun 22, 2024. It is now read-only.

Latest commit

 

History

History
136 lines (91 loc) · 4.69 KB

README.md

File metadata and controls

136 lines (91 loc) · 4.69 KB

@terminal-nerds/typescript-config

package version badge

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


Prerequisites

node.js version support badge supported typescript version badge

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

  1. node.js icon Latest Node.js LTS (Long-Term Support) version
  2. One of Node.js package managers:
  3. Latest typescript icon TypeScript version

Basic usage

👣 Follow the steps below:

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

     pnpm install --save-dev eslint @terminal-nerds/eslint-config
  2. Create an typescript icon 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 icon TypeScript CLI usage, please refer to its documentation.


Available options

Dependencies badge

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

Dependencies badge

None, so far.


Security

workflow security badge

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


Contributing

contributors badge

🤝 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

license badge

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