TypeScript Configuration by silverwind

Common errors

• error TS6053: File '...' not found.

  cause This error often occurs when the `include` or `exclude` arrays in your project's `tsconfig.json` overwrite the base configuration from `typescript-config-silverwind` and unintentionally omit necessary source files or declaration files.
  fix Ensure your `tsconfig.json`'s `include` patterns explicitly cover all your source files, type declaration files, and other assets required for compilation, as they will completely override the base config's settings.

• error TS7006: Parameter 'x' implicitly has an 'any' type.

  cause The `typescript-config-silverwind` configuration likely enables `noImplicitAny`, requiring explicit type annotations for function parameters, variables, or properties where TypeScript cannot infer a specific type.
  fix Add explicit type annotations (e.g., `function foo(param: string)`) to resolve these errors. If an `any` type is truly intended, explicitly declare it (e.g., `param: any`) to satisfy the compiler.

• error TS2532: Object is possibly 'undefined'.

  cause This configuration enforces `strictNullChecks`, meaning that `null` and `undefined` are not assignable to types unless explicitly included (e.g., `string | null`). Accessing properties on potentially null or undefined values will result in this error.
  fix Implement proper null/undefined checks (e.g., `if (obj) { obj.property }`), use optional chaining (`obj?.property`), or the non-null assertion operator (`obj!.property`) with caution if you are certain the value is not null/undefined at runtime.

Warnings

• breaking When extending `typescript-config-silverwind`, any `include` or `exclude` arrays defined in your project's `tsconfig.json` will *completely replace* those from the base configuration, rather than merging. This can inadvertently omit files from compilation or include unwanted ones, leading to build errors or unexpected type checking behavior.
  Fix: Always explicitly define all required `include` and `exclude` patterns in your project's `tsconfig.json` when extending this configuration to ensure correct file resolution.
• breaking Each major version of `typescript-config-silverwind` likely updates its `compilerOptions` to reflect the latest TypeScript best practices and features. These updates can introduce stricter checks (e.g., `noImplicitAny`, `strictNullChecks`, `noUncheckedIndexedAccess`) that might cause existing code to fail compilation, especially if migrating from a less strict setup.
  Fix: Review the TypeScript release notes for the corresponding major version and adapt your codebase to meet the new strictness requirements. Gradually introduce the new configuration or fix errors as they appear.
• gotcha This package is a `tsconfig.json` extender and does not expose any JavaScript/TypeScript modules for direct `import` or `require` statements in application code. Attempting to import symbols from `typescript-config-silverwind` will result in module resolution errors at compile or runtime, as its sole purpose is to configure the TypeScript compiler itself.
  Fix: Do not attempt to import this package into your `.ts` or `.js` files. Its functionality is purely declarative through the `extends` property in `tsconfig.json`.

Install

• npm install typescript-config-silverwind npm
• yarn add typescript-config-silverwind yarn
• pnpm add typescript-config-silverwind pnpm

Imports

• Configuration Extension
  wrong:

  import { AnyConfig } from 'typescript-config-silverwind';

  correct:

  { "extends": "typescript-config-silverwind" } in tsconfig.json

  This package is a TypeScript configuration preset, not a runtime library. It is consumed via the 'extends' property in your project's `tsconfig.json` file, not through JavaScript/TypeScript import statements.
• tsconfig.json 'include' pattern

  { "include": ["src/**/*", "test/**/*"] } in tsconfig.json

  When extending, your local 'include' and 'exclude' arrays *overwrite* the base config's. Explicitly define all desired files or patterns.
• Configuration Override

  { "extends": "typescript-config-silverwind", "compilerOptions": { "target": "es2021" } } in tsconfig.json

  Properties in 'compilerOptions' are merged, with your local `tsconfig.json` taking precedence for conflicting options.

Quickstart

Demonstrates how to extend the `typescript-config-silverwind` preset in your project's `tsconfig.json`, including how to override specific `compilerOptions` and correctly specify `include` and `exclude` paths.

{
  "extends": "typescript-config-silverwind",
  "compilerOptions": {
    // Override specific compiler options if needed
    "outDir": "./dist",
    "jsx": "react-jsx"
  },
  "include": [
    "src/**/*",
    "types/**/*",
    "test/**/*",
    "**/.*",
    "**/.*/**/*",
    "**/.*/**/.*"
  ],
  "exclude": [
    "node_modules",
    "dist"
  ]
}