@ls-stack/extended-lint 0.91.0 → 2.0.0

package/README.md

@@ -6,186 +6,33 @@ To use any of these rules, you need to install the package:
 pnpm add -D @lucasols/eslint-plugin-extended-lint
 ```
 
+There is no `typescript` peer dependency (only an optional `eslint` one), so it works with any TypeScript version (including TypeScript 7) or none at all, and also as an [oxlint JS plugin](https://oxc.rs/docs/guide/usage/linter/js-plugins).
+
 And then configure it in your eslint config:
 
 ```json
 {
   "plugins": ["@lucasols/extended-lint"],
   "rules": {
-    "@lucasols/extended-lint/no-unused-type-props-in-args": "error"
+    "@lucasols/extended-lint/<rule-name>": "error"
   }
 }
 ```
 
-## `no-unused-type-props-in-args`
-
-Checks if there are unused type props in function arguments.
-
-Examples
-
-Bad
-
-```ts
-function foo({ a }: { a: string; b: string }) {
-  /*                             ^ b is declared but not used in the function */
-  // ...
-}
-```
-
-Good
-
-```ts
-function foo({ a, b }: { a: string; b: string }) {
-  // ...
-}
-```
-
-It will also work with the react `FC` type:
-
-Bad
-
-```ts
-const Foo: FC<{ a: string; b: string }> = ({ a }) => {
-  /*                       ^ b is declared but not used in the component */
-  // ...
-}
-```
-
-Good
-
-```
-const Foo: FC<{ a: string; b: string }> = ({ a, b }) => {
-  // ...
-}
-```
-
-- This rule will not work in all situations, as it does not checks all possible usages of referenced types.
-
-## `no-commented-out-code`
-
-Checks if there are commented code. Block comments are ignored.
-
-Examples
-
-Bad:
-
-```ts
-// function foo() {
-//   // ...
-// }
-```
-
-Good:
-
-```ts
-/*
-function foo() {
-  // ...
-}
-*/
-```
-
-- This rule will not detect all possible commented code, and can give false negatives.
-
-## `no-call-with-infered-generics`
-
-This rule disallows calling functions with inferred generics.
-
-The rule options types are as follows:
-
-````ts
-type Options = [
-  {
-    functions: Array<{
-      name: string;
-      minGenerics?: number;
-      allowAny?: boolean;
-      disallowTypes?: string[];
-    }>;
-    anyAliases?: string[];
-  }
-];
-
-Examples:
-
-Bad:
-
-```ts
-// @typescript-eslint/no-call-with-inferred-generics: ["error", { functions: ["foo"] }]
-
-function foo<T>(arg: T) {
-  // ...
-}
-
-foo('bar') // Error: Generics must be defined explicitly
-foo<any>('bar') // Error: 'any' is not allowed in generics
-````
-
-Good:
-
-```ts
-// @typescript-eslint/no-call-with-inferred-generics: ["error", { functions: ["foo"] }]
-function foo<T>(arg: T) {
-  // ...
-}
-
-foo<string>('bar') // OK
-```
-
-## `rules-of-hooks`
-
-A fork of the `eslint-plugin-react-hooks` `rules-of-hooks` rule, but with the following changes:
-
-- Identifies hooks in camelCase namespaced functions (e.g. `test.useFoo()`)
-
-## `strict-casting`
-
-Enforces safe and necessary `String()`/`Number()` casts. Replaces the deprecated `no-unnecessary-casting` rule.
-
-Checks performed:
-
-- **Unnecessary casts** (auto-fixable): casting a value that is already of the target type
-- **Nullish casts**: `String(value)` produces the strings `"null"`/`"undefined"`, and `Number(value)` produces `0` for `null` and `NaN` for `undefined`. A suggestion is provided to add a `?? ''`/`?? 0` fallback
-- **Invalid `Number()` casts**: casting a `symbol` (throws at runtime) or an object without a numeric `valueOf` (always results in `NaN`)
-- **`any`/`unknown` casts**: casting untyped values is unsafe, type or narrow the value before casting
-
-Bad:
-
-```ts
-declare const str: string
-declare const nullable: string | null
-declare const obj: { a: string }
-
-String(str) // Error: unnecessary cast
-String(nullable) // Error: may produce "null"
-Number(obj) // Error: results in NaN
-```
-
-Good:
-
-```ts
-String(num)
-String(nullable ?? '')
-Number(date) // Date has a numeric valueOf
-```
-
-Options:
-
-```ts
-type Options = [
-  {
-    /** Extra functions checked for unnecessary casts */
-    additionalCastFunctions?: { name: string; expectedType: 'string' | 'number' }[]
-    /** Allow casting possibly nullish values (default: false) */
-    allowNullishCasting?: boolean
-    /** Allow symbol/object Number() casts (default: false) */
-    allowInvalidCasting?: boolean
-    /** Allow casting `any` values (default: false) */
-    allowAnyCasting?: boolean
-    /** Allow casting `unknown` values, e.g. `String(err)` in catch blocks (default: false) */
-    allowUnknownCasting?: boolean
-  },
-]
-```
-
-For `String(obj)` producing `"[object Object]"`, use `@typescript-eslint/no-base-to-string`, which covers that case well.
+Rules are being migrated to [`@ls-stack/fast-lint`](../fast-lint), where these now live (same names and options, so
+`@ls-stack/<rule>` configs and disable comments keep working there): `improved-no-unnecessary-condition`,
+`strict-casting` (also replaces the removed `no-unnecessary-casting`), `no-unnecessary-void-on-promise`,
+`advanced-no-restricted-syntax` (now `no-restricted-syntax`), `no-default-export`, `no-reexport`, `no-relative-imports`,
+`no-sync-dynamic-import`, `no-leaked-text-in-jsx`, `no-static-style-prop`, `no-non-camel-case-functions`,
+`prefer-named-functions`, `no-call-with-explicit-generics`, `no-call-with-inferred-generics`, `no-unnecessary-typing`,
+`no-type-guards`, `use-state-setter-naming`, `require-lazy-execution`, `no-unnecessary-iife`, `require-description`,
+`no-write-only-ref`, `no-commented-out-code`, `react-single-export`, `no-unused-optional-args`,
+`no-unused-type-props-in-args`, `no-unused-t-state-field`, `no-unused-selected-values`, `no-optional-root-props`,
+`no-redundant-function-params`, `react-no-module-level-single-use-values`, `require-reads-to-var-prop`,
+`prefer-react-hook-alternative`, `sort-react-components-and-styles`, `use-types-directly-above-usage` and
+`react-compiler-extra`. The `rules-of-hooks` and `exhaustive-deps` forks were removed; use `eslint-plugin-react-hooks`
+(or oxlint's built-in rules) instead.
+
+Remaining rules: `collapse-simple-objs-in-one-line`, `no-data-attributes-on-components`, `no-restricted-comments`,
+`no-unnecessary-async-on-jsx-props`, `no-unnecessary-describe`, `no-unused-obj-props`, `react-compiler-migration`,
+`require-usage-explanation`, `template-indent` and `use-top-level-regex`.

package/dist/extended-lint.d.mts

@@ -1,5 +1,14 @@
-import { TSESLint } from '@typescript-eslint/utils';
+type ExtendedLintRuleListener = {
+    visit(node: unknown): void;
+}['visit'];
+type ExtendedLintRule = {
+    meta?: object;
+    create(context: never): Record<string, ExtendedLintRuleListener | undefined>;
+};
 
-declare const extendedLintPlugin: TSESLint.FlatConfig.Plugin;
+type ExtendedLintPlugin = {
+    rules: Record<string, ExtendedLintRule>;
+};
+declare const extendedLintPlugin: ExtendedLintPlugin;
 
-export { extendedLintPlugin as default, extendedLintPlugin };
+export { type ExtendedLintPlugin, extendedLintPlugin as default, extendedLintPlugin };

package/dist/extended-lint.d.ts

@@ -1,5 +1,14 @@
-import { TSESLint } from '@typescript-eslint/utils';
+type ExtendedLintRuleListener = {
+    visit(node: unknown): void;
+}['visit'];
+type ExtendedLintRule = {
+    meta?: object;
+    create(context: never): Record<string, ExtendedLintRuleListener | undefined>;
+};
 
-declare const extendedLintPlugin: TSESLint.FlatConfig.Plugin;
+type ExtendedLintPlugin = {
+    rules: Record<string, ExtendedLintRule>;
+};
+declare const extendedLintPlugin: ExtendedLintPlugin;
 
-export { extendedLintPlugin as default, extendedLintPlugin };
+export { type ExtendedLintPlugin, extendedLintPlugin as default, extendedLintPlugin };