@w5s/conventional-changelog 1.0.7 → 1.0.9

package/lib/data.d.ts

@@ -8,6 +8,7 @@ export declare const CommitConventionalType: {
     getData: (commitType: CommitConventionalType) => CommitConventionalTypeData;
     values: () => readonly CommitConventionalType[];
     parse: (anyValue: string) => CommitConventionalType | undefined;
+    findWhere: (predicate: (data: CommitConventionalTypeData) => boolean) => CommitConventionalType[];
     Build: "build";
     CI: "ci";
     Docs: "docs";
@@ -24,4 +25,5 @@ export declare const CommitConventionalType: {
 export interface CommitConventionalTypeData {
     emoji: string;
     'en-US': string;
+    changelog: boolean;
 }

package/lib/data.js

@@ -22,50 +22,62 @@ exports.CommitConventionalType = (() => {
         feat: {
             emoji: '✨',
             'en-US': 'Features',
+            changelog: true,
         },
         fix: {
             emoji: '🐛',
             'en-US': 'Bug Fixes',
+            changelog: true,
         },
         build: {
             emoji: '👷',
             'en-US': 'Build System',
+            changelog: false,
         },
         chore: {
             emoji: '🎫',
             'en-US': 'Chores',
+            changelog: false,
         },
         ci: {
             emoji: '🔧',
             'en-US': 'Continuous Integration',
+            changelog: false,
         },
         docs: {
             emoji: '📝',
             'en-US': 'Documentation',
+            changelog: false,
         },
         test: {
             emoji: '✅',
             'en-US': 'Tests',
+            changelog: false,
         },
         perf: {
             emoji: '⚡',
             'en-US': 'Performance Improvements',
+            changelog: true,
         },
         refactor: {
             emoji: '♻',
             'en-US': 'Code Refactoring',
+            changelog: false,
         },
         revert: {
             emoji: '⏪',
             'en-US': 'Reverts',
+            changelog: true,
         },
         style: {
             emoji: '💄',
             'en-US': 'Styles',
+            changelog: false,
         },
         wip: {
             emoji: '🚧',
             'en-US': 'Work in progress',
+            changelog: false,
         },
     };
     function hasInstance(anyValue) {
@@ -80,5 +92,9 @@ exports.CommitConventionalType = (() => {
     function values() {
         return enumValues;
     }
-    return { ...enumObject, hasInstance, getData, values, parse };
+    function findWhere(predicate) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return enumValues.filter((enumValue) => predicate(getData(enumValue)));
+    }
+    return { ...enumObject, hasInstance, getData, values, parse, findWhere };
 })();

package/lib/writer-opts.d.ts

@@ -1,4 +1,6 @@
 import type { Options } from 'conventional-changelog-writer';
+import { CommitConventionalType } from './data.js';
 export interface WriterOptions extends Options {
 }
+export declare const defaultDisplayTypes: CommitConventionalType[];
 export declare const writerOpts: WriterOptions;

package/lib/writer-opts.js

@@ -1,17 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writerOpts = void 0;
+exports.writerOpts = exports.defaultDisplayTypes = void 0;
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const transform_js_1 = require("./transform.js");
+const data_js_1 = require("./data.js");
 const basePath = (0, node_path_1.resolve)((0, node_path_1.dirname)(__dirname), './template');
 const template = (0, node_fs_1.readFileSync)(`${basePath}/template.hbs`, 'utf8');
 const header = (0, node_fs_1.readFileSync)(`${basePath}/header.hbs`, 'utf8');
 const commit = (0, node_fs_1.readFileSync)(`${basePath}/commit.hbs`, 'utf8');
 const footer = (0, node_fs_1.readFileSync)(`${basePath}/footer.hbs`, 'utf8');
 const author = (0, node_fs_1.readFileSync)(`${basePath}/author.hbs`, 'utf8');
+exports.defaultDisplayTypes = data_js_1.CommitConventionalType.findWhere((_) => _.changelog);
 exports.writerOpts = {
-    transform: (0, transform_js_1.createTransform)({}),
+    transform: (0, transform_js_1.createTransform)({
+        displayTypes: exports.defaultDisplayTypes,
+    }),
     groupBy: 'type',
     commitGroupsSort: 'title',
     commitsSort: ['scope', 'subject'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/conventional-changelog",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Conventional changelog plugin for @w5s",
   "keywords": [],
   "homepage": "https://github.com/w5s/project-config/blob/main/packages/conventional-changelog#readme",
@@ -54,8 +54,8 @@
   "devDependencies": {
     "@types/conventional-changelog-writer": "4.0.2",
     "@types/conventional-commits-parser": "3.0.3",
-    "vite": "4.2.2",
-    "vitest": "0.30.1"
+    "vite": "4.3.5",
+    "vitest": "0.31.0"
   },
   "engines": {
     "node": ">=16.0.0"
@@ -63,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ce80b2f0955fd951ab4ff55fd284647d048606d4"
+  "gitHead": "9f31748b4b649e8fdcd479141b0d65321d9d4556"
 }

package/src/data.ts

@@ -40,50 +40,62 @@ export const CommitConventionalType = (() => {
     feat: {
       emoji: '✨',
       'en-US': 'Features',
+      changelog: true,
     },
     fix: {
       emoji: '🐛',
       'en-US': 'Bug Fixes',
+      changelog: true,
     },
     build: {
       emoji: '👷',
       'en-US': 'Build System',
+      changelog: false,
     },
     chore: {
       emoji: '🎫',
       'en-US': 'Chores',
+      changelog: false,
     },
     ci: {
       emoji: '🔧',
       'en-US': 'Continuous Integration',
+      changelog: false,
     },
     docs: {
       emoji: '📝',
       'en-US': 'Documentation',
+      changelog: false,
     },
     test: {
       emoji: '✅',
       'en-US': 'Tests',
+      changelog: false,
     },
     perf: {
       emoji: '⚡',
       'en-US': 'Performance Improvements',
+      changelog: true,
     },
     refactor: {
       emoji: '♻',
       'en-US': 'Code Refactoring',
+      changelog: false,
     },
     revert: {
       emoji: '⏪',
       'en-US': 'Reverts',
+      changelog: true,
     },
     style: {
       emoji: '💄',
       'en-US': 'Styles',
+      changelog: false,
     },
     wip: {
       emoji: '🚧',
       'en-US': 'Work in progress',
+      changelog: false,
     },
   };
 
@@ -103,10 +115,16 @@ export const CommitConventionalType = (() => {
     return enumValues;
   }
 
-  return { ...enumObject, hasInstance, getData, values, parse };
+  function findWhere(predicate: (data: CommitConventionalTypeData) => boolean): CommitConventionalType[] {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return enumValues.filter((enumValue) => predicate(getData(enumValue)!));
+  }
+
+  return { ...enumObject, hasInstance, getData, values, parse, findWhere };
 })();
 
 export interface CommitConventionalTypeData {
   emoji: string;
   'en-US': string;
+  changelog: boolean;
 }

package/src/writer-opts.ts

@@ -2,6 +2,7 @@ import type { Options } from 'conventional-changelog-writer';
 import { readFileSync } from 'node:fs';
 import { resolve, dirname } from 'node:path';
 import { createTransform } from './transform.js';
+import { CommitConventionalType } from './data.js';
 
 export interface WriterOptions extends Options {}
 
@@ -13,8 +14,12 @@ const commit = readFileSync(`${basePath}/commit.hbs`, 'utf8');
 const footer = readFileSync(`${basePath}/footer.hbs`, 'utf8');
 const author = readFileSync(`${basePath}/author.hbs`, 'utf8');
 
+export const defaultDisplayTypes = CommitConventionalType.findWhere((_) => _.changelog);
+
 export const writerOpts: WriterOptions = {
-  transform: createTransform({}),
+  transform: createTransform({
+    displayTypes: defaultDisplayTypes,
+  }),
   groupBy: 'type',
   commitGroupsSort: 'title',
   commitsSort: ['scope', 'subject'],