Skip to content

README.md

Latest commit

 

History

History
63 lines (41 loc) · 2.51 KB

README.md

File metadata and controls

63 lines (41 loc) · 2.51 KB

@culur/config-typescript

NPM Version NPM Download NPM License

CodeFactor Codecov Build and release

Sharing tsconfig.json.

✨ Features

There are 3 configurations:

File Alias Target Module Description
tsconfig.base.json base - - Base configuration
tsconfig.json . ES2021 ESNext Default configuration
tsconfig.bun.json bun ESNext ESNext Configuration specific to bun (Suggested compilerOptions)

💿 Installation

Add @culur/config-typescript dependency to your project.

# Using npm
npm install @culur/config-typescript --save-dev

# Using pnpm
pnpm install @culur/config-typescript --dev

# Using yarn
yarn add @culur/config-typescript --dev

Other packages:

  • Use need to install typescript and @types/node packages in devDependencies.

🔌 Requirements

  • Node.js >= 20
  • TypeScript >= 5.1

📖 Usage

Add to your tsconfig.json:

{
  "extends": "@culur/config-typescript",
}

🗃️ Changelog

See CHANGELOG for more information on what has changed recently.

🔒 License

See LICENSE for license rights and limitations (MIT).