@zgeoff/oxlint-config 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Geoff Whatley
+
+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,41 @@
+# @zgeoff/oxlint-config
+
+Shareable [oxlint](https://oxc.rs/docs/guide/usage/linter.html) config: every category at `error`,
+restriction-rule cherry-picks, comment-style enforcement via `@stylistic`, and a bundled JS plugin
+(`zgeoff/*` rules) banning AST shapes no native oxlint rule can express — top-level arrows, nested
+function declarations, bare named exports, destructured and inline-typed parameters, ternary and
+await arguments.
+
+## Usage
+
+```sh
+bun add -d @zgeoff/oxlint-config oxlint
+```
+
+Extend it from `.oxlintrc.json` — `extends` resolves file paths only, so point at the file inside
+`node_modules`:
+
+```jsonc
+{
+  "extends": ["./node_modules/@zgeoff/oxlint-config/oxlintrc.json"],
+  // ignorePatterns don't propagate through extends — each consumer declares
+  // its own (oxlint also honors .gitignore)
+  "ignorePatterns": ["**/node_modules/**", "**/dist/**", "**/*.json"],
+}
+```
+
+Or import the config object in `oxlint.config.ts`:
+
+```ts
+import config from '@zgeoff/oxlint-config';
+```
+
+The plugin is addressable on its own at `@zgeoff/oxlint-config/plugin` for configs that want the
+`zgeoff/*` rules without the rest.
+
+## Notes
+
+- The config enables the `typescript`, `unicorn`, `oxc`, `import`, and `promise` plugins and loads
+  `@stylistic/eslint-plugin` (a dependency of this package) through `jsPlugins`.
+- Type-aware rules activate under `oxlint --type-aware` (requires `oxlint-tsgolint`); the config
+  works without it.

package/index.js

@@ -0,0 +1 @@
+export { default } from './oxlintrc.json' with { type: 'json' };

package/oxlintrc.json

@@ -0,0 +1,154 @@
+{
+  "$schema": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json",
+  "plugins": ["typescript", "unicorn", "oxc", "import", "promise"],
+  "jsPlugins": ["@zgeoff/oxlint-config/plugin", "@stylistic/eslint-plugin"],
+  "categories": {
+    "correctness": "error",
+    "suspicious": "error",
+    "perf": "error",
+    "pedantic": "error",
+    "style": "error"
+  },
+  "env": {
+    "node": true,
+    "es2024": true
+  },
+  "rules": {
+    // custom AST rules from plugin.js
+    "zgeoff/no-top-level-arrow": "error",
+    "zgeoff/no-nested-function-declaration": "error",
+    "zgeoff/no-bare-named-exports": "error",
+    "zgeoff/no-inline-param-object-types": "error",
+    "zgeoff/no-destructured-params": "error",
+    "zgeoff/no-pick-destructuring": "error",
+    "zgeoff/no-ternary-args": "error",
+    "zgeoff/no-await-args": "error",
+
+    // enforced comment style — line comments unless JSDoc or exclamation
+    "@stylistic/multiline-comment-style": [
+      "error",
+      "separate-lines",
+      { "checkJSDoc": false, "checkExclamation": false }
+    ],
+
+    // own-line comments get a blank line above so they don't crowd the
+    // previous statement; comments opening a block/object/class/etc are exempt
+    "@stylistic/lines-around-comment": [
+      "error",
+      {
+        "beforeLineComment": true,
+        "beforeBlockComment": true,
+        "allowBlockStart": true,
+        "allowObjectStart": true,
+        "allowArrayStart": true,
+        "allowClassStart": true,
+        "allowEnumStart": true,
+        "allowInterfaceStart": true,
+        "allowModuleStart": true,
+        "allowTypeStart": true
+      }
+    ],
+
+    // restriction-category cherry-picks
+    "typescript/no-explicit-any": "error",
+    "typescript/no-non-null-assertion": "error",
+    "import/no-cycle": "error",
+
+    "no-shadow": "error",
+
+    // separate type-only imports from value imports
+    "typescript/consistent-type-imports": [
+      "error",
+      { "prefer": "type-imports", "fixStyle": "separate-type-imports" }
+    ],
+    "no-duplicate-imports": ["error", { "allowSeparateTypeImports": true }],
+    // oxfmt's sortImports owns import declaration order; lint only member order
+    "sort-imports": ["error", { "ignoreDeclarationSort": true }],
+
+    // allows destructuring for omitting properties
+    "no-unused-vars": ["error", { "ignoreRestSiblings": true }],
+
+    // arrays: destructure instead of indexing; objects: house style is direct
+    // member access, so never required (the omit-via-rest exception lives in
+    // zgeoff/no-pick-destructuring)
+    "prefer-destructuring": [
+      "error",
+      {
+        "VariableDeclarator": { "array": true, "object": false },
+        "AssignmentExpression": { "array": false, "object": false }
+      }
+    ],
+
+    // consistent function syntax — declarations top level, arrows for inside
+    // blocks and callbacks
+    "func-style": ["error", "declaration", { "allowArrowFunctions": true }],
+    "no-inner-declarations": ["error", "functions"],
+    "prefer-arrow-callback": ["error", { "allowNamedFunctions": false, "allowUnboundThis": false }],
+
+    // stylistic
+    "curly": ["error", "all"],
+    "unicorn/prefer-ternary": ["error", "only-single-line"],
+    "unicorn/prefer-node-protocol": "error",
+    "unicorn/no-array-sort": "error",
+    "unicorn/no-nested-ternary": "off",
+    "unicorn/no-useless-undefined": ["error", { "checkArguments": false }],
+    "unicorn/no-null": "off",
+    "unicorn/number-literal-case": "off",
+    "unicorn/filename-case": "off",
+
+    // category-enabled rules that contradict this config's style: inline named
+    // export declarations are the convention (group-exports demands the exact
+    // form no-bare-named-exports bans), keys group by meaning not alphabet,
+    // comments stay lowercase, short identifiers and literal numbers are fine
+    "import/prefer-default-export": "off",
+    "import/no-named-export": "off",
+    "import/exports-last": "off",
+    "import/group-exports": "off",
+    "sort-keys": "off",
+    "capitalized-comments": "off",
+    "id-length": "off",
+    "no-magic-numbers": "off",
+    // prefer-ternary (only-single-line, above) wants ternaries where they fit
+    // on one line; no-ternary would ban the same code
+    "no-ternary": "off",
+    // this config targets node/bun tooling — node builtins are the platform
+    "import/no-nodejs-modules": "off",
+
+    // preload-style modules (matcher registration, type augmentation) are
+    // side-effect imports by design
+    "import/no-unassigned-import": [
+      "error",
+      { "allow": ["jest-extended", "**/augment-bun-test.ts"] }
+    ],
+
+    // disable import rules that duplicate work TypeScript's compiler already
+    // does
+    "import/namespace": "off",
+    "import/named": "off",
+    "import/default": "off",
+    "import/no-named-as-default-member": "off"
+  },
+  "overrides": [
+    {
+      "files": ["**/*.test.ts"],
+      // one co-located suite per module with inline test data: file length
+      // scales with coverage, not complexity
+      "rules": {
+        "max-lines": "off"
+      }
+    },
+    {
+      "files": ["**/*.js", "**/*.cjs", "**/*.mjs"],
+      // untyped JS is `any` end to end, so the unsafe-* rules flag every
+      // expression
+      "rules": {
+        "typescript/no-unsafe-argument": "off",
+        "typescript/no-unsafe-assignment": "off",
+        "typescript/no-unsafe-call": "off",
+        "typescript/no-unsafe-member-access": "off",
+        "typescript/no-unsafe-return": "off",
+        "typescript/no-unsafe-type-assertion": "off"
+      }
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@zgeoff/oxlint-config",
+  "version": "0.0.1",
+  "description": "Shareable oxlint config: strict categories, house-style rules, and a custom JS plugin",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zgeoff/tools.git",
+    "directory": "packages/oxlint-config"
+  },
+  "files": [
+    "oxlintrc.json",
+    "plugin.js",
+    "index.js"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./index.js",
+    "./oxlintrc.json": "./oxlintrc.json",
+    "./plugin": "./plugin.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@stylistic/eslint-plugin": "5.10.0"
+  },
+  "peerDependencies": {
+    "oxlint": ">=1.71.0"
+  }
+}

package/plugin.js

@@ -0,0 +1,81 @@
+// Custom lint rules, loaded through oxlint's jsPlugins (ESLint v9 rule API).
+// Each rule bans an AST shape that no native oxlint rule can express, using
+// esquery selectors.
+
+function banSelectors(type, message, selectors) {
+  return {
+    meta: { type, messages: { banned: message }, schema: [] },
+    create(context) {
+      const entries = selectors.map((selector) => [
+        selector,
+        (node) => context.report({ node, messageId: 'banned' }),
+      ]);
+
+      return Object.fromEntries(entries);
+    },
+  };
+}
+
+const plugin = {
+  meta: { name: 'zgeoff' },
+  rules: {
+    'no-top-level-arrow': banSelectors(
+      'problem',
+      'Declare top-level functions with the `function` keyword instead of assigning an arrow function.',
+      [
+        "Program > VariableDeclaration > VariableDeclarator[init.type='ArrowFunctionExpression']",
+        "Program > ExportNamedDeclaration > VariableDeclaration > VariableDeclarator[init.type='ArrowFunctionExpression']",
+        'Program > ExportDefaultDeclaration > ArrowFunctionExpression',
+        "Program > ExpressionStatement > AssignmentExpression[right.type='ArrowFunctionExpression']",
+      ],
+    ),
+    'no-nested-function-declaration': banSelectors(
+      'problem',
+      'Use an arrow function here; reserve the `function` keyword for top-level declarations.',
+      [
+        'FunctionDeclaration:not(Program > FunctionDeclaration):not(Program > ExportNamedDeclaration > FunctionDeclaration):not(Program > ExportDefaultDeclaration > FunctionDeclaration)',
+      ],
+    ),
+    'no-bare-named-exports': banSelectors(
+      'problem',
+      'Export declarations inline instead of listing names in `export { ... }`.',
+      ['ExportNamedDeclaration[specifiers.length>0][declaration=null][source=null]'],
+    ),
+    'no-inline-param-object-types': banSelectors(
+      'problem',
+      'Give this parameter a named interface or type alias instead of an inline object-literal type.',
+      [
+        ':matches(FunctionDeclaration, FunctionExpression, ArrowFunctionExpression, TSDeclareFunction, TSFunctionType) > Identifier.params > TSTypeAnnotation > TSTypeLiteral',
+        'TSMethodSignature > Identifier.params > TSTypeAnnotation > TSTypeLiteral',
+      ],
+    ),
+    'no-destructured-params': banSelectors(
+      'suggestion',
+      'Accept the parameter whole instead of destructuring it in the signature.',
+      [
+        ':matches(FunctionDeclaration, FunctionExpression, ArrowFunctionExpression) > ObjectPattern.params',
+        ':matches(FunctionDeclaration, FunctionExpression, ArrowFunctionExpression) > AssignmentPattern.params > ObjectPattern',
+      ],
+    ),
+    'no-pick-destructuring': banSelectors(
+      'suggestion',
+      'Use direct member access; destructure an object only with a rest element to omit properties.',
+      ['VariableDeclarator > ObjectPattern:not(:has(> RestElement))'],
+    ),
+    'no-ternary-args': banSelectors(
+      'suggestion',
+      'Extract this ternary to a named const instead of passing it as an argument.',
+      [
+        'CallExpression > ConditionalExpression.arguments',
+        'NewExpression > ConditionalExpression.arguments',
+      ],
+    ),
+    'no-await-args': banSelectors(
+      'suggestion',
+      'Await into a named const instead of awaiting inside an argument list.',
+      ['CallExpression > AwaitExpression.arguments', 'NewExpression > AwaitExpression.arguments'],
+    ),
+  },
+};
+
+export default plugin;