@cutau/common-config

Common configuration files.

Installation

Typically, this package is installed as a devDependency in your root package.json file.

bun add --dev @cutau/common-config

Usage

TypeScript - tsconfig.json

@cutau/common-config publishes standard TypeScript configuration files. To use any of these TypeScript configuration files in your project or package, extend them in your tsconfig.json file.

Here is an example tsconfig.json file for your project or package.

// tsconfig.json
{
  "extends": "@cutau/common-config/tsconfig-base.json",
  "include": ["src"],
  "exclude": ["node_modules", "dist"],
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src"
  }
}

Prettier - prettier.mjs

@cutau/common-config publishes a standard Prettier configuration file, prettier.mjs. To use it in your project or package, add it as the prettier field in your package.json file.

Here is an example package.json file for your project or package.

// package.json
{
  ...
  "prettier": "@cutau/common-config/prettier.mjs"
  ...
}

ESLint v9 - eslint.config.mjs

@cutau/common-config publishes a standard ESLint v9 configuration file, eslint.config.mjs. To use it in your project or package, import it into your ESLint file, eslint.config.mjs, at the root of your project.

Here is an example eslint.config.mjs file for your project.

// eslint.config.mjs
export { default } from "@cutau/common-config/eslint.config.mjs";