@geoql/doctor-rule-core 1.0.0

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

@@ -0,0 +1,53 @@
+# @geoql/doctor-rule-core
+
+Linter-neutral rule cores shared by:
+
+- `@geoql/oxlint-plugin-vue-doctor`
+- `@geoql/oxlint-plugin-nuxt-doctor`
+- the future ESLint plugin (parity item #4)
+
+## What lives here
+
+Pure detection logic for rules that operate on the **ESTree / JavaScript AST**:
+
+- rule metadata (`id`, `category`, `severity`, `recommended`, `meta`)
+- the visitor spec returned by `create(context)`
+- the optional `fix(node) => string | null` transform
+- shared helpers such as `defineRule` and the auto-imported symbol sets
+
+## What does NOT live here
+
+Template-AST rules (e.g. `v-for-has-key`) operate on the `@vue/compiler-sfc`
+template AST, which has a completely different node shape and traversal model.
+They remain in `@geoql/doctor-core` alongside the hybrid engine that runs them.
+
+## Adapter contract
+
+A linter adapter should consume each `CoreRule` and wire it into its own
+linter API. The core shape is intentionally identical to the ESLint / oxlint
+JS-plugin contract:
+
+```ts
+export interface CoreRule {
+  readonly id: string;
+  readonly category: RuleCategory;
+  readonly severity: 'error' | 'warn' | 'info';
+  readonly recommended: boolean;
+  readonly meta?: RuleMeta;
+  readonly create: (context: RuleContext) => Record<string, RuleVisitor>;
+  readonly fix?: (node: AstNode) => string | null;
+}
+```
+
+For oxlint, the adapter is a thin identity wrapper because the shape already
+matches oxlint's `Rule`. For ESLint, the adapter will map the same `create`
+visitor object into ESLint's `context.report()` API.
+
+## Adding a new rule
+
+1. Add the rule file under `src/rules/vue/` or `src/rules/nuxt/`.
+2. Export it from the matching `src/rules/vue/index.ts` or
+   `src/rules/nuxt/index.ts`.
+3. Add the rule to `RULE_REGISTRY` in `@geoql/doctor-core`.
+4. Add the rule id to the matching allowlist in
+   `@geoql/doctor-core/src/oxlint/generate-config.ts`.

package/dist/index.d.ts

@@ -0,0 +1,158 @@
+//#region src/types.d.ts
+type Severity = 'error' | 'warn' | 'info';
+type RuleCategory = 'ai-slop' | 'reactivity' | 'composition' | 'performance' | 'template' | 'template-perf' | 'build-quality' | 'deps' | 'dead-code' | 'sfc' | 'vue-builtin' | 'structure' | 'modules-deps' | 'nitro' | 'seo' | 'cloudflare' | 'server-routes' | 'hydration' | 'data-fetching' | 'security' | 'design';
+interface SourceLocation {
+  start: {
+    line: number;
+    column: number;
+  };
+  end: {
+    line: number;
+    column: number;
+  };
+}
+interface AstNode {
+  type: string;
+  loc?: SourceLocation;
+  [key: string]: unknown;
+}
+interface Fix {
+  range: [number, number];
+  text: string;
+  node?: AstNode;
+}
+interface Fixer {
+  replaceText: (node: AstNode, text: string) => Fix;
+}
+type FixFn = (fixer: Fixer) => Fix;
+interface ReportDescriptor {
+  node: AstNode;
+  message: string;
+  fix?: FixFn;
+}
+interface RuleContext {
+  report: (descriptor: ReportDescriptor) => void;
+  getFilename?: () => string | undefined;
+  settings?: Record<string, unknown>;
+  /** Capability tokens detected for the project (e.g. 'auto-imports:vue'). */
+  capabilities?: Set<string>;
+}
+type RuleVisitor = (node: AstNode) => void;
+interface RuleMeta {
+  name?: string;
+  fixable?: 'code' | 'whitespace';
+}
+interface Rule {
+  meta?: RuleMeta;
+  create: (context: RuleContext) => Record<string, RuleVisitor>;
+  fix?: (node: AstNode) => string | null;
+}
+interface Plugin {
+  meta: {
+    name: string;
+  };
+  rules: Record<string, Rule>;
+}
+interface CoreRule {
+  readonly id: string;
+  readonly category: RuleCategory;
+  readonly severity: Severity;
+  readonly recommended: boolean;
+  readonly meta?: RuleMeta;
+  readonly create: (context: RuleContext) => Record<string, RuleVisitor>;
+  readonly fix?: (node: AstNode) => string | null;
+}
+//#endregion
+//#region src/define-rule.d.ts
+declare function defineRule(rule: Rule): Rule;
+//#endregion
+//#region src/shared/auto-imported-symbols.d.ts
+declare const VUE_AUTO_IMPORTED: ReadonlySet<string>;
+declare const NUXT_AUTO_IMPORTED: ReadonlySet<string>;
+//#endregion
+//#region src/rules/nuxt/index.d.ts
+declare const NUXT_RULES: readonly CoreRule[];
+//#endregion
+//#region src/rules/vue/index.d.ts
+declare const VUE_RULES: readonly CoreRule[];
+//#endregion
+//#region src/rules/nuxt/hydration/clientOnly-for-browser-apis.d.ts
+declare const clientOnlyForBrowserApis: Rule;
+//#endregion
+//#region src/rules/nuxt/hydration/no-document-in-setup.d.ts
+declare const noDocumentInSetup: Rule;
+//#endregion
+//#region src/rules/nuxt/server-routes/createError-on-failure.d.ts
+declare const createErrorOnFailure: Rule;
+//#endregion
+//#region src/rules/nuxt/server-routes/defineEventHandler-typed.d.ts
+declare const defineEventHandlerTyped: Rule;
+//#endregion
+//#region src/rules/nuxt/server-routes/validate-body-with-h3-v2.d.ts
+declare const validateBodyWithH3V2: Rule;
+//#endregion
+//#region src/rules/nuxt/data-fetching/useAsyncData-key-required-in-loop.d.ts
+declare const useAsyncDataKeyRequiredInLoop: Rule;
+//#endregion
+//#region src/rules/nuxt/ai-slop/no-explicit-imports-of-auto-imported.d.ts
+declare const noExplicitImportsOfAutoImported: Rule;
+//#endregion
+//#region src/rules/nuxt/ai-slop/no-fetch-in-setup.d.ts
+declare const noFetchInSetup: Rule;
+//#endregion
+//#region src/rules/nuxt/ai-slop/no-process-client-server.d.ts
+declare const noProcessClientServer: Rule;
+//#endregion
+//#region src/rules/nuxt/ai-slop/no-useState-for-server-data.d.ts
+declare const noUseStateForServerData: Rule;
+//#endregion
+//#region src/rules/vue/composition/defineProps-typed.d.ts
+declare const definePropsTyped: Rule;
+//#endregion
+//#region src/rules/vue/composition/prefer-script-setup-for-new-files.d.ts
+declare const preferScriptSetupForNewFiles: Rule;
+//#endregion
+//#region src/rules/vue/performance/prefer-defineAsyncComponent-on-route.d.ts
+declare const preferDefineAsyncComponentOnRoute: Rule;
+//#endregion
+//#region src/rules/vue/reactivity/prefer-readonly-for-injected.d.ts
+declare const preferReadonlyForInjected: Rule;
+//#endregion
+//#region src/rules/vue/reactivity/prefer-shallowRef-for-large-data.d.ts
+declare const preferShallowRefForLargeData: Rule;
+//#endregion
+//#region src/rules/vue/reactivity/watch-without-cleanup.d.ts
+declare const watchWithoutCleanup: Rule;
+//#endregion
+//#region src/rules/vue/ai-slop/no-destructure-props-without-toRefs.d.ts
+declare const noDestructurePropsWithoutToRefs: Rule;
+//#endregion
+//#region src/rules/vue/ai-slop/no-destructure-reactive-without-toRefs.d.ts
+declare const noDestructureReactiveWithoutToRefs: Rule;
+//#endregion
+//#region src/rules/vue/ai-slop/no-em-dash-in-string.d.ts
+declare const noEmDashInString: Rule;
+//#endregion
+//#region src/rules/vue/ai-slop/no-imports-from-vue-when-auto-imported.d.ts
+declare const noImportsFromVueWhenAutoImported: Rule;
+//#endregion
+//#region src/rules/vue/ai-slop/no-non-null-assertion-on-ref-value.d.ts
+declare const noNonNullAssertionOnRefValue: Rule;
+//#endregion
+//#region src/rules/vue/security/no-auth-token-in-web-storage.d.ts
+declare const noAuthTokenInWebStorage: Rule;
+//#endregion
+//#region src/rules/vue/security/no-eval-like.d.ts
+declare const noEvalLike: Rule;
+//#endregion
+//#region src/rules/vue/security/no-inner-html.d.ts
+declare const noInnerHtml: Rule;
+//#endregion
+//#region src/rules/vue/security/no-secrets-in-source.d.ts
+declare const noSecretsInSource: Rule;
+//#endregion
+//#region src/rules/nuxt/security/no-user-input-in-fetch-url.d.ts
+declare const noUserInputInFetchUrl: Rule;
+//#endregion
+export { type AstNode, type CoreRule, type Fix, type FixFn, type Fixer, NUXT_AUTO_IMPORTED, NUXT_RULES, type Plugin, type ReportDescriptor, type Rule, type RuleCategory, type RuleContext, type RuleMeta, type RuleVisitor, type Severity, type SourceLocation, VUE_AUTO_IMPORTED, VUE_RULES, clientOnlyForBrowserApis, createErrorOnFailure, defineEventHandlerTyped, definePropsTyped, defineRule, noAuthTokenInWebStorage, noDestructurePropsWithoutToRefs, noDestructureReactiveWithoutToRefs, noDocumentInSetup, noEmDashInString, noEvalLike, noExplicitImportsOfAutoImported, noFetchInSetup, noImportsFromVueWhenAutoImported, noInnerHtml, noNonNullAssertionOnRefValue, noProcessClientServer, noSecretsInSource, noUseStateForServerData, noUserInputInFetchUrl, preferDefineAsyncComponentOnRoute, preferReadonlyForInjected, preferScriptSetupForNewFiles, preferShallowRefForLargeData, useAsyncDataKeyRequiredInLoop, validateBodyWithH3V2, watchWithoutCleanup };
+//# sourceMappingURL=index.d.ts.map