Skip to content

cyrilletuzi/typescript-strictly-typed

Repository files navigation

TypeScript Strictly Typed

Configure TypeScript, ESLint, Biome, Deno and/or Angular to ensure fully typed code. Because strict mode is not enough.

A posts series explains the motivation of this lib.

Tip

I am also the author of the Angular Schematics extension for Visual Studio Code, installed 1 million times. Feel free to give it a try.

Getting started

Just run the following commands in your terminal:

cd path/to/my-project-with-tsconfig
npx typescript-strictly-typed@latest

Important

Going fully typed is a choice to make at the very beginning of a project.

Enabling all strict options at once in an existing project is not recommended, as hundred of errors would appear. Converting an existing project to full strict mode is still possible and encouraged, but it should be done incrementally, by activating each option one by one.

What does it do?

It modifies these configurations:

  • TypeScript compiler options
    • strict (includes: noImplicitAny, strictNullChecks, alwaysStrict, strictBindCallApply, strictFunctionTypes, strictPropertyInitialization, noImplicitThis, useUnknownInCatchVariables)
    • exactOptionalPropertyTypes
    • noFallthroughCasesInSwitch
    • noImplicitOverride
    • noImplicitReturns
    • noPropertyAccessFromIndexSignature
    • noUncheckedIndexedAccess
  • ESLint rules
    • eqeqeq
    • prefer-arrow-callback
    • prefer-template
  • TypeScript ESLint rules
    • @typescript-eslint/explicit-function-return-type
    • @typescript-eslint/no-explicit-any
    • @typescript-eslint/no-non-null-assertion
    • @typescript-eslint/no-unsafe-argument
    • @typescript-eslint/no-unsafe-assignment
    • @typescript-eslint/no-unsafe-call
    • @typescript-eslint/no-unsafe-member-access
    • @typescript-eslint/no-unsafe-return
    • @typescript-eslint/prefer-for-of
    • @typescript-eslint/prefer-nullish-coalescing
    • @typescript-eslint/prefer-optional-chain
    • @typescript-eslint/restrict-plus-operands
    • @typescript-eslint/restrict-template-expressions
    • @typescript-eslint/strict-boolean-expressions
    • @typescript-eslint/use-unknown-in-catch-callback-variable
  • Biome linter rules
    • noDoubleEquals
    • noExplicitAny
    • noImplicitAnyLet
    • noNonNullAssertion
    • useArrowFunction
    • useForOf
    • useOptionalChain
    • useTemplate
  • Angular compiler options
    • strictInjectionParameters
    • strictInputAccessModifiers
    • strictTemplates
  • Angular ESLint options
    • @angular-eslint/template/no-any
  • Deno
    • add the same compiler options as for TypeScript
    • add the same lint rules as for ESLint (the ones which exist in Deno)

Note

To keep configuration concise, you may not see all TypeScript, Biome and Deno options added, if they are already enabled by an existing preset. All ESLint rules will be added, as ESLint configuration is too complex to detect presets.

License

MIT