@geoql/oxlint-plugin-nuxt-doctor 0.0.0-bootstrap → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vinayak Kulkarni
+
+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,28 +1,37 @@
 # `@geoql/oxlint-plugin-nuxt-doctor`
 
-> oxlint JS plugin for Nuxt 4 anti-patterns and AI-slop detection.
+> oxlint JS plugin holding the Nuxt 4 script-level rules that [`@geoql/doctor-core`](../doctor-core) runs.
 
-Pairs with oxlint's built-in `vue` plugin via the `jsPlugins` config field. See [`docs/ARCHITECTURE.md`](../../docs/ARCHITECTURE.md) for how it fits with `@geoql/doctor-core`.
+This package is a rule pack, not a tool. It's the Nuxt half of the script pass: oxlint JS-plugin rules that fire against the `<script>` / `<script setup>` ESTree oxlint extracts from `.vue` files and server handlers. `doctor-core` generates the `.oxlintrc.json` that loads this plugin alongside `@geoql/oxlint-plugin-vue-doctor` and wires it in automatically, so **you don't install or configure it directly**. Run [`@geoql/nuxt-doctor`](../nuxt-doctor) and these rules come along for free.
 
-## Usage (standalone oxlint config)
+## What's in here
 
-```jsonc
-// .oxlintrc.json
-{
-  "plugins": ["vue"],
-  "jsPlugins": ["@geoql/oxlint-plugin-nuxt-doctor"],
-  "rules": {
-    "nuxt-doctor/no-em-dash-in-string": "error",
-  },
-}
+Script-level Nuxt rules across four categories. Other Nuxt checks (`structure`, `nitro`, `seo`, `cloudflare`, `modules-deps`, plus cross-file `data-fetching`) run inside `doctor-core` because they need project-level or multi-file context rather than a single script AST.
+
+| Category        | Rules                                                                                                                 |
+| --------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `ai-slop`       | `useState` for server data, fetch in setup, `process.client`/`process.server`, explicit imports of auto-imported APIs |
+| `hydration`     | `clientOnly` for browser APIs, no `document` in setup                                                                 |
+| `server-routes` | typed `defineEventHandler`, `createError` on failure, validate body with h3 v2                                        |
+| `data-fetching` | required `useAsyncData` key inside loops                                                                              |
+
+`nuxt-doctor` surfaces these Nuxt rules **on top of** the full Vue rule set, so a Nuxt audit checks both. To see every rule with its id, severity, and preset membership, run `nuxt-doctor list-rules` (or filter, e.g. `nuxt-doctor list-rules --category hydration`).
+
+## Install
+
+```sh
+npm i @geoql/oxlint-plugin-nuxt-doctor
 ```
 
-## Rules (alpha)
+Published on [npm](https://www.npmjs.com/package/@geoql/oxlint-plugin-nuxt-doctor) and [JSR](https://jsr.io/@geoql/oxlint-plugin-nuxt-doctor) at `v0.1.0` with provenance. ESM-only, TypeScript. `oxlint` is a peer dependency. Most people never add this dependency themselves; `doctor-core` resolves it for you.
+
+## Scope
+
+Nuxt 4 only (the `app/` directory layout with `compatibilityVersion: 4`). Severity levels are `error | warn | info`.
 
-| Rule | Category | Severity |
-| ---- | -------- | -------- |
+## Architecture
 
-Rules land per the [issue tracker](https://github.com/geoql/doctor/issues).
+See [`docs/ARCHITECTURE.md`](../../docs/ARCHITECTURE.md) for how the JS plugin co-loads with oxlint's native `vue` plugin and why script, template, and cross-file rules live in different passes.
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geoql/oxlint-plugin-nuxt-doctor",
-  "version": "0.0.0-bootstrap",
+  "version": "0.1.1",
   "private": false,
   "description": "oxlint JS plugin for Nuxt 4 anti-patterns and AI-slop detection. Pairs with oxlint's built-in vue plugin via jsPlugins. TypeScript, ESM.",
   "keywords": [
@@ -41,14 +41,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "lint": "vp lint src",
-    "lint:fix": "vp lint src --fix",
-    "format": "vp fmt",
-    "format:check": "vp fmt --check",
-    "build": "vp pack",
-    "test": "vitest run"
-  },
   "devDependencies": {
     "@types/node": "^25.9.1",
     "oxc-parser": "0.133.0",
@@ -57,5 +49,13 @@
   },
   "peerDependencies": {
     "oxlint": "^1.66.0"
+  },
+  "scripts": {
+    "lint": "vp lint src",
+    "lint:fix": "vp lint src --fix",
+    "format": "vp fmt",
+    "format:check": "vp fmt --check",
+    "build": "vp pack",
+    "test": "vitest run"
   }
-}
+}