@devbie/style-guide 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# @devbie/style-guide
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Single source of truth for code style across the devbie ecosystem
+(newbie / fewbie / nightwatch). See ADR-010 in `worldzhy/newbie`.
+
+## Exports
+
+| Entry                             | Contents                                              |
+| --------------------------------- | ----------------------------------------------------- |
+| `@devbie/style-guide/prettier`    | Canonical prettier config                             |
+| `@devbie/style-guide/eslint/nest` | eslint flat config for Nest/Node TypeScript codebases |
+| `@devbie/style-guide/eslint/next` | eslint flat config for Next.js codebases              |
+
+## Usage
+
+### prettier
+
+Delete any local `.prettierrc` and reference the shared config in
+`package.json`:
+
+```json
+{
+  "prettier": "@devbie/style-guide/prettier"
+}
+```
+
+`.prettierignore` stays repo-local: it lists repo-specific build artifacts,
+not style decisions.
+
+### eslint (flat config)
+
+`eslint.config.mjs` in the consumer repo:
+
+```js
+import nest from "@devbie/style-guide/eslint/nest";
+// or: import next from "@devbie/style-guide/eslint/next";
+
+export default [
+  ...next,
+  // Repo-specific rules and ignores go here.
+];
+```
+
+Consumers need `eslint` (^9 or ^10), `prettier` (^3.9.9) and `typescript`
+installed as their own dev dependencies (declared as peers of this package).
+
+## Version policy
+
+All devbie packages stay on the 1.x line until the ecosystem launches;
+breaking style changes bump minor, not major. Dependency major upgrades of
+prettier/eslint follow the ecosystem-wide major-freeze policy: not by
+default, only as a deliberate milestone.

package/eslint/nest.js

@@ -0,0 +1,28 @@
+import tseslint from "typescript-eslint";
+import prettierConfig from "eslint-config-prettier";
+
+/**
+ * Shared eslint flat config for Nest/Node TypeScript codebases
+ * (nightwatch-backend, newbie-starter, the newbie/fewbie framework repos).
+ *
+ * Formatting rules (quotes, eol-last, trailing spaces, ...) are deliberately
+ * absent: prettier owns formatting, and eslint-config-prettier disables the
+ * eslint side. Prettier violations are enforced by `npm run format:check`.
+ */
+export default tseslint.config(...tseslint.configs.recommended, prettierConfig, {
+  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" }],
+  },
+});

package/eslint/next.js

@@ -0,0 +1,19 @@
+import { defineConfig, globalIgnores } from "eslint/config";
+import nextVitals from "eslint-config-next/core-web-vitals";
+import nextTs from "eslint-config-next/typescript";
+import prettierConfig from "eslint-config-prettier";
+
+/**
+ * Shared eslint flat config for Next.js codebases
+ * (nightwatch-frontend, fewbie-starter).
+ *
+ * Repo-specific rules and ignores belong in the consumer's own
+ * eslint.config.mjs, spread after this entry.
+ */
+export default defineConfig([
+  ...nextVitals,
+  ...nextTs,
+  prettierConfig,
+  // Framework-generated artifacts; consumers append their own ignores.
+  globalIgnores([".next/**", "out/**", "build/**", "next-env.d.ts"]),
+]);

package/package.json

@@ -1,6 +1,31 @@
 {
   "name": "@devbie/style-guide",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Single source of truth for devbie ecosystem code style: shared prettier config and eslint flat configs (Nest and Next entries)",
+  "license": "MIT",
+  "author": "worldzhy",
+  "type": "module",
+  "exports": {
+    "./prettier": "./prettier.js",
+    "./eslint/nest": "./eslint/nest.js",
+    "./eslint/next": "./eslint/next.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "prettier.js",
+    "eslint"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "eslint-config-next": "^16.4.2",
+    "eslint-config-prettier": "^10.1.8",
+    "typescript-eslint": "^8.71.2"
+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0 || ^10.0.0",
+    "prettier": "^3.9.9",
+    "typescript": ">=5.0.0"
+  }
+}

package/prettier.js

@@ -0,0 +1,29 @@
+/**
+ * Canonical prettier config for the devbie ecosystem.
+ * Consumers reference it via `"prettier": "@devbie/style-guide/prettier"`
+ * in their package.json instead of keeping a local .prettierrc copy.
+ *
+ * @type {import("prettier").Config}
+ */
+export default {
+  printWidth: 120,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: false,
+  jsxSingleQuote: false,
+  quoteProps: "as-needed",
+  trailingComma: "all",
+  bracketSpacing: true,
+  bracketSameLine: false,
+  arrowParens: "always",
+  singleAttributePerLine: false,
+  objectWrap: "preserve",
+  htmlWhitespaceSensitivity: "css",
+  embeddedLanguageFormatting: "auto",
+  endOfLine: "lf",
+  proseWrap: "preserve",
+  insertPragma: false,
+  requirePragma: false,
+  experimentalTernaries: false,
+};