@robot-inventor/oxlint-config 0.0.0 → 0.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 roboin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 roboin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# oxlint-config
+
+[@Robot-Inventor](https://github.com/Robot-Inventor/)'s OXLint config presets.
+
+## Installation
+
+```bash
+npm install --save-dev @robot-inventor/oxlint-config
+```
+
+## Usage
+
+Create an `oxlint.config.ts` file and export one of the six presets:
+
+```ts
+import { oxlintConfig } from "@robot-inventor/oxlint-config";
+
+export default oxlintConfig;
+```
+
+The available presets are:
+
+- `oxlintConfig`
+- `oxlintConfigNoJSDoc`
+- `oxlintReactConfig`
+- `oxlintReactConfigNoJSDoc`
+- `oxlintNextConfig`
+- `oxlintNextConfigNoJSDoc`
+
+The `NoJSDoc` presets check existing JSDoc comments but do not require JSDoc on every declaration.
+
+## Overriding rules
+
+OXLint only inherits `rules`, `plugins`, and `overrides` through its `extends` property. Use object spread so
+that type-aware linting, settings, and JavaScript plugin registrations are retained:
+
+```ts
+import { oxlintNextConfigNoJSDoc } from "@robot-inventor/oxlint-config";
+import { defineConfig } from "oxlint";
+
+export default defineConfig({
+    ...oxlintNextConfigNoJSDoc,
+    rules: {
+        "no-console": "off"
+    }
+});
+```
+
+Do not use a preset only through `extends: [preset]`; root-level options and settings would not be inherited.

package/dist/base-rules.d.ts

@@ -0,0 +1,377 @@
+declare const baseRules: {
+    readonly "accessor-pairs": "error";
+    readonly "array-callback-return": "error";
+    readonly "arrow-body-style": "error";
+    readonly "block-scoped-var": "error";
+    readonly "capitalized-comments": "error";
+    readonly "class-methods-use-this": "error";
+    readonly complexity: "error";
+    readonly "constructor-super": "error";
+    readonly curly: ["error", "multi-line"];
+    readonly "default-case": "error";
+    readonly "default-case-last": "error";
+    readonly "default-param-last": "error";
+    readonly eqeqeq: "error";
+    readonly "for-direction": "error";
+    readonly "func-name-matching": "error";
+    readonly "func-names": "error";
+    readonly "func-style": "error";
+    readonly "getter-return": "error";
+    readonly "grouped-accessor-pairs": "error";
+    readonly "guard-for-in": "error";
+    readonly "id-denylist": "error";
+    readonly "id-length": ["error", {
+        readonly exceptions: ["T", "K", "i", "j", "x", "y", "z"];
+    }];
+    readonly "id-match": "error";
+    readonly "init-declarations": "error";
+    readonly "logical-assignment-operators": "error";
+    readonly "max-classes-per-file": "error";
+    readonly "max-depth": "error";
+    readonly "max-lines": "error";
+    readonly "max-lines-per-function": "error";
+    readonly "max-nested-callbacks": "error";
+    readonly "max-params": "error";
+    readonly "max-statements": "error";
+    readonly "new-cap": "error";
+    readonly "no-alert": "error";
+    readonly "no-array-constructor": "error";
+    readonly "no-async-promise-executor": "error";
+    readonly "no-await-in-loop": "error";
+    readonly "no-bitwise": "error";
+    readonly "no-caller": "error";
+    readonly "no-case-declarations": "error";
+    readonly "no-class-assign": "error";
+    readonly "no-compare-neg-zero": "error";
+    readonly "no-cond-assign": "error";
+    readonly "no-console": "error";
+    readonly "no-const-assign": "error";
+    readonly "no-constant-binary-expression": "error";
+    readonly "no-constant-condition": "error";
+    readonly "no-constructor-return": "error";
+    readonly "no-continue": "error";
+    readonly "no-control-regex": "error";
+    readonly "no-debugger": "error";
+    readonly "no-delete-var": "error";
+    readonly "no-div-regex": "error";
+    readonly "no-dupe-class-members": "error";
+    readonly "no-dupe-else-if": "error";
+    readonly "no-dupe-keys": "error";
+    readonly "no-duplicate-case": "error";
+    readonly "no-duplicate-imports": "error";
+    readonly "no-else-return": "error";
+    readonly "no-empty": "error";
+    readonly "no-empty-character-class": "error";
+    readonly "no-empty-function": "error";
+    readonly "no-empty-pattern": "error";
+    readonly "no-empty-static-block": "error";
+    readonly "no-eq-null": "error";
+    readonly "no-eval": "error";
+    readonly "no-ex-assign": "error";
+    readonly "no-extend-native": "error";
+    readonly "no-extra-bind": "error";
+    readonly "no-extra-boolean-cast": "error";
+    readonly "no-extra-label": "error";
+    readonly "no-fallthrough": "error";
+    readonly "no-func-assign": "error";
+    readonly "no-global-assign": "error";
+    readonly "no-implicit-coercion": "error";
+    readonly "no-implicit-globals": "error";
+    readonly "no-import-assign": "error";
+    readonly "no-inline-comments": "error";
+    readonly "no-inner-declarations": "error";
+    readonly "no-invalid-regexp": "error";
+    readonly "no-irregular-whitespace": "error";
+    readonly "no-iterator": "error";
+    readonly "no-label-var": "error";
+    readonly "no-labels": "error";
+    readonly "no-lone-blocks": "error";
+    readonly "no-lonely-if": "error";
+    readonly "no-loop-func": "error";
+    readonly "no-loss-of-precision": "error";
+    readonly "no-magic-numbers": ["error", {
+        readonly ignoreArrayIndexes: true;
+    }];
+    readonly "no-misleading-character-class": "error";
+    readonly "no-multi-assign": "error";
+    readonly "no-multi-str": "error";
+    readonly "no-negated-condition": "error";
+    readonly "no-nested-ternary": "error";
+    readonly "no-new-func": "error";
+    readonly "no-new-native-nonconstructor": "error";
+    readonly "no-new-wrappers": "error";
+    readonly "no-nonoctal-decimal-escape": "error";
+    readonly "no-obj-calls": "error";
+    readonly "no-object-constructor": "error";
+    readonly "no-param-reassign": "error";
+    readonly "no-promise-executor-return": "error";
+    readonly "no-proto": "error";
+    readonly "no-prototype-builtins": "error";
+    readonly "no-redeclare": "error";
+    readonly "no-regex-spaces": "error";
+    readonly "no-restricted-exports": "error";
+    readonly "no-restricted-globals": "error";
+    readonly "no-restricted-imports": "error";
+    readonly "no-restricted-properties": "error";
+    readonly "no-return-assign": "error";
+    readonly "no-script-url": "error";
+    readonly "no-self-assign": "error";
+    readonly "no-self-compare": "error";
+    readonly "no-sequences": "error";
+    readonly "no-setter-return": "error";
+    readonly "no-shadow": "error";
+    readonly "no-shadow-restricted-names": "error";
+    readonly "no-sparse-arrays": "error";
+    readonly "no-template-curly-in-string": "error";
+    readonly "no-this-before-super": "error";
+    readonly "no-unassigned-vars": "error";
+    readonly "no-undef": "error";
+    readonly "no-undefined": "error";
+    readonly "no-underscore-dangle": "error";
+    readonly "no-unmodified-loop-condition": "error";
+    readonly "no-unneeded-ternary": "error";
+    readonly "no-unreachable": "error";
+    readonly "no-unreachable-loop": "error";
+    readonly "no-unsafe-finally": "error";
+    readonly "no-unsafe-negation": "error";
+    readonly "no-unsafe-optional-chaining": "error";
+    readonly "no-unused-expressions": "error";
+    readonly "no-unused-labels": "error";
+    readonly "no-unused-private-class-members": "error";
+    readonly "no-unused-vars": "error";
+    readonly "no-use-before-define": "error";
+    readonly "no-useless-assignment": "error";
+    readonly "no-useless-backreference": "error";
+    readonly "no-useless-call": "error";
+    readonly "no-useless-catch": "error";
+    readonly "no-useless-computed-key": "error";
+    readonly "no-useless-concat": "error";
+    readonly "no-useless-constructor": "error";
+    readonly "no-useless-escape": "error";
+    readonly "no-useless-rename": "error";
+    readonly "no-useless-return": "error";
+    readonly "no-var": "error";
+    readonly "no-void": ["error", {
+        readonly allowAsStatement: true;
+    }];
+    readonly "no-warning-comments": "error";
+    readonly "no-with": "error";
+    readonly "object-shorthand": "error";
+    readonly "one-var": ["error", "never"];
+    readonly "operator-assignment": "error";
+    readonly "prefer-arrow-callback": "error";
+    readonly "prefer-const": "error";
+    readonly "prefer-destructuring": "error";
+    readonly "prefer-exponentiation-operator": "error";
+    readonly "prefer-named-capture-group": "error";
+    readonly "prefer-numeric-literals": "error";
+    readonly "prefer-object-has-own": "error";
+    readonly "prefer-object-spread": "error";
+    readonly "prefer-regex-literals": "error";
+    readonly "prefer-rest-params": "error";
+    readonly "prefer-spread": "error";
+    readonly "prefer-template": "error";
+    readonly "preserve-caught-error": "error";
+    readonly radix: "error";
+    readonly "require-unicode-regexp": "error";
+    readonly "require-yield": "error";
+    readonly "sort-keys": "error";
+    readonly "sort-vars": "error";
+    readonly "symbol-description": "error";
+    readonly "unicode-bom": "error";
+    readonly "use-isnan": "error";
+    readonly "valid-typeof": "error";
+    readonly "vars-on-top": "error";
+    readonly yoda: "error";
+    readonly "jsdoc/check-access": "error";
+    readonly "jsdoc/check-property-names": "error";
+    readonly "jsdoc/check-tag-names": ["error", {
+        readonly typed: true;
+    }];
+    readonly "jsdoc/empty-tags": "error";
+    readonly "jsdoc/implements-on-classes": "error";
+    readonly "jsdoc/no-defaults": "error";
+    readonly "jsdoc/require-param": "error";
+    readonly "jsdoc/require-param-description": "error";
+    readonly "jsdoc/require-param-name": "error";
+    readonly "jsdoc/require-property": "error";
+    readonly "jsdoc/require-property-description": "error";
+    readonly "jsdoc/require-property-name": "error";
+    readonly "jsdoc/require-returns": "error";
+    readonly "jsdoc/require-returns-description": "error";
+    readonly "jsdoc/require-throws-type": "error";
+    readonly "jsdoc/require-yields": "error";
+    readonly "jsdoc/require-yields-type": "error";
+    readonly "import/namespace": "error";
+    readonly "import/default": "error";
+    readonly "import/export": "error";
+    readonly "import/no-named-as-default": "warn";
+    readonly "import/no-named-as-default-member": "warn";
+    readonly "import/no-duplicates": "warn";
+    readonly "import/no-absolute-path": "error";
+    readonly "import/no-cycle": "error";
+    readonly "import/no-self-import": "error";
+    readonly "import/exports-last": "error";
+    readonly "import/first": "error";
+    readonly "import/group-exports": "error";
+    readonly "import/max-dependencies": "error";
+    readonly "import/newline-after-import": "error";
+    readonly "import/no-unassigned-import": "error";
+    readonly "typescript/consistent-return": "error";
+    readonly "typescript/dot-notation": "error";
+    readonly "typescript/await-thenable": "error";
+    readonly "typescript/ban-ts-comment": ["error", {
+        readonly minimumDescriptionLength: 10;
+    }];
+    readonly "typescript/no-array-delete": "error";
+    readonly "typescript/no-base-to-string": "error";
+    readonly "typescript/no-confusing-void-expression": "error";
+    readonly "typescript/no-deprecated": "error";
+    readonly "typescript/no-duplicate-enum-values": "error";
+    readonly "typescript/no-duplicate-type-constituents": "error";
+    readonly "typescript/no-dynamic-delete": "error";
+    readonly "typescript/no-empty-object-type": "error";
+    readonly "typescript/no-explicit-any": "error";
+    readonly "typescript/no-extra-non-null-assertion": "error";
+    readonly "typescript/no-extraneous-class": "error";
+    readonly "typescript/no-floating-promises": "error";
+    readonly "typescript/no-for-in-array": "error";
+    readonly "typescript/no-implied-eval": "error";
+    readonly "typescript/no-invalid-void-type": "error";
+    readonly "typescript/no-meaningless-void-operator": "error";
+    readonly "typescript/no-misused-new": "error";
+    readonly "typescript/no-misused-promises": "error";
+    readonly "typescript/no-misused-spread": "error";
+    readonly "typescript/no-mixed-enums": "error";
+    readonly "typescript/no-namespace": "error";
+    readonly "typescript/no-non-null-asserted-nullish-coalescing": "error";
+    readonly "typescript/no-non-null-asserted-optional-chain": "error";
+    readonly "typescript/no-non-null-assertion": "error";
+    readonly "typescript/no-redundant-type-constituents": "error";
+    readonly "typescript/no-require-imports": "error";
+    readonly "typescript/no-unnecessary-boolean-literal-compare": "error";
+    readonly "typescript/no-unnecessary-condition": "error";
+    readonly "typescript/no-unnecessary-template-expression": "error";
+    readonly "typescript/no-unnecessary-type-arguments": "error";
+    readonly "typescript/no-unnecessary-type-assertion": "error";
+    readonly "typescript/no-unnecessary-type-constraint": "error";
+    readonly "typescript/no-unnecessary-type-conversion": "error";
+    readonly "typescript/no-unnecessary-type-parameters": "error";
+    readonly "typescript/no-unsafe-argument": "error";
+    readonly "typescript/no-unsafe-assignment": "error";
+    readonly "typescript/no-unsafe-call": "error";
+    readonly "typescript/no-unsafe-declaration-merging": "error";
+    readonly "typescript/no-unsafe-enum-comparison": "error";
+    readonly "typescript/no-unsafe-function-type": "error";
+    readonly "typescript/no-unsafe-member-access": "error";
+    readonly "typescript/no-unsafe-return": "error";
+    readonly "typescript/no-unsafe-unary-minus": "error";
+    readonly "typescript/no-useless-default-assignment": "error";
+    readonly "typescript/no-wrapper-object-types": "error";
+    readonly "typescript/only-throw-error": "error";
+    readonly "typescript/prefer-as-const": "error";
+    readonly "typescript/prefer-literal-enum-member": "error";
+    readonly "typescript/prefer-namespace-keyword": "error";
+    readonly "typescript/prefer-promise-reject-errors": "error";
+    readonly "typescript/prefer-reduce-type-parameter": "error";
+    readonly "typescript/prefer-return-this-type": "error";
+    readonly "typescript/related-getter-setter-pairs": "error";
+    readonly "typescript/require-await": "error";
+    readonly "typescript/restrict-plus-operands": ["error", {
+        readonly allowAny: false;
+        readonly allowBoolean: false;
+        readonly allowNullish: false;
+        readonly allowNumberAndString: false;
+        readonly allowRegExp: false;
+    }];
+    readonly "typescript/restrict-template-expressions": ["error", {
+        readonly allowAny: false;
+        readonly allowBoolean: false;
+        readonly allowNever: false;
+        readonly allowNullish: false;
+        readonly allowNumber: false;
+        readonly allowRegExp: false;
+    }];
+    readonly "typescript/return-await": ["error", "error-handling-correctness-only"];
+    readonly "typescript/triple-slash-reference": "error";
+    readonly "typescript/unbound-method": "error";
+    readonly "typescript/unified-signatures": "error";
+    readonly "typescript/use-unknown-in-catch-callback-variable": "error";
+    readonly "typescript/adjacent-overload-signatures": "error";
+    readonly "typescript/array-type": ["error", {
+        readonly default: "array-simple";
+    }];
+    readonly "typescript/ban-tslint-comment": "error";
+    readonly "typescript/class-literal-property-style": "error";
+    readonly "typescript/consistent-generic-constructors": "error";
+    readonly "typescript/consistent-indexed-object-style": "error";
+    readonly "typescript/consistent-type-assertions": "error";
+    readonly "typescript/consistent-type-definitions": "error";
+    readonly "typescript/no-confusing-non-null-assertion": "error";
+    readonly "typescript/no-inferrable-types": "error";
+    readonly "typescript/non-nullable-type-assertion-style": "error";
+    readonly "typescript/prefer-find": "error";
+    readonly "typescript/prefer-for-of": "error";
+    readonly "typescript/prefer-function-type": "error";
+    readonly "typescript/prefer-includes": "error";
+    readonly "typescript/prefer-nullish-coalescing": "error";
+    readonly "typescript/prefer-optional-chain": "error";
+    readonly "typescript/prefer-regexp-exec": "error";
+    readonly "typescript/prefer-string-starts-ends-with": "error";
+    readonly "typescript/explicit-function-return-type": "error";
+    readonly "typescript/explicit-member-accessibility": "error";
+    readonly "typescript/consistent-type-imports": "error";
+    readonly "typescript/no-import-type-side-effects": "error";
+    readonly "typescript/consistent-type-exports": "error";
+    readonly "typescript/switch-exhaustiveness-check": "error";
+    readonly "import/named": "off";
+    readonly "jsdoc/no-blank-blocks": "off";
+    readonly "jsdoc/require-param-type": "off";
+    readonly "jsdoc/require-property-type": "off";
+    readonly "jsdoc/require-returns-type": "off";
+    readonly "jsdoc/require-throws-description": "off";
+    readonly "jsdoc/require-yields-description": "off";
+    readonly "no-implied-eval": "off";
+    readonly "no-new": "off";
+    readonly "no-plusplus": "off";
+    readonly "no-ternary": "off";
+    readonly "no-throw-literal": "off";
+    readonly "no-unexpected-multiline": "off";
+    readonly "prefer-promise-reject-errors": "off";
+    readonly "require-await": "off";
+    readonly "unicorn/empty-brace-spaces": "off";
+    readonly "unicorn/no-nested-ternary": "off";
+    readonly "unicorn/number-literal-case": "off";
+    readonly "oxc/no-this-in-exported-function": "error";
+    readonly "sort-imports": ["error", {
+        readonly allowSeparatedGroups: false;
+        readonly ignoreCase: false;
+        readonly ignoreDeclarationSort: false;
+        readonly ignoreMemberSort: false;
+        readonly memberSyntaxSortOrder: ["none", "all", "multiple", "single"];
+    }];
+    readonly "typescript/no-this-alias": ["error", {
+        readonly allowedNames: ["that"];
+    }];
+    readonly "unicorn/no-useless-undefined": "error";
+};
+declare const typescriptOverrides: {
+    readonly "constructor-super": "off";
+    readonly "getter-return": "off";
+    readonly "no-class-assign": "off";
+    readonly "no-const-assign": "off";
+    readonly "no-dupe-class-members": "off";
+    readonly "no-dupe-keys": "off";
+    readonly "no-func-assign": "off";
+    readonly "no-import-assign": "off";
+    readonly "no-new-native-nonconstructor": "off";
+    readonly "no-obj-calls": "off";
+    readonly "no-redeclare": "off";
+    readonly "no-setter-return": "off";
+    readonly "no-this-before-super": "off";
+    readonly "no-undef": "off";
+    readonly "no-unreachable": "off";
+    readonly "no-unsafe-negation": "off";
+    readonly "no-with": "off";
+};
+export { baseRules, typescriptOverrides };