@kk-forge/oxlint-config 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KK Forge
+
+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

@@ -1,3 +1,30 @@
-# Temporary Holding Version
+# @kk-forge/oxlint-config
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The oxlint rules KK Forge's TypeScript packages lint with.
+
+- `base.json` turns on oxlint's `correctness` category as errors. It adds the bug-catching rules the category lacks: `any`, `@ts-ignore`, non-null assertions, a `switch` that misses a case, a misused promise, a `let` that stays the same, `var` and import cycles. A few more come from the `suspicious` category, such as a loop whose condition never changes and an enum compared with a raw value. It also turns on type-aware linting and fails on a warning, so a package runs a bare `oxlint`.
+- `solid.json`: the recommended rules of eslint-plugin-solid, for a Solid package. oxlint runs a JS plugin's rule only when the config lists it, so the file lists them. It turns off `no-unassigned-vars`, which cannot see Solid assign a `let` through a JSX `ref`.
+
+## Use
+
+```bash
+npm install -D @kk-forge/oxlint-config oxlint oxlint-tsgolint
+```
+
+A Solid package also installs `eslint-plugin-solid`. `.oxlintrc.json` takes the files by path, because oxlint resolves `extends` from the config's own folder:
+
+```json
+{
+  "extends": ["./node_modules/@kk-forge/oxlint-config/base.json", "./node_modules/@kk-forge/oxlint-config/solid.json"]
+}
+```
+
+A package's own rules and overrides go below `extends` and win over it. Point the path at the `node_modules` that holds the package, such as `../node_modules/…` in an npm workspace.
+
+## Development
+
+- `mise run setup` installs the packages, and `mise run check` lints `test/fixtures` through both files and expects each rule the fixture breaks.
+
+## Release
+
+Raise `version` in package.json and merge to main. The Release workflow runs `release-npm.yml@v4` of kk-forge-engineering/gh-actions. It runs `check` and packs the package with `mise run pack`. Once the `production` environment's reviewer approves, it publishes to npm through Trusted Publishing and tags `v<version>` with a GitHub Release.

package/base.json

@@ -0,0 +1,29 @@
+{
+  "plugins": ["typescript", "unicorn", "oxc", "import"],
+  "categories": {
+    "correctness": "error"
+  },
+  "options": {
+    "typeAware": true,
+    "denyWarnings": true
+  },
+  "rules": {
+    "typescript/no-explicit-any": "error",
+    "typescript/ban-ts-comment": "error",
+    "typescript/no-non-null-assertion": "error",
+    "typescript/switch-exhaustiveness-check": "error",
+    "typescript/no-misused-promises": "error",
+    "prefer-const": ["error", { "ignoreReadBeforeAssign": true }],
+    "no-var": "error",
+    "import/no-cycle": "error",
+    "no-unmodified-loop-condition": "error",
+    "no-unexpected-multiline": "error",
+    "no-extend-native": "error",
+    "preserve-caught-error": "error",
+    "oxc/misrefactored-assign-op": "error",
+    "unicorn/require-post-message-target-origin": "error",
+    "unicorn/no-accessor-recursion": "error",
+    "unicorn/no-array-fill-with-reference-type": "error",
+    "typescript/no-unsafe-enum-comparison": "error"
+  }
+}

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@kk-forge/oxlint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "The oxlint rules KK Forge's TypeScript packages lint with",
+  "license": "MIT",
+  "author": "KK Forge",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kk-forge-engineering/oxlint-config.git"
+  },
+  "files": [
+    "base.json",
+    "solid.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "peerDependencies": {
+    "eslint-plugin-solid": "^0.18.0 || ^0.19.0",
+    "oxlint": "^1.88.0",
+    "oxlint-tsgolint": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "eslint-plugin-solid": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "eslint-plugin-solid": "^0.19.0",
+    "oxlint": "^1.93.0",
+    "oxlint-tsgolint": "^7.0.2006"
+  }
+}

package/solid.json

@@ -0,0 +1,22 @@
+{
+  "jsPlugins": ["eslint-plugin-solid"],
+  "rules": {
+    "solid/jsx-no-duplicate-props": "error",
+    "solid/jsx-no-undef": "error",
+    "solid/jsx-uses-vars": "error",
+    "solid/no-unknown-namespaces": "error",
+    "solid/no-innerhtml": "error",
+    "solid/jsx-no-script-url": "error",
+    "solid/components-return-once": "error",
+    "solid/no-destructure": "error",
+    "solid/prefer-for": "error",
+    "solid/reactivity": "error",
+    "solid/event-handlers": "error",
+    "solid/imports": "error",
+    "solid/style-prop": "error",
+    "solid/no-react-deps": "error",
+    "solid/no-react-specific-props": "error",
+    "solid/self-closing-comp": "error",
+    "no-unassigned-vars": "off"
+  }
+}