Skip to content
/ config Public

Dexa's standardized TypeScript, ESLint, and Prettier configuration.

Notifications You must be signed in to change notification settings

dexaai/config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@dexaai/config

Standardized TypeScript, ESLint, and Prettier configuration for Dexa's TypeScript projects.

Why does this exist?

  1. Consistent and familiar configuration across Dexa projects
  2. Reduces configuration boilerplate in each project
  3. Reduces time spent keeping configuration updated and in sync

Usage

1. Add Dependency

Install @dexaai/config as a dev dependency.

2. Configure Prettier

Add the following line to your package.json:

  "prettier": "@dexaai/config/prettier",

3. Configure ESLint

Create a eslint.config.js file in the root of the project:

import { config } from '@dexaai/config/eslint';

/** @type {import("eslint").Linter.Config[]} */
export default [...config];

4. Configure TypeScript

Create a tsconfig.json file in the root that extends @dexaai/config/tsconfig-node or @dexaai/config/tsconfig-react. You will still need to specify includes and any compilerOptions you want to add or override.

{
  "extends": "@dexaai/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["**/node_modules", "**/.*/"],
  "compilerOptions": {
    // Add or override compiler options here
  },
}

5. Add TypeScript Reset

This is just a convenient export of @total-typescript/ts-reset.

About

Dexa's standardized TypeScript, ESLint, and Prettier configuration.

Resources

Stars

Watchers

Forks

Packages

No packages published