@devbie/style-guide 1.3.0 → 1.4.0

package/README.md

@@ -1,7 +1,7 @@
 # @devbie/style-guide
 
 Single source of truth for code style across the devbie ecosystem
-(newbie / fewbie / nightwatch / apits). See ADR-010 in `worldzhy/newbie`.
+(newbie / fewbie / nightwatch / apits). See ADR-010 in `worldzhy/devbie`.
 
 ## Exports
 
@@ -9,7 +9,7 @@ Single source of truth for code style across the devbie ecosystem
 | --------------------------------- | ----------------------------------------------- |
 | `@devbie/style-guide/prettier`    | Canonical prettier config (all repos)           |
 | `@devbie/style-guide/eslint/base` | Baseline eslint flat config for Node TypeScript |
-| `@devbie/style-guide/eslint/nest` | Nest.js layer (Nest-specific rules, type-aware) |
+| `@devbie/style-guide/eslint/nest` | Nest layer (Nest-specific rules, type-aware)    |
 | `@devbie/style-guide/eslint/next` | Next.js layer (canonical Next.js rules)         |
 
 `nest` and `next` are **layers, not standalone standards**: every consumer
@@ -20,29 +20,34 @@ SDKs.
 
 ## Coverage: which entry each repo uses
 
-| Repo                                | Composition                               |
-| ----------------------------------- | ----------------------------------------- |
-| newbie-monorepo root                | `base` + `nest` scoped to `packages/core` |
-| newbie-starter, nightwatch-backend  | `base` + `nest`                           |
-| fewbie-starter, nightwatch-frontend | `base` + `next`                           |
-| newbie-modules                      | `base` only                               |
+| Repo                                | Composition                                 |
+| ----------------------------------- | ------------------------------------------- |
+| devbie monorepo root                | `base` + `nest` scoped to `packages/newbie` |
+| newbie-starter, nightwatch-backend  | `base` + `nest`                             |
+| fewbie-starter, nightwatch-frontend | `base` + `next`                             |
+| newbie-modules                      | `base` + `nest`                             |
 
 Two structural facts drive this table:
 
-- `newbie-modules` installs no dependencies at all (modules are copied into a
-  consumer, not built in place), so it can only use `base`, which is purely
-  syntactic.
-- The newbie monorepo root lints heterogeneous packages in one config: only
-  `packages/core` is Nest framework code, while the CLIs, the generator and
+- `newbie-modules` is a pure source registry — module sources are copied into
+  a consumer rather than built in place — but those sources are Nest code, so
+  it composes `[...base, ...nest]` with `injectable-should-be-provided`
+  scoped off: there is no host module graph in the registry for the rule to
+  resolve providers against, and the host keeps the rule enabled where that
+  graph exists.
+- The devbie monorepo root lints heterogeneous packages in one config: only
+  `packages/newbie` is Nest framework code, while the CLIs, the generator and
   the SDKs are plain Node. ESLint flat config does not read `package.json` and
   nested `eslint.config.mjs` files are not inherited, so per-package
   differentiation must be expressed in the root config with `files` scoping —
   never with per-package config files or `package.json` entry fields.
 
 `next` (and `nest`) must be loaded where the framework's packages are
-installed; `eslint-config-next` requires `next` at load time, and the Nest
-layer requires `class-validator` plus a TypeScript project for its four
-type-aware rules.
+installed: `eslint-config-next` requires `next` at load time (declared as an
+optional peer, so base/nest consumers are never forced to install Next.js),
+and the Nest layer requires a TypeScript project for its four type-aware
+rules. The Nest plugin's own peer declarations carry the rest — nothing
+imports `class-validator` at lint runtime.
 
 ## Usage
 
@@ -87,10 +92,14 @@ default, only as a deliberate milestone.
 
 ## Changelog
 
+- 1.3.1 — the internal `core` entry is inlined into `base` and removed. Nothing
+  imported it directly (`base` was its only consumer), and keeping two files
+  for one entry set made the loading order harder to read: `nest` and `next`
+  each also end on `prettierConfig`, so there is no shared tail to factor out.
 - 1.3.0 — new `nest` layer backed by `@darraghor/eslint-plugin-nestjs-typed`
   (recommended flat config, four type-aware rules), and `next` reshaped into a
   layer. Consumers now compose `[...base, ...nest]` / `[...base, ...next]`;
-  this also lets the newbie monorepo scope the Nest layer to `packages/core`
+  this also lets the devbie monorepo scope the Nest layer to `packages/newbie`
   via `files` instead of giving a Nest framework standard to its CLIs.
 - 1.2.0 — `backend` renamed to `base` and `frontend` removed. After apits and
   fewbie-cli joined the newbie monorepo (ADR-012/ADR-015), `frontend` had no

package/eslint/base.d.ts

@@ -0,0 +1,5 @@
+import type { Linter } from "eslint";
+
+// Baseline flat-config layer; compose first ([...base, ...nest] / [...base, ...next]).
+declare const config: Linter.Config[];
+export default config;

package/eslint/base.js

@@ -1,4 +1,4 @@
-import core from "./core.js";
+import tseslint from "typescript-eslint";
 import prettierConfig from "eslint-config-prettier";
 
 /**
@@ -6,11 +6,39 @@ import prettierConfig from "eslint-config-prettier";
  *
  * Consumers: every repo composes this and optionally adds a framework layer —
  * `[...base, ...nest]` for Nest applications, `[...base, ...next]` for Next.js
- * applications. Repos without a framework (newbie-modules, a dependency-free
- * source registry) use `base` alone: every rule here is syntactic, so it runs
- * without installing module dependencies.
+ * applications. Plain Node packages (CLIs, code generators, SDKs) use `base`
+ * alone: every rule here is syntactic, so it runs without installing module
+ * dependencies.
+ *
+ * Formatting rules (quotes, eol-last, trailing spaces, ...) are deliberately
+ * absent: prettier owns formatting. `prettierConfig` is appended last so that
+ * composing a layer on top still ends on the formatting-rule shutdown.
  *
  * Repo-specific rules and ignores belong in the consumer's own
  * eslint.config.mjs, spread after this entry.
  */
-export default [...core, prettierConfig];
+export default [
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_", varsIgnorePattern: "^_", caughtErrorsIgnorePattern: "^_" },
+      ],
+
+      // Code-quality rules carried over from the legacy gts-derived config.
+      "block-scoped-var": "error",
+      eqeqeq: ["error", "always", { null: "ignore" }],
+      "no-var": "error",
+      "prefer-const": "error",
+      "prefer-arrow-callback": "error",
+      "no-restricted-properties": [
+        "error",
+        { object: "describe", property: "only" },
+        { object: "it", property: "only" },
+      ],
+    },
+  },
+  prettierConfig,
+];

package/eslint/nest.d.ts

@@ -0,0 +1,5 @@
+import type { Linter } from "eslint";
+
+// Nest framework layer; compose after base ([...base, ...nest]).
+declare const config: Linter.Config[];
+export default config;

package/eslint/nest.js

@@ -2,7 +2,7 @@ import nestjsTyped from "@darraghor/eslint-plugin-nestjs-typed";
 import prettierConfig from "eslint-config-prettier";
 
 /**
- * Nest.js layer for the devbie ecosystem.
+ * Nest layer for the devbie ecosystem.
  *
  * This is a layer, not a standalone standard: compose it after `base`
  * (`export default [...base, ...nest]`). Keeping it separable lets a
@@ -11,9 +11,10 @@ import prettierConfig from "eslint-config-prettier";
  *
  * The rule set is the plugin's recommended flat config. Four of those rules
  * are type-aware, so every file covered by this layer must belong to a
- * TypeScript project (projectService resolves the nearest tsconfig.json), and
- * the plugin's peers (`class-validator`, `@typescript-eslint/parser`) must be
- * installed by the consumer.
+ * TypeScript project (projectService resolves the nearest tsconfig.json). The
+ * plugin's own peer declarations bring what its rules expect (`class-validator`
+ * is referenced by name only — the rules never import it at lint runtime), and
+ * npm/pnpm auto-install those peers, so no extra install step is required.
  *
  * `prettierConfig` is repeated here so that composing `[...base, ...nest]`
  * still ends on the formatting-rule shutdown.

package/eslint/next.d.ts

@@ -0,0 +1,5 @@
+import type { Linter } from "eslint";
+
+// Next.js framework layer; compose after base ([...base, ...next]).
+declare const config: Linter.Config[];
+export default config;

package/eslint/next.js

@@ -24,6 +24,16 @@ import prettierConfig from "eslint-config-prettier";
 export default [
   ...nextVitals,
   ...nextTs,
+  {
+    files: ["**/eslint.config.*"],
+    rules: {
+      // eslint-config-next bundles eslint-plugin-import, whose
+      // no-anonymous-default-export warns on `export default [...]` — the
+      // canonical flat-config idiom. Switch it off for config files so
+      // consumers need no `const config = [...]; export default config;` shim.
+      "import/no-anonymous-default-export": "off",
+    },
+  },
   prettierConfig,
   // Framework-generated artifacts; consumers append their own ignores.
   globalIgnores([".next/**", "out/**", "build/**", "next-env.d.ts"]),

package/package.json

@@ -1,15 +1,24 @@
 {
   "name": "@devbie/style-guide",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Single source of truth for devbie ecosystem code style: shared prettier config and composable eslint flat layers (base, nest, next)",
   "license": "MIT",
   "author": "worldzhy",
   "type": "module",
   "exports": {
     "./prettier": "./prettier.js",
-    "./eslint/base": "./eslint/base.js",
-    "./eslint/nest": "./eslint/nest.js",
-    "./eslint/next": "./eslint/next.js",
+    "./eslint/base": {
+      "types": "./eslint/base.d.ts",
+      "default": "./eslint/base.js"
+    },
+    "./eslint/nest": {
+      "types": "./eslint/nest.d.ts",
+      "default": "./eslint/nest.js"
+    },
+    "./eslint/next": {
+      "types": "./eslint/next.d.ts",
+      "default": "./eslint/next.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -27,7 +36,19 @@
   },
   "peerDependencies": {
     "eslint": "^9.0.0 || ^10.0.0",
+    "next": "^16.4.2",
     "prettier": "^3.9.9",
     "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "devDependencies": {
+    "next": "^16.4.2"
   }
 }

package/eslint/core.js

@@ -1,37 +0,0 @@
-import tseslint from "typescript-eslint";
-
-/**
- * Language-level baseline shared by every devbie codebase.
- *
- * Formatting rules (quotes, eol-last, trailing spaces, ...) are deliberately
- * absent: prettier owns formatting. Every public entry appends
- * eslint-config-prettier last so no plugin can re-enable eslint formatting
- * rules afterwards.
- *
- * Internal entry: consumers import `base` (or compose a layer such as
- * `nest` / `next` on top of it), never this file.
- */
-export default [
-  ...tseslint.configs.recommended,
-  {
-    rules: {
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        { argsIgnorePattern: "^_", varsIgnorePattern: "^_", caughtErrorsIgnorePattern: "^_" },
-      ],
-
-      // Code-quality rules carried over from the legacy gts-derived config.
-      "block-scoped-var": "error",
-      eqeqeq: ["error", "always", { null: "ignore" }],
-      "no-var": "error",
-      "prefer-const": "error",
-      "prefer-arrow-callback": "error",
-      "no-restricted-properties": [
-        "error",
-        { object: "describe", property: "only" },
-        { object: "it", property: "only" },
-      ],
-    },
-  },
-];