Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sylphlab/typescript-config

shtse861MIT0.3.1

Reusable TypeScript configurations for SylphLab projects

typescript, tsconfig, configuration, sylphlab, strict, preset, base, react, vue, node

readme

@sylphlab/typescript-config

npm version License: MIT

Overview

Reusable TypeScript configurations for SylphLab projects. This package provides a set of shareable, extendable TypeScript configurations for different environments and frameworks.

Features

  • Strongly-Typed: Strict TypeScript configurations designed to catch potential issues early
  • Environment-Specific: Dedicated configurations for Node.js, DOM, React, Vue, and React Native
  • Modern Defaults: Latest TypeScript features and ECMAScript targets
  • Extensible: Easy to extend and customize for your specific project needs

Installation

npm install --save-dev @sylphlab/typescript-config
# OR
yarn add --dev @sylphlab/typescript-config
# OR
pnpm add --save-dev @sylphlab/typescript-config

Usage

Extend the configuration in your project's tsconfig.json:

Node.js Project

{
  "extends": "@sylphlab/typescript-config/node",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["src/**/*"]
}

React Project

{
  "extends": "@sylphlab/typescript-config/react",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["src/**/*"]
}

Vue Project

{
  "extends": "@sylphlab/typescript-config/vue",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["src/**/*"]
}

React Native Project

{
  "extends": "@sylphlab/typescript-config/react-native",
  "compilerOptions": {
    "outDir": "dist"
  },
  "include": ["src/**/*"]
}

Available Configurations

  • @sylphlab/typescript-config/base - Base configuration with strict settings
  • @sylphlab/typescript-config/node - Node.js environment
  • @sylphlab/typescript-config/dom - Browser environment
  • @sylphlab/typescript-config/react - React projects
  • @sylphlab/typescript-config/vue - Vue projects
  • @sylphlab/typescript-config/react-native - React Native projects

License

MIT © SylphLab