Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/exercism/eslint-config-typescript
https://github.com/exercism/eslint-config-typescript
community-contributions-paused
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/exercism/eslint-config-typescript
- Owner: exercism
- License: mit
- Created: 2021-04-14T12:34:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T14:07:12.000Z (10 months ago)
- Last Synced: 2024-05-01T11:25:16.180Z (8 months ago)
- Topics: community-contributions-paused
- Language: JavaScript
- Size: 973 KB
- Stars: 0
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# @exercism/eslint-config-typescript
This is the shared [`eslint`][web-eslint] configuration used by the [TypeScript track][git-typescript] (for students) and the files contributors and maintainers touch.
[Shareable configs][web-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][web-exercism] in your on projects!
## Usage
To use the configuration for students, open your [eslint configuration][web-eslint-configuration] file, and import the following file for the flat config.
For example, for flat config configuration files:
```javascript
import baseConfig from '@exercism/eslint-config-typescript';
// ...
export default [
...baseConfig,
// ... your configuration
];
```
To use the configuration used by contributors and maintainers, add the following:
```javascript
import baseConfig from '@exercism/eslint-config-typescript/maintainers';
// ...
export default [
...baseConfig,
// ... your configuration
];
```
## Students configuration
Find the student configuration [here](index.mjs).
Its goal is to help detect and prevent common problems, without making _any_ decisions about code-style.
The rules are based on:
- [`eslint:recommended`][web-eslint-recommended]
- A few extra rules that catch common issues but are not enabled via the recommended plugin.
See [this PR][git-javascript-pr-1094] for a bit of discussion and rationale.
- Adding TypeScript _specific_ rules.
Because the [Exercism TypeScript track][git-typescript] 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](maintainers.mjs), it also includes the [`prettier` plugin][git-eslint-plugin-prettier] because we use [`prettier`][web-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][git-typescript-analyzer], [Representer][git-typescript-representer], and [Test Runner][git-typescript-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][git-eslint-config-tooling].
## Development
If you want to work on this repository, install the dependencies using `corepack` and `yarn`:
```shell
corepack enable yarn
corepack yarn install
# or similar, see yarn documentation
# https://yarnpkg.com/getting-started/editor-sdks
corepack yarn dlx @yarnpkg/sdks vscode
```
[git-eslint-config-tooling]: https://github.com/exercism/eslint-config-tooling
[git-eslint-plugin-import]: https://github.com/benmosher/eslint-plugin-import
[git-eslint-plugin-prettier]: https://github.com/prettier/eslint-config-prettier
[git-typescript]: https://github.com/exercism/typescript
[git-typescript-analyzer]: https://github.com/exercism/typescript-analyzer
[git-javascript-pr-1094]: https://github.com/exercism/javascript/pull/1094
[git-typescript-representer]: https://github.com/exercism/typescript-representer
[git-typescript-test-runner]: https://github.com/exercism/typescript-test-runner
[web-eslint]: https://eslint.org
[web-eslint-configuration]: https://eslint.org/docs/user-guide/configuring/
[web-eslint-recommended]: https://eslint.org/docs/rules/
[web-exercism]: https://exercism.io
[web-prettier]: https://prettier.io
[web-shareable-configs]: https://eslint.org/docs/developer-guide/shareable-configs