Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/susisu/eslint-plugin-safe-typescript
ESLint plugin that makes your TypeScript code safer
https://github.com/susisu/eslint-plugin-safe-typescript
Last synced: 2 months ago
JSON representation
ESLint plugin that makes your TypeScript code safer
- Host: GitHub
- URL: https://github.com/susisu/eslint-plugin-safe-typescript
- Owner: susisu
- License: mit
- Created: 2022-03-05T08:27:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T14:38:34.000Z (3 months ago)
- Last Synced: 2024-10-11T21:19:36.588Z (3 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@susisu/eslint-plugin-safe-typescript
- Size: 796 KB
- Stars: 20
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @susisu/eslint-plugin-safe-typescript
[](https://github.com/susisu/eslint-plugin-safe-typescript/actions?query=workflow%3ACI)
An [ESLint](https://eslint.org) plugin that makes your TypeScript code safer
## Installation
This plugin requires [TypeScript](https://www.typescriptlang.org/) and [typescript-eslint](https://typescript-eslint.io/).
If you haven't installed them in your project, follow the guide on typescript-eslint's [Getting Started](https://typescript-eslint.io/getting-started) page.
Once you're ready, install this plugin:
``` shell
# npm
npm i --save-dev @susisu/eslint-plugin-safe-typescript
# yarn
yarn add -D @susisu/eslint-plugin-safe-typescript
# pnpm
pnpm add -D @susisu/eslint-plugin-safe-typescript
```
## Configuration
1. Enable typescript-eslint parser
2. Add `@susisu/eslint-plugin-safe-typescript` to plugins
3. (Optional) Add `parserOptions.project` if you enable rules that use type information.
`.eslintrc`:
``` json
{
"parser": "@typescript-eslint/parser", // (1)
"parserOptions": {
"project": true // (3)
},
"plugins": ["@susisu/safe-typescript"], // (2)
"rules": {
"@susisu/safe-typescript/no-object-assign": "error"
}
}
```
`eslint.config.js`:
``` js
import tsEslint from "typescript-eslint";
import safeTsPlugin from "@susisu/eslint-plugin-safe-typescript";
export default [
{
languageOptions: {
parser: tsEslint.parser, // (1)
parserOptions: {
project: true, // (3)
},
},
plugins: {
"@susisu/safe-typescript": safeTsPlugin, // (2)
},
rules: {
"@susisu/safe-typescript/no-object-assign": "error",
},
},
];
```
## Recommended configuration
This plugin also provides a configuration set for the recommended rules (see [Rules](#rules) for which rules are recommended).
Since some rules in the recommended configuration require type information, `parserOptions.project` must be set in your config.
`eslintrc`
``` json
{
"extends": ["plugin:@susisu/safe-typescript/recommended"]
}
```
`eslint.config.js`
``` js
export default [
safeTsPlugin.configs.recommended,
// or extend in `rules`
// {
// rules: {
// ...safeTsPlugin.configs.recommended.rules,
// },
// },
];
```
## Rules
✅ = recommended, 🔧 = fixable, 💭 = requires type information
| Name | Description | ✅ | 🔧 | 💭 |
| --- | --- | --- | --- | --- |
| [`no-object-assign`](https://github.com/susisu/eslint-plugin-safe-typescript/blob/main/src/rules/no-object-assign/README.md) | Disallow the use of `Object.assign()`. | ✅ | | |
| [`no-type-assertion`](https://github.com/susisu/eslint-plugin-safe-typescript/blob/main/src/rules/no-type-assertion/README.md) | Disallow type assertions like `x as T`. | ✅ | | |
| [`no-unsafe-object-enum-method`](https://github.com/susisu/eslint-plugin-safe-typescript/blob/main/src/rules/no-unsafe-object-enum-method/README.md) | Disallow possibly unsafe property enumeration methods of `Object`. | ✅ | | 💭 |
| [`no-unsafe-object-property-check`](https://github.com/susisu/eslint-plugin-safe-typescript/blob/main/src/rules/no-unsafe-object-property-check/README.md) | Disallow possibly unsafe property checks of object. | ✅ | | 💭 |
| [`no-unsafe-object-property-overwrite`](https://github.com/susisu/eslint-plugin-safe-typescript/blob/main/src/rules/no-unsafe-object-property-overwrite/README.md) | Disallow possibly unsafe overwrites of object properties. | ✅ | | 💭 |
## Contributing
Issues and PRs are welcome!
Feel free to open issues if you have any problems or ideas.
## License
[MIT License](http://opensource.org/licenses/mit-license.php)
## Author
Susisu ([GitHub](https://github.com/susisu), [Twitter](https://twitter.com/susisu2413))