@nxds/eslint-plugin 0.4.0 → 0.6.0

package/README.md

@@ -1,6 +1,6 @@
 # @nxds/eslint-plugin
 
-Custom ESLint rules for the Nexus design system. They split into two groups: **token-layer** rules that backfill what the deleted `--nx-size-*` primitive layer used to enforce, and **component-authoring** rules that machine-enforce conventions documented in `.claude/rules/` (so they fail `pnpm lint` and the pre-commit hook for every contributor, not just code review).
+Custom ESLint rules for the nxds design system. They split into two groups: **token-layer** rules that backfill what the deleted `--nx-size-*` primitive layer used to enforce, and **component-authoring** rules that machine-enforce conventions documented in `.claude/rules/` (so they fail `pnpm lint` and the pre-commit hook for every contributor, not just code review).
 
 ## Rules
 
@@ -30,7 +30,7 @@ Enforces `.claude/rules/extract-inline-handlers.md`: inline JSX handler props (`
 
 ### `@nxds/no-jsdoc-data-tags`
 
-Enforces `.claude/rules/code-comments.md`: JSDoc blocks must not carry `@default` or `@example` tags. The docs read prop defaults from code and usage from `docs` stories, so a tag is a second copy that can drift. Line comments and plain block comments are not checked. Wired in the root `eslint.config.js` for `packages/react/src`.
+Enforces `.claude/rules/code-comments.md`: JSDoc blocks must not carry `@default` or `@example` tags. The docs read prop defaults from code and usage from `docs` stories, so a tag is a second copy that can drift. Line comments and plain block comments are not checked. Wired in the root `eslint.config.js` for `packages/react/src` and `packages/vue/src`.
 
 ## Source of truth
 
@@ -39,13 +39,13 @@ The token-layer rules are self-contained: the canonical step set is `src/canonic
 ## Shareable config
 
 `@nxds/eslint-plugin/config` exports small flat-config helpers for consumers
-that want the Nexus rules without copying this monorepo's full lint setup:
+that want the nxds rules without copying this monorepo's full lint setup:
 
-- `nexusComponentConfig({ files })` wires the component-authoring rules.
-- `nexusSpacingTokenConfig({ files, parser })` wires the spacing-token rule; pass
+- `nxdsComponentConfig({ files })` wires the component-authoring rules.
+- `nxdsSpacingTokenConfig({ files, parser })` wires the spacing-token rule; pass
   `jsonc-eslint-parser` when linting JSON token files.
 
-`@nxds/eslint-plugin/tailwind` exports `nexusTailwindClassesConfig({ files,
+`@nxds/eslint-plugin/tailwind` exports `nxdsTailwindClassesConfig({ files,
 entryPoint })`, which wires `eslint-plugin-better-tailwindcss`'s
 `no-unknown-classes` against the stylesheet that builds `files`. Under
 `prefix(nx)` it reports a bare utility, a typo, and any class the theme no

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@nxds/eslint-plugin",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "type": "module",
-  "description": "ESLint rules that enforce Nexus UI conventions in copied components.",
+  "description": "ESLint rules that enforce nxds conventions in copied components.",
   "keywords": [
-    "nexus-ui",
+    "nxds",
     "design-system",
     "eslint",
     "eslintplugin",
@@ -21,7 +21,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nexuslabs-ai/nxds.git",
-    "directory": "packages/eslint-plugin-nexus"
+    "directory": "packages/eslint-plugin"
   },
   "publishConfig": {
     "access": "public"
@@ -35,9 +35,6 @@
   "files": [
     "src"
   ],
-  "scripts": {
-    "refresh:canonical-set": "node scripts/refresh-canonical-set.js"
-  },
   "dependencies": {
     "jsonc-eslint-parser": "^3.1.0"
   },
@@ -52,5 +49,8 @@
       "optional": true
     }
   },
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "refresh:canonical-set": "node scripts/refresh-canonical-set.js"
+  }
+}

package/src/config.js

@@ -10,7 +10,7 @@ export const spacingTokenRuleSet = {
   '@nxds/canonical-spacing-steps': 'error',
 };
 
-export function nexusComponentConfig(options = {}) {
+export function nxdsComponentConfig(options = {}) {
   const { files } = options;
 
   return {
@@ -22,7 +22,7 @@ export function nexusComponentConfig(options = {}) {
   };
 }
 
-export function nexusSpacingTokenConfig(options = {}) {
+export function nxdsSpacingTokenConfig(options = {}) {
   const { files, parser } = options;
 
   return {
@@ -45,6 +45,6 @@ export default {
   plugin,
   componentRuleSet,
   spacingTokenRuleSet,
-  nexusComponentConfig,
-  nexusSpacingTokenConfig,
+  nxdsComponentConfig,
+  nxdsSpacingTokenConfig,
 };

package/src/rules/no-render-prop-types.js

@@ -2,7 +2,9 @@
 // should not be typed as render callbacks (`(...) => ReactNode`), component
 // references (`ComponentType<...>`, `FC<...>`), or unions thereof. Event
 // handler props (`onClick`, `onSubmit`, ...) return data, not JSX, and are
-// exempt.
+// exempt. So is a prop whose JSDoc carries `@thirdPartyShape <reason>`: a
+// third-party API mandates its shape. It is a plain tag, not an
+// `eslint-disable`, so copied source lints clean in apps without this plugin.
 //
 // Known scope gaps — these patterns sneak through the AST visitors below and
 // must be caught by code review:
@@ -14,6 +16,8 @@
 //   only).
 
 const EVENT_HANDLER = /^on[A-Z]/;
+// The tag counts only with a reason after it.
+const THIRD_PARTY_TAG = /@thirdPartyShape[ \t]+[^\s*]/;
 
 const REACT_NODE_NAMES = new Set([
   'ReactNode',
@@ -113,6 +117,10 @@ export default {
       if (EVENT_HANDLER.test(name)) {
         return;
       }
+      const comments = context.sourceCode.getCommentsBefore(node);
+      if (comments.some((comment) => THIRD_PARTY_TAG.test(comment.value))) {
+        return;
+      }
       const ann = node.typeAnnotation?.typeAnnotation;
       if (!ann) {
         return;

package/src/rules/nx-class-conventions.js

@@ -262,7 +262,7 @@ export default {
       prefixOrder:
         'Wrong nx: prefix order — `nx:` must come BEFORE all modifiers (e.g. `nx:hover:bg-*`, not `hover:nx:bg-*`).',
       bannedAccent:
-        'Banned `accent` token — Nexus has no `accent`; use `background-hover` / `container-hover` / `popover-hover` (see shadcn-divergences.md).',
+        'Banned `accent` token — nxds has no `accent`; use `background-hover` / `container-hover` / `popover-hover` (see shadcn-divergences.md).',
       incompletePath:
         'Incomplete semantic token path — add a `-background`, `-foreground`, or `-subtle` suffix (e.g. `nx:bg-primary-background`).',
       rawPrimitive:

package/src/tailwind.js

@@ -27,11 +27,11 @@ const tailwindClassSelectors = [
   },
 ];
 
-export function nexusTailwindClassesConfig(options) {
+export function nxdsTailwindClassesConfig(options) {
   const { files, entryPoint } = options;
   if (typeof entryPoint !== 'string' || !path.isAbsolute(entryPoint)) {
     throw new Error(
-      `nexusTailwindClassesConfig: \`entryPoint\` must be an absolute path, got '${entryPoint}'.`
+      `nxdsTailwindClassesConfig: \`entryPoint\` must be an absolute path, got '${entryPoint}'.`
     );
   }
 
@@ -42,7 +42,7 @@ export function nexusTailwindClassesConfig(options) {
       'better-tailwindcss': { entryPoint, selectors: tailwindClassSelectors },
     },
     rules: {
-      // `dark` is the hook for the `@custom-variant dark` in nexus.css.
+      // `dark` is the hook for the `@custom-variant dark` in nxds.css.
       'better-tailwindcss/no-unknown-classes': [
         'error',
         { ignore: ['^dark$'] },