fds-vue-core 6.0.13 → 6.1.1

package/README.md

@@ -136,6 +136,45 @@ import { FdsButtonPrimary, FdsInput, FdsModal } from 'fds-vue-core'
 
 All components are fully typed. Type definitions are included in the package.
 
+## Commit workflow
+
+Use these commands to create commits with the shared Commitizen adapter and security dependency helper.
+
+### In this repo
+
+```bash
+pnpm commit
+pnpm commit:vuln
+```
+
+- `pnpm commit` starts Commitizen prompts (configured via `scripts/cz/cz-adapter.cjs`).
+- `pnpm commit:vuln` runs `scripts/vuln-commit.mjs` and auto-creates a `vuln(...)` commit from staged `package.json` dependency bumps.
+
+### In a consuming repo
+
+Install dependencies:
+
+```bash
+pnpm add fds-vue-core
+pnpm add -D commitizen
+```
+
+Add this to the consuming repo `package.json`:
+
+```json
+{
+  "scripts": {
+    "commit": "cz",
+    "commit:vuln": "fds-vuln-commit"
+  },
+  "config": {
+    "commitizen": {
+      "path": "fds-vue-core/cz-adapter"
+    }
+  }
+}
+```
+
 ## Further Documentation
 
 - [Usage Guide](./src/docs/Usage.md) - Detailed usage instructions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fds-vue-core",
-  "version": "6.0.13",
+  "version": "6.1.1",
   "description": "FDS Vue Core Component Library",
   "type": "module",
   "bin": {
@@ -28,7 +28,9 @@
     "./eslint.config.base.js": "./configs/eslint.config.base.js",
     "./prettier.config.js": "./configs/prettier.config.js",
     "./vscode-settings.json": "./configs/vscode-settings.json",
-    "./vuln-commit": "./scripts/vuln-commit.mjs"
+    "./vuln-commit": "./scripts/vuln-commit.mjs",
+    "./cz-adapter": "./scripts/cz/cz-adapter.cjs",
+    "./cz-config": "./scripts/cz/.cz-config.cjs"
   },
   "files": [
     "dist",
@@ -67,7 +69,15 @@
     "yalc:push": "npm run build && yalc push",
     "serve:playground": "pnpm --dir playground-consumer dev",
     "create:release": "bash ./scripts/release.sh",
-    "vuln-commit": "node scripts/vuln-commit.mjs"
+    "commit": "git-cz",
+    "commit:vuln": "node scripts/vuln-commit.mjs",
+    "vuln-commit": "node scripts/vuln-commit.mjs",
+    "cz:config": "node -e \"console.log(require('./scripts/cz/.cz-config.cjs'))\""
+  },
+  "config": {
+    "commitizen": {
+      "path": "./scripts/cz/cz-adapter.cjs"
+    }
   },
   "peerDependencies": {
     "vue": "^3.5.25"
@@ -93,6 +103,7 @@
     "@vitest/eslint-plugin": "^1.5.2",
     "@vue/eslint-config-prettier": "^10.2.0",
     "@vue/tsconfig": "^0.8.1",
+    "commitizen": "^4.3.1",
     "eslint": "^9.39.2",
     "eslint-plugin-storybook": "^10.1.10",
     "eslint-plugin-vue": "~10.6.2",
@@ -123,7 +134,8 @@
     "overrides": {
       "minimatch": "^10.2.3",
       "flatted": "^3.4.2",
-      "lodash": ">=4.18.0"
+      "lodash": ">=4.18.0",
+      "tmp": "^0.2.4"
     },
     "onlyBuiltDependencies": [
       "@parcel/watcher",

package/scripts/cz/.cz-config.cjs

@@ -0,0 +1,22 @@
+module.exports = {
+  types: [
+    { value: 'feat', name: 'feat(scope): Added' },
+    { value: 'fix', name: 'fix(scope): Fixed' },
+    { value: 'perf', name: 'perf(scope): Performance' },
+    { value: 'refactor', name: 'refactor(scope): Changed' },
+    { value: 'chore', name: 'chore(scope): Changed' },
+    { value: 'dep', name: 'dep(scope): Dependencies (single package or batch)' },
+    { value: 'vuln', name: 'vuln(scope): Security dependency update (single package or batch)' },
+    { value: 'fix(security)', name: 'fix(security): Security' }
+  ],
+  allowCustomScopes: true,
+  allowBreakingChanges: [],
+  skipQuestions: ['footer', 'breaking'],
+  subjectLimit: 120,
+  messages: {
+    type: 'Select the type of change you are committing:',
+    customScope: 'Packages (for dep/vuln) or scope:',
+    subject: 'Commit subject (imperative, no trailing period):',
+    body: "Optional body (use '|' for newline):"
+  }
+}

package/scripts/cz/cz-adapter.cjs

@@ -0,0 +1,112 @@
+module.exports = {
+  prompter(cz, commit) {
+    const types = [
+      { value: "feat", name: "feat(scope): Added" },
+      { value: "fix", name: "fix(scope): Fixed" },
+      { value: "perf", name: "perf(scope): Performance" },
+      { value: "refactor", name: "refactor(scope): Changed" },
+      { value: "chore", name: "chore(scope): Changed" },
+      { value: "docs", name: "docs(scope): Documentation" },
+      { value: "dep", name: "dep(scope): Dependencies (single package or batch)" },
+      { value: "vuln", name: "vuln(scope): Security dependency update (single package or batch)" },
+      { value: "fix(security)", name: "fix(security): Security" },
+    ];
+
+    const questions = [
+      {
+        type: "list",
+        name: "change_type",
+        message: "Select the type of change you are committing",
+        choices: types,
+      },
+      {
+        type: "input",
+        name: "scope",
+        when: (answers) => !["dep", "vuln"].includes(answers.change_type),
+        message: "Scope:",
+      },
+      {
+        type: "input",
+        name: "packages",
+        when: (answers) => ["dep", "vuln"].includes(answers.change_type),
+        message: "Packages:",
+      },
+      {
+        type: "list",
+        name: "vuln_change_kind",
+        when: (answers) => answers.change_type === "vuln",
+        message: "Vulnerability change type:",
+        choices: [
+          { value: "override", name: "override" },
+          { value: "bump", name: "bump" },
+        ],
+      },
+      {
+        type: "input",
+        name: "vuln_target_version",
+        when: (answers) => answers.change_type === "vuln",
+        message: "Target version/range (e.g. 5.2.2 or >=5.2.2):",
+        validate: (value) => (value && value.trim() ? true : "Provide a target version/range"),
+      },
+      {
+        type: "list",
+        name: "dep_change_kind",
+        when: (answers) => answers.change_type === "dep",
+        message: "Dependency change type:",
+        choices: [
+          { value: "new", name: "new package" },
+          { value: "update", name: "updated package" },
+          { value: "remove", name: "removed package" },
+        ],
+      },
+      {
+        type: "input",
+        name: "dep_version",
+        when: (answers) => answers.change_type === "dep",
+        message: "Version (x.y.z):",
+        validate: (value) => (/^\d+\.\d+\.\d+$/.test(value) ? true : "Use format x.y.z"),
+      },
+      {
+        type: "input",
+        name: "shortcut_id",
+        when: (answers) => !["dep", "vuln"].includes(answers.change_type),
+        message: "Shortcut ID digits only (optional, e.g. 1234):",
+      },
+      {
+        type: "input",
+        name: "message",
+        when: (answers) => !["dep", "vuln"].includes(answers.change_type),
+        message: "Commit subject (imperative, no trailing period):",
+      },
+      {
+        type: "input",
+        name: "body",
+        message: "Optional body (use '|' for newline):",
+      },
+    ];
+
+    cz.prompt(questions).then((answers) => {
+      const type = answers.change_type;
+      const scopeValue = ["dep", "vuln"].includes(type) ? answers.packages : answers.scope;
+      const needsEmptyParens = ["dep", "vuln"].includes(type) && !scopeValue;
+      const scopePart = scopeValue ? `(${scopeValue})` : needsEmptyParens ? "()" : "";
+      const shortcutPart = answers.shortcut_id ? ` [sc-${answers.shortcut_id}]` : "";
+      const bodyPart = answers.body ? `\n\n${answers.body.split("|").join("\n")}` : "";
+      const depSubject =
+        answers.dep_change_kind === "new"
+          ? `add ${answers.dep_version}`
+          : answers.dep_change_kind === "remove"
+            ? `yeet ${answers.dep_version}`
+            : `bump to ${answers.dep_version}`;
+      const vulnSubject =
+        type === "vuln"
+          ? answers.vuln_change_kind === "override"
+            ? `override ${answers.vuln_target_version}`
+            : `bump to ${answers.vuln_target_version}`
+          : "";
+      const subject = type === "dep" ? depSubject : type === "vuln" ? vulnSubject : answers.message;
+      const commitMessage = `${type}${scopePart}: ${subject}${shortcutPart}${bodyPart}`;
+      commit(commitMessage);
+    });
+  },
+};