@exercism/eslint-config-typescript

@exercism/eslint-config-typescript

This is the shared eslint configuration used by the TypeScript track (for students) and the files contributors and maintainers touch. Shareable configs are designed to work with the extends feature of ESLint configuration files. This means you can use the same configuration you're used to on Exercism in your on projects!

Usage

To use the configuration for students, open your eslint configuration file, and import the following file for the flat config. For example, for flat config configuration files:

import baseConfig from '@exercism/eslint-config-typescript';

// ...
export default [
  ...baseConfig,
  // ... your configuration
];

To use the configuration used by contributors and maintainers, add the following:

import baseConfig from '@exercism/eslint-config-typescript/maintainers';

// ...
export default [
  ...baseConfig,
  // ... your configuration
];

Students configuration

Find the student configuration here. Its goal is to help detect and prevent common problems, without making any decisions about code-style.

The rules are based on:

• eslint:recommended
• A few extra rules that catch common issues but are not enabled via the recommended plugin. See this PR for a bit of discussion and rationale.
• Adding TypeScript specific rules.

Because the Exercism TypeScript track is primarily focussing on running the exercises on Node, only node globals are turned on in the environment, but when extending this configuration, you can add more (or turn those off).

Maintainers configuration

Similar to the students configuration, and found here, it also includes the prettier plugin because we use prettier to achieve consistent code formatting. This plugin turns off rules that conflict with formatting.

Additionally, it doesn't have warnings but errors for most/all of the rules in the students configuration.

Tooling configuration

Because the tooling (such as the TypeScript Analyzer, Representer, and Test Runner) are written in TypeScript, they don't use the same configuration files. If you're looking for those, or to build your own tools in TypeScript, go to @exercism/eslint-config-tooling.

Development

If you want to work on this repository, install the dependencies using corepack and yarn:

corepack enable yarn
corepack yarn install

# or similar, see yarn documentation
# https://yarnpkg.com/getting-started/editor-sdks
corepack yarn dlx @yarnpkg/sdks vscode