tsconfig

A Typescript shareable config.

Typescript dependency

Note that the version range specified for the typescript package peer dependency is using a >= specifier rather than the usual ^ specifier.

Why? ^ would be the correct specifier to use for a dependent package that uses semver, so that the consuming package gets minor & patch version updates - but never a breaking change that comes from a major version change.

But the typescript package doesn't follow semver :( Instead they say that no breaking changes are ever expected.. which we'll see about (sources: https://github.com/microsoft/TypeScript/issues/39269, https://www.semver-ts.org/, and so on).

For this reason - ensure that you are pinning to a specific version of typescript in your package-lock.json file.

Installation

Run the following command (this will also install dependencies):

pnpm add --save-dev @its-tailtime/tsconfig

Then, create a tsconfig.json file at the root of your repository containing the following:

{
  "extends": "@its-tailtime/tsconfig",
  "compilerOptions": {
    "types": [] // Add your global types here - e.g. ['node'] for node apps, ["webpack-env", "jest"] for legacy vue apps
  },
  "include": ["src/**/*.vue", "src/**/*.ts", "tests/**/*.ts", "*.ts"],
  "exclude": ["node_modules"]
}

Filepaths such as include & exclude must be specified per repository as they're not shareable.

You can override settings from the shareable config by adding them directly into your tsconfig.json file.

Exports

tsconfig.json

Default Typescript configuration export which should be used for common purposes.

node.json

For packages intended to be consumed by node-oriented apps / libraries. We just use tsup to build node libraries, rather than Vite (which isn't really designed for building Node.js-based code as it's more browser-oriented) or Typescript itself (as it's dog slow). Additional settings are required on top of the base ones to support building a node-oriented library.

• We set "importHelpers": false to resolve https://github.com/microsoft/TypeScript/issues/37991 for node packages built in Typescript.

scripts.json

Typescript configuration for internal scripts.