|
| 1 | +# Type-Aware Linting |
| 2 | + |
| 3 | +Read our [technical preview announcement](/blog/2025-08-17-oxlint-type-aware) for technical decision and background details. |
| 4 | + |
| 5 | +## Installation |
| 6 | + |
| 7 | +```bash |
| 8 | +pnpm add -D oxlint-tsgolint@latest |
| 9 | +``` |
| 10 | + |
| 11 | +Run `oxlint` with `--type-aware` |
| 12 | + |
| 13 | +```bash |
| 14 | +oxlint --type-aware |
| 15 | +``` |
| 16 | + |
| 17 | +## Unsupported Features |
| 18 | + |
| 19 | +The current version runs the default behavior and does nothing else. |
| 20 | + |
| 21 | +The following issues will be addressed for the alpha version. |
| 22 | + |
| 23 | +- [Allow configuring rules](https://github.com/oxc-project/tsgolint/issues/51) |
| 24 | +- [Disable comments are not respected](https://github.com/oxc-project/oxc/issues/13491) |
| 25 | +- [Type Checker is not enabled](https://github.com/oxc-project/tsgolint/issues/106) |
| 26 | +- [IDE support](https://github.com/oxc-project/tsgolint/issues/71) |
| 27 | + |
| 28 | +## Unimplemented Rules |
| 29 | + |
| 30 | +See https://github.com/oxc-project/tsgolint/issues/104 |
| 31 | + |
| 32 | +## Configuration |
| 33 | + |
| 34 | +List of supported rules: |
| 35 | + |
| 36 | +```json |
| 37 | +{ |
| 38 | + "$schema": "./node_modules/oxlint/configuration_schema.json", |
| 39 | + "rules": { |
| 40 | + "typescript/await-thenable": "error", |
| 41 | + "typescript/no-array-delete": "error", |
| 42 | + "typescript/no-base-to-string": "error", |
| 43 | + "typescript/no-confusing-void-expression": "error", |
| 44 | + "typescript/no-duplicate-type-constituents": "error", |
| 45 | + "typescript/no-floating-promises": "error", |
| 46 | + "typescript/no-for-in-array": "error", |
| 47 | + "typescript/no-implied-eval": "error", |
| 48 | + "typescript/no-meaningless-void-operator": "error", |
| 49 | + "typescript/no-misused-promises": "error", |
| 50 | + "typescript/no-misused-spread": "error", |
| 51 | + "typescript/no-mixed-enums": "error", |
| 52 | + "typescript/no-redundant-type-constituents": "error", |
| 53 | + "typescript/no-unnecessary-boolean-literal-compare": "error", |
| 54 | + "typescript/no-unnecessary-template-expression": "error", |
| 55 | + "typescript/no-unnecessary-type-arguments": "error", |
| 56 | + "typescript/no-unnecessary-type-assertion": "error", |
| 57 | + "typescript/no-unsafe-argument": "error", |
| 58 | + "typescript/no-unsafe-assignment": "error", |
| 59 | + "typescript/no-unsafe-call": "error", |
| 60 | + "typescript/no-unsafe-enum-comparison": "error", |
| 61 | + "typescript/no-unsafe-member-access": "error", |
| 62 | + "typescript/no-unsafe-return": "error", |
| 63 | + "typescript/no-unsafe-type-assertion": "error", |
| 64 | + "typescript/no-unsafe-unary-minus": "error", |
| 65 | + "typescript/non-nullable-type-assertion-style": "error", |
| 66 | + "typescript/only-throw-error": "error", |
| 67 | + "typescript/prefer-promise-reject-errors": "error", |
| 68 | + "typescript/prefer-reduce-type-parameter": "error", |
| 69 | + "typescript/prefer-return-this-type": "error", |
| 70 | + "typescript/promise-function-async": "error", |
| 71 | + "typescript/related-getter-setter-pairs": "error", |
| 72 | + "typescript/require-array-sort-compare": "error", |
| 73 | + "typescript/require-await": "error", |
| 74 | + "typescript/restrict-plus-operands": "error", |
| 75 | + "typescript/restrict-template-expressions": "error", |
| 76 | + "typescript/return-await": "error", |
| 77 | + "typescript/switch-exhaustiveness-check": "error", |
| 78 | + "typescript/unbound-method": "error", |
| 79 | + "typescript/use-unknown-in-catch-callback-variable": "error" |
| 80 | + } |
| 81 | +} |
| 82 | +``` |
0 commit comments