@w5s/conventional-changelog 1.0.0-alpha.1 → 1.0.0-alpha.3

package/README.md

@@ -1,19 +1,19 @@
 <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=# W5s Commitlint configuration _(${name})_) -->
-# W5s Commitlint configuration _(@w5s/commitlint-config)_
+# W5s Commitlint configuration _(@w5s/conventional-changelog)_
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 [![NPM Version][package-version-svg]][package-url]
 [![License][license-image]][license-url]
 
 <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=> ${description}&unknownTxt= ) -->
-> Commitlint configuration presets
+> Conventional changelog plugin for @w5s
 <!-- AUTO-GENERATED-CONTENT:END -->
 
 ## Installation
 
 <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=```console\nnpm install --save-dev ${name} @commitlint/cli\n```) -->
 ```console
-npm install --save-dev @w5s/commitlint-config @commitlint/cli
+npm install --save-dev @w5s/conventional-changelog @commitlint/cli
 ```
 <!-- AUTO-GENERATED-CONTENT:END -->
 
@@ -25,7 +25,7 @@ In the `package.json` of your project
 ```json
 {
   "commitlint": {
-    "extends": ["@w5s/commitlint-config"]
+    "extends": ["@w5s/conventional-changelog"]
   }
 }
 ```
@@ -62,10 +62,10 @@ npm exec --no -- commitlint --edit $1
 <!-- VARIABLES -->
 
 <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-version-svg]: https://img.shields.io/npm/v/${name}.svg?style=flat-square) -->
-[package-version-svg]: https://img.shields.io/npm/v/@w5s/commitlint-config.svg?style=flat-square
+[package-version-svg]: https://img.shields.io/npm/v/@w5s/conventional-changelog.svg?style=flat-square
 <!-- AUTO-GENERATED-CONTENT:END -->
 <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[package-url]: https://www.npmjs.com/package/${name}) -->
-[package-url]: https://www.npmjs.com/package/@w5s/commitlint-config
+[package-url]: https://www.npmjs.com/package/@w5s/conventional-changelog
 <!-- AUTO-GENERATED-CONTENT:END -->
 <!-- AUTO-GENERATED-CONTENT:START (PKG_JSON:template=[license-image]: https://img.shields.io/badge/license-${license}-green.svg?style=flat-square) -->
 [license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square

package/lib/gitmoji.js

@@ -51,16 +51,16 @@ var GitmojiCode;
             docs: ['📝'],
             style: ['🎨', '🚨'],
             refactor: ['♻️', '🏗️'],
-            test: ['✅'],
+            test: ['✅', '🧪'],
             perf: ['⚡️'],
             revert: ['⏪️'],
             ci: ['👷', '💚'],
             wip: ['🚧'],
             build: [],
-            chore: [],
+            chore: ['🔧'],
         };
         const entries = Array.from(
-        // @ts-ignore
+        // @ts-ignore entries are not well typed
         Object.entries(data));
         return new Map(entries.reduce((acc, [commitType, gitmojiUnicodeArray]) => acc
             .concat(gitmojiUnicodeArray.map((gitmojiUnicode) => [gitmojiUnicode, commitType]))

package/lib/transform.d.ts

@@ -10,7 +10,7 @@ export interface TransformConfig {
     language?: Language;
 }
 export declare function displayScope(scope: string | null | undefined, scopeDisplayNameMap: Record<string, string>): string | undefined;
-export declare function displayType(type: CommitConventionalType, options?: displayType.Options): string;
+export declare function displayType(type: CommitConventionalType | string, options?: displayType.Options): string;
 export declare namespace displayType {
     interface Options {
         readonly withEmoji?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/conventional-changelog",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.3",
   "description": "Conventional changelog plugin for @w5s",
   "keywords": [],
   "homepage": "https://github.com/w5s/project-config/blob/main/packages/conventional-changelog#readme",
@@ -31,10 +31,10 @@
   ],
   "scripts": {
     "build": "concurrently \"npm:build:*\" \":\"",
-    "build:src": "tsc",
+    "build:tsc": "tsc -b tsconfig.build.json",
     "clean": "concurrently \"npm:clean:*\" \":\"",
-    "clean:src": "rm -rf lib/*",
-    "docs": "md-magic --path '**/*.md' --ignore='node_modules'",
+    "clean:tsc": "rm -rf lib",
+    "docs": "node ../../markdown.mjs",
     "format": "concurrently \"npm:format:*\" \":\"",
     "format:src": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
     "lint": "concurrently \"npm:lint:*\" \":\"",
@@ -65,7 +65,7 @@
     "gitmojis": "^3.13.4"
   },
   "devDependencies": {
-    "@jest/globals": "29.4.1",
+    "@jest/globals": "29.4.2",
     "@types/conventional-changelog-writer": "4.0.2",
     "@types/conventional-commits-parser": "3.0.3"
   },
@@ -75,5 +75,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dd093c2907cf8e136f4adec9a14b176e0851de17"
+  "gitHead": "918c1157da6808ff19124ee96a4fe499f0da1877"
 }

package/src/gitmoji.ts

@@ -61,17 +61,17 @@ export namespace GitmojiCode {
       docs: ['📝'] as GitmojiCode.Unicode[],
       style: ['🎨', '🚨'] as GitmojiCode.Unicode[],
       refactor: ['♻️', '🏗️'] as GitmojiCode.Unicode[],
-      test: ['✅'] as GitmojiCode.Unicode[],
+      test: ['✅', '🧪'] as GitmojiCode.Unicode[],
       perf: ['⚡️'] as GitmojiCode.Unicode[],
       revert: ['⏪️'] as GitmojiCode.Unicode[],
       ci: ['👷', '💚'] as GitmojiCode.Unicode[],
       wip: ['🚧'] as GitmojiCode.Unicode[],
       build: [] as GitmojiCode.Unicode[],
-      chore: [] as GitmojiCode.Unicode[],
+      chore: ['🔧'] as GitmojiCode.Unicode[],
     };
 
     const entries = Array.from<[CommitConventionalType, GitmojiCode.Unicode[]]>(
-      // @ts-ignore
+      // @ts-ignore entries are not well typed
       Object.entries(data)
     );
     return new Map(

package/src/transform.ts

@@ -21,7 +21,7 @@ export function displayScope(scope: string | null | undefined, scopeDisplayNameM
     : scopeDisplayNameMap[scope];
 }
 
-export function displayType(type: CommitConventionalType, options: displayType.Options = {}): string {
+export function displayType(type: CommitConventionalType | string, options: displayType.Options = {}): string {
   const { withEmoji = true, language = 'en-US' } = options;
 
   if (CommitConventionalType.hasInstance(type)) {