@nustackjs/lint 0.0.1 → 0.2.0

package/README.md

@@ -68,6 +68,29 @@ eslint .                            # quick checks (fast)
 NUSTACK_LINT_DEPTH=full eslint .    # + type-aware checks (CI)
 ```
 
+## What gets enabled
+
+NuStack is an umbrella preset: it starts from
+[`@antfu/eslint-config`](https://github.com/antfu/eslint-config), lets Nuxt generate the
+project-aware `@nuxt/eslint` layer, then adds NuStack's own Nuxt ecosystem rules. The
+exact flat config is still inspectable with the config inspector command below.
+
+| Source | Enabled when | Plugins / rule namespaces | Enabled rules / presets |
+| --- | --- | --- | --- |
+| [`@antfu/eslint-config`](https://github.com/antfu/eslint-config) | Always, unless `base: false` | Core ESLint, TypeScript, Vue, import, node, unicorn, regexp, jsdoc, perfectionist, test/Vitest, pnpm, JSON/YAML/TOML/Markdown and other Antfu-detected slices | NuStack passes `stylistic: true`, `vue: true`, and keeps Antfu's normal defaults. Vitest rules are enabled as `test/*` in Antfu's renamed namespace. |
+| `@nuxt/eslint` / `@nuxt/eslint-config` | Nuxt module setup | `nuxt/*`, Nuxt globals, Nuxt file-aware Vue handling | Official Nuxt rules such as `nuxt/prefer-import-meta`, `nuxt/no-page-meta-runtime-values`, and `nuxt/no-nuxt-config-test-key`; config key sorting follows Nuxt's own feature options. |
+| `@nustack/nuxt` | Nuxt projects; `recommended` and above except the security floor | `@nustack/nuxt/*` | `@nustack/nuxt/no-secret-in-public-runtimeconfig` (`error`), `@nustack/nuxt/modules-order` (`error`), `@nustack/nuxt/no-deprecated-modules` (`error`), `@nustack/nuxt/no-explicit-auto-import` (`error`), `@nustack/nuxt/no-process-env` (`warn`) |
+| NuStack Vue layer | Vue SFCs | `vue/*` | `vue/block-lang` (`error`); in `recommended` and above also `vue/define-emits-declaration`, `vue/define-props-destructuring`, `vue/html-comment-content-newline`, `vue/html-comment-indent`, `vue/no-duplicate-class-names`, `vue/no-empty-component-block`, `vue/no-import-compiler-macros` |
+| `@nustack/vueuse` | App/client code; `recommended` and above | `@nustack/vueuse/*` | `@nustack/vueuse/no-nuxt-auto-import-collision`, `@nustack/vueuse/no-namespace-import`, `@nustack/vueuse/prefer-use-observers`, `@nustack/vueuse/prefer-use-storage`, `@nustack/vueuse/prefer-use-timers`, `@nustack/vueuse/prefer-useclipboard`, `@nustack/vueuse/prefer-useevent-listener`, `@nustack/vueuse/prefer-usewindow-size` |
+| `@nustack/vite` | App/client code; `recommended` and above | `@nustack/vite/*` | `@nustack/vite/no-client-secret-pattern` (`error`), `@nustack/vite/no-public-src-import` (`warn`) |
+| `eslint-plugin-better-tailwindcss` | Tailwind entry point detected, or `tailwind: true` | `better-tailwindcss/*` | `better-tailwindcss/enforce-consistent-class-order` (`warn`), `better-tailwindcss/no-unregistered-classes` (`warn`), `better-tailwindcss/no-conflicting-classes` (`error`), `better-tailwindcss/no-duplicate-classes` (`error`); `pedantic` also enables `better-tailwindcss/enforce-consistent-line-wrapping` |
+| `@nustack/nuxt-ui` | `@nuxt/ui` detected, or `nuxtUi: true` | `@nustack/nuxt-ui/*` | `@nustack/nuxt-ui/prefer-u-button`, `@nustack/nuxt-ui/prefer-u-form-controls` |
+| NuStack type-aware layer | `NUSTACK_LINT_DEPTH=full` | Antfu's renamed `ts/*` namespace | Enables TypeScript project service and `ts/no-deprecated` (`warn`) |
+
+The public factory mirrors Antfu's override model: pass `base` to tune the Antfu layer,
+pass per-concern options like `nuxt`, `vueUse`, or `tailwind` to tune NuStack concerns,
+and use top-level `rules` for final global overrides.
+
 See [Configuration](./docs/configuration.md), [Rules](./docs/rules.md) and
 [Migration](./docs/migration.md).
 

package/dist/index.d.mts

@@ -16,6 +16,8 @@ interface ConcernOptions {
     /** @deprecated Use `rules` instead. */
     overrides?: Rules;
 }
+/** A per-concern toggle: `true`/`undefined` = default, `false` = off, object = tune. */
+type ConcernToggle<T> = boolean | T;
 
 /** Options accepted by `@antfu/eslint-config`'s factory. */
 type AntfuOptions = NonNullable<Parameters<typeof antfu>[0]>;
@@ -23,8 +25,21 @@ type AntfuOptions = NonNullable<Parameters<typeof antfu>[0]>;
 interface NuxtConcernOptions extends ConcernOptions {
 }
 
+/** Nuxt UI component-preference rules. */
 interface NuxtUiConcernOptions extends ConcernOptions {
 }
+/**
+ * Per-module toggles for the Nuxt ecosystem concern. Each third-party Nuxt module
+ * gets its own toggle here — `true`/object enables (and tunes) it, `false` turns it
+ * off, and the default auto-gates it on detection. New ecosystem modules (Pinia,
+ * Content, …) are added as sibling toggles rather than as new `configs/` files.
+ */
+interface NuxtEcosystemOptions {
+    /** Nuxt UI component preferences. Auto-gated on `@nuxt/ui` detection. */
+    nuxtUi?: ConcernToggle<NuxtUiConcernOptions>;
+}
+/** `false` disables the whole ecosystem; an object tunes each module in depth. */
+type NuxtEcosystemToggle = ConcernToggle<NuxtEcosystemOptions>;
 
 interface TailwindConcernOptions extends ConcernOptions {
     /** Override the auto-detected Tailwind entry point (`@import "tailwindcss"`). */
@@ -49,8 +64,6 @@ interface VueUseConcernOptions extends ConcernOptions {
 type Awaitable<T> = T | Promise<T>;
 type NustackFlatConfig = Linter.Config | Linter.Config[] | FlatConfigComposer;
 type NustackUserConfig = Awaitable<NustackFlatConfig>;
-/** A per-concern toggle: `true`/`undefined` = default, `false` = off, object = tune. */
-type ConcernToggle<T> = boolean | T;
 /**
  * Options for the public nustack ESLint factory. Mirrors `@antfu/eslint-config`'s
  * shape: one options object, then optional flat config objects appended last.
@@ -69,8 +82,12 @@ interface NustackLintOptions {
     vueUse?: ConcernToggle<VueUseConcernOptions>;
     /** Vite build/runtime conventions. */
     vite?: ConcernToggle<ViteConcernOptions>;
-    /** Nuxt UI component preferences. Auto-gated on `@nuxt/ui` detection. */
-    nuxtUi?: ConcernToggle<NuxtUiConcernOptions>;
+    /**
+     * Nuxt-module ecosystem rules (Nuxt UI today; Pinia/Content later). `false`
+     * disables the whole ecosystem; an object tunes each module in depth, e.g.
+     * `{ nuxtUi: false }`. Each module auto-gates on its own detection.
+     */
+    nuxtEcosystem?: NuxtEcosystemToggle;
     /** Tailwind class sorting/correctness. Auto-gated on a detected entry point. */
     tailwind?: ConcernToggle<TailwindConcernOptions>;
     /** Global rule changes, merged after every concern. */

package/dist/index.mjs

@@ -1,13 +1,13 @@
 import { defu } from 'defu';
 import { composer } from 'eslint-flat-config-utils';
 import antfu from '@antfu/eslint-config';
-import nuxtPlugin from '@nustackjs/lint-plugin-nuxt';
-import nuxtEcosystemPlugin from '@nustackjs/lint-plugin-nuxt-ecosystem';
+import { nuxtConfigs } from '@nustackjs/lint-plugin-nuxt';
+import { nuxtUiConfigs } from '@nustackjs/lint-plugin-nuxt-ecosystem';
 import betterTailwind from 'eslint-plugin-better-tailwindcss';
 import { getDefaultCallees, getDefaultAttributes } from 'eslint-plugin-better-tailwindcss/api/defaults';
 import { MatcherType } from 'eslint-plugin-better-tailwindcss/api/types';
-import vitePlugin from '@nustackjs/lint-plugin-vite';
-import vueUsePlugin from '@nustackjs/lint-plugin-vueuse';
+import { viteConfigs } from '@nustackjs/lint-plugin-vite';
+import { vueUseConfigs } from '@nustackjs/lint-plugin-vueuse';
 
 const ANTFU_DEFAULTS = {
   stylistic: true,
@@ -15,8 +15,10 @@ const ANTFU_DEFAULTS = {
   rules: {
     // Nuxt pages/layouts legitimately have multiple root nodes.
     "vue/no-multiple-template-root": "off",
-    // `process` is a Nuxt/Nitro global; @nustack/nuxt/no-process-env handles app code.
-    "node/prefer-global/process": "off",
+    // `process` is always available as a Nuxt/Nitro global, so prefer it over
+    // importing `node:process` (antfu's default is the opposite, `'never'`). App
+    // code is separately steered off `process.env` by @nustack/nuxt/no-process-env.
+    "node/prefer-global/process": ["error", "always"],
     "style/brace-style": ["warn", "1tbs"]
   }
 };
@@ -49,83 +51,31 @@ function resolveConcernRules(options) {
     ...options.rules
   };
 }
+function isEnabled(toggle, gate) {
+  if (toggle === false)
+    return false;
+  if (toggle === true || typeof toggle === "object" && toggle !== null)
+    return true;
+  return gate;
+}
+function subOptions(toggle) {
+  return typeof toggle === "object" && toggle !== null ? toggle : {};
+}
 
-const GLOB_APP$2 = ["**/*.vue", "**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}"];
-const GLOB_NUXT_CONFIG = ["**/nuxt.config.{ts,js,mjs,mts,cjs,cts}"];
-const IGNORE_NON_APP = [
-  "**/server/**",
-  "**/scripts/**",
-  "**/packages/**",
-  "**/*.{config,test,spec}.*",
-  "**/*.d.ts"
-];
-const recommendedRules$2 = nuxtPlugin.configs.recommended.rules ?? {};
 function nuxtConfig(ctx, axes, opts = {}) {
-  const rules = resolveConcernRules(opts);
-  const configs = [
-    {
-      // Secret leakage is a correctness/security floor — on at every variant.
-      name: "nustack/nuxt/runtime-config",
-      files: GLOB_NUXT_CONFIG,
-      plugins: { "@nustack/nuxt": nuxtPlugin },
-      rules: {
-        "@nustack/nuxt/no-secret-in-public-runtimeconfig": "error"
-      }
-    }
-  ];
-  if (variantAtLeast(axes.variant, "recommended")) {
-    configs.push(
-      {
-        name: "nustack/nuxt/auto-imports",
-        files: GLOB_APP$2,
-        ignores: IGNORE_NON_APP,
-        plugins: { "@nustack/nuxt": nuxtPlugin },
-        rules: {
-          ...recommendedRules$2,
-          "@nustack/nuxt/no-process-env": "off",
-          "@nustack/nuxt/no-secret-in-public-runtimeconfig": "off",
-          "@nustack/nuxt/no-explicit-auto-import": ["error", {
-            imports: ctx.autoImports,
-            components: ctx.components
-          }]
-        }
-      },
-      {
-        name: "@nustack/nuxt/no-process-env",
-        files: GLOB_APP$2,
-        // process.env is legitimate in build/server config; only flag app code.
-        ignores: IGNORE_NON_APP,
-        plugins: { "@nustack/nuxt": nuxtPlugin },
-        rules: {
-          "@nustack/nuxt/no-process-env": recommendedRules$2["@nustack/nuxt/no-process-env"]
-        }
-      }
-    );
-  }
-  if (Object.keys(rules).length) {
-    configs.push({
-      name: "nustack/nuxt/rules",
-      files: GLOB_APP$2,
-      rules
-    });
-  }
-  return configs;
+  return nuxtConfigs({
+    variant: variantAtLeast(axes.variant, "recommended") ? "recommended" : "minimal",
+    autoImports: ctx.autoImports,
+    components: ctx.components,
+    rules: resolveConcernRules(opts)
+  });
 }
 
-const uiRules = nuxtEcosystemPlugin.configs.ui.rules ?? {};
-function nuxtUiConfig(_ctx, _axes, opts = {}) {
-  const rules = resolveConcernRules(opts);
-  return [
-    {
-      name: "nustack/nuxt-ui",
-      files: ["**/*.vue"],
-      plugins: { "@nustack/nuxt-ui": nuxtEcosystemPlugin },
-      rules: {
-        ...uiRules,
-        ...rules
-      }
-    }
-  ];
+function nuxtEcosystemConfig(ctx, _axes, options = {}) {
+  const configs = [];
+  if (isEnabled(options.nuxtUi, ctx.modules.nuxtUi))
+    configs.push(...nuxtUiConfigs({ rules: resolveConcernRules(subOptions(options.nuxtUi)) }));
+  return configs;
 }
 
 const GLOB_CODE = ["**/*.vue", "**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}"];
@@ -180,36 +130,11 @@ function typeAwareConfig() {
   ];
 }
 
-const GLOB_APP$1 = ["**/*.vue", "**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}"];
-const IGNORE_NON_CLIENT$1 = [
-  "**/server/**",
-  "**/scripts/**",
-  "**/packages/**",
-  "**/*.{config,test,spec}.*",
-  "**/*.d.ts"
-];
-const recommendedRules$1 = vitePlugin.configs.recommended.rules ?? {};
 function viteConfig(axes, opts = {}) {
-  const rules = resolveConcernRules(opts);
-  const configs = [];
-  if (variantAtLeast(axes.variant, "recommended")) {
-    configs.push({
-      name: "nustack/vite",
-      files: GLOB_APP$1,
-      ignores: IGNORE_NON_CLIENT$1,
-      plugins: { "@nustack/vite": vitePlugin },
-      rules: recommendedRules$1
-    });
-  }
-  if (Object.keys(rules).length) {
-    configs.push({
-      name: "nustack/vite/rules",
-      files: GLOB_APP$1,
-      ignores: IGNORE_NON_CLIENT$1,
-      rules
-    });
-  }
-  return configs;
+  return viteConfigs({
+    variant: variantAtLeast(axes.variant, "recommended") ? "recommended" : "minimal",
+    rules: resolveConcernRules(opts)
+  });
 }
 
 function vueConfig(_ctx, _axes, opts = {}) {
@@ -239,36 +164,11 @@ function vueConfig(_ctx, _axes, opts = {}) {
   ];
 }
 
-const GLOB_APP = ["**/*.vue", "**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}"];
-const IGNORE_NON_CLIENT = [
-  "**/server/**",
-  "**/scripts/**",
-  "**/packages/**",
-  "**/*.{config,test,spec}.*",
-  "**/*.d.ts"
-];
-const recommendedRules = vueUsePlugin.configs.recommended.rules ?? {};
 function vueUseConfig(axes, opts = {}) {
-  const rules = resolveConcernRules(opts);
-  const configs = [];
-  if (variantAtLeast(axes.variant, "recommended")) {
-    configs.push({
-      name: "nustack/vueuse",
-      files: GLOB_APP,
-      ignores: IGNORE_NON_CLIENT,
-      plugins: { "@nustack/vueuse": vueUsePlugin },
-      rules: recommendedRules
-    });
-  }
-  if (Object.keys(rules).length) {
-    configs.push({
-      name: "nustack/vueuse/rules",
-      files: GLOB_APP,
-      ignores: IGNORE_NON_CLIENT,
-      rules
-    });
-  }
-  return configs;
+  return vueUseConfigs({
+    variant: variantAtLeast(axes.variant, "recommended") ? "recommended" : "minimal",
+    rules: resolveConcernRules(opts)
+  });
 }
 
 const EMPTY_CONTEXT = {
@@ -284,16 +184,6 @@ function resolveDepth() {
 function mergeContext(context) {
   return defu(context, EMPTY_CONTEXT);
 }
-function isEnabled(toggle, gate) {
-  if (toggle === false)
-    return false;
-  if (toggle === true || typeof toggle === "object" && toggle !== null)
-    return true;
-  return gate;
-}
-function subOptions(toggle) {
-  return typeof toggle === "object" && toggle !== null ? toggle : {};
-}
 function resolveRules(options) {
   return {
     ...options.overrides,
@@ -319,8 +209,8 @@ function applyNustackConfig(base, options = {}, ...userConfigs) {
     configs.push(...viteConfig(axes, subOptions(options.vite)));
   if (isEnabled(options.tailwind, ctx.tailwind.detected))
     configs.push(...tailwindConfig(ctx, axes, subOptions(options.tailwind)));
-  if (isEnabled(options.nuxtUi, ctx.modules.nuxtUi))
-    configs.push(...nuxtUiConfig(ctx, axes, subOptions(options.nuxtUi)));
+  if (options.nuxtEcosystem !== false)
+    configs.push(...nuxtEcosystemConfig(ctx, axes, subOptions(options.nuxtEcosystem)));
   if (depth === "full")
     configs.push(...typeAwareConfig());
   const rules = resolveRules(options);
@@ -335,7 +225,7 @@ function applyNustackConfig(base, options = {}, ...userConfigs) {
 function nustack(options = {}, ...userConfigs) {
   return applyNustackConfig(composer(), {
     nuxt: false,
-    nuxtUi: false,
+    nuxtEcosystem: false,
     vite: false,
     vueUse: false,
     ...options,

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@nustackjs/lint",
   "configKey": "@nustackjs/lint",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nustackjs/lint",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Zero-config, project-aware ESLint (oxlint-ready) for Nuxt — plug it in and catch Nuxt bugs, not just style.",
   "author": "Norbiros <me@norbiros.dev>",
   "license": "MIT",
@@ -90,6 +90,7 @@
     "vue-tsc": "^3.3.3"
   },
   "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
     "dev": "npm run dev:prepare && nuxt dev playground",
     "dev:build": "nuxt build playground",
     "dev:prepare": "pnpm --filter '@nustackjs/lint-plugin-*' build && nuxt-module-build build && nuxt-module-build prepare && nuxt prepare playground",