conventional-changelog-beemo - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

CHANGELOG.md

@@ -0,1 +1,12 @@
+## 1.6.0 - 2021-02-05
+
+#### 🚀 Updates
+
+- Added a new commit prefix type, `perf`, which can be used for performance improvements. This is a
+  patch version bump.
+
+#### 📦 Dependencies
+
+- Updated all to latest.
+
 ### 1.5.3 - 2019-11-12
@@ -2,0 +13,0 @@

lib/checkCommitFormat.d.ts

 import { CommitType } from './types';
-export default function checkCommitFormat(commit: string): null | {
+export default function checkCommitFormat(commit: string): {
     scope: string;
     type: CommitType;
-};
+} | null;

lib/constants.js

@@ -5,3 +5,3 @@ "use strict";
 // eslint-disable-next-line security/detect-unsafe-regex
-exports.COMMIT_FORMAT_PREFIX = /^(break|breaking|build|ci|cd|deps|docs|feature|fix|internal|misc|new|patch|release|revert|security|style|styles|test|tests|type|types|update)(?:\(([a-zA-Z0-9\-., ]+)\))?:/u;
+exports.COMMIT_FORMAT_PREFIX = /^(break|breaking|build|ci|cd|deps|docs|feature|fix|internal|misc|new|patch|perf|release|revert|security|style|styles|test|tests|type|types|update)(?:\(([a-zA-Z0-9\-., ]+)\))?:/u;
 exports.GROUPS = [
@@ -68,2 +68,8 @@ {
         bump: 'patch',
+        emoji: '⚡️',
+        label: 'Performance',
+        types: ['perf'],
+    },
+    {
+        bump: 'patch',
         emoji: '⚙️',
@@ -70,0 +76,0 @@ label: 'Types',

lib/getTypeGroup.js

@@ -5,3 +5,3 @@ "use strict";
 function getTypeGroup(type) {
-    const group = constants_1.GROUPS.find(g => g.types.includes(type));
+    const group = constants_1.GROUPS.find((g) => g.types.includes(type));
     if (!group) {
@@ -8,0 +8,0 @@ throw new Error(`Cannot find group for type "${type}".`);

lib/index.js

@@ -14,3 +14,3 @@ "use strict";
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -24,5 +24,5 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 exports.checkCommitFormat = checkCommitFormat_1.default;
+const conventionalChangelog_1 = __importDefault(require("./conventionalChangelog"));
 const getTypeGroup_1 = __importDefault(require("./getTypeGroup"));
 exports.getTypeGroup = getTypeGroup_1.default;
-const conventionalChangelog_1 = __importDefault(require("./conventionalChangelog"));
 const parserOpts_1 = __importDefault(require("./parserOpts"));
@@ -29,0 +29,0 @@ const recommendedBumpOpts_1 = __importDefault(require("./recommendedBumpOpts"));

lib/recommendedBumpOpts.js

@@ -6,4 +6,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const getTypeGroup_1 = __importDefault(require("./getTypeGroup"));
 const parserOpts_1 = __importDefault(require("./parserOpts"));
-const getTypeGroup_1 = __importDefault(require("./getTypeGroup"));
 const options = {
@@ -15,3 +15,3 @@ parserOpts: parserOpts_1.default,
         let features = 0;
-        commits.forEach(commit => {
+        commits.forEach((commit) => {
             let group;
@@ -18,0 +18,0 @@ try {

lib/types.d.ts

@@ -15,6 +15,6 @@ export interface Note {
 }
-export declare type CommitType = 'break' | 'breaking' | 'release' | 'new' | 'update' | 'feature' | 'fix' | 'deps' | 'docs' | 'patch' | 'style' | 'styles' | 'security' | 'revert' | 'ci' | 'cd' | 'build' | 'test' | 'tests' | 'type' | 'types' | 'internal' | 'misc';
-export declare type CommitGroupLabel = 'Breaking' | 'Release' | 'Updates' | 'Fixes' | 'Dependencies' | 'Docs' | 'Styles' | 'Security' | 'Reverts' | 'Types' | 'Internals' | 'Misc';
+export declare type CommitType = 'break' | 'breaking' | 'build' | 'cd' | 'ci' | 'deps' | 'docs' | 'feature' | 'fix' | 'internal' | 'misc' | 'new' | 'patch' | 'perf' | 'release' | 'revert' | 'security' | 'style' | 'styles' | 'test' | 'tests' | 'type' | 'types' | 'update';
+export declare type CommitGroupLabel = 'Breaking' | 'Dependencies' | 'Docs' | 'Fixes' | 'Internals' | 'Misc' | 'Performance' | 'Release' | 'Reverts' | 'Security' | 'Styles' | 'Types' | 'Updates';
 export interface Group {
-    bump?: 'patch' | 'minor' | 'major';
+    bump?: 'major' | 'minor' | 'patch';
     emoji: string;
@@ -66,5 +66,5 @@ label: CommitGroupLabel;
 }
-export declare type Pattern = string | RegExp | null;
-export declare type Correspondence = string | string[];
-export declare type Sorter<T> = string | string[] | ((a: T, b: T) => number);
+export declare type Pattern = RegExp | string | null;
+export declare type Correspondence = string[] | string;
+export declare type Sorter<T> = string[] | string | ((a: T, b: T) => number);
 export interface ParserOptions {
@@ -74,7 +74,7 @@ fieldPattern: Pattern;
     headerCorrespondence: Correspondence;
-    issuePrefixes: string | string[];
+    issuePrefixes: string[] | string;
     mergePattern: Pattern;
     mergeCorrespondence: Correspondence;
-    noteKeywords: string | string[];
-    referenceActions: string | string[] | null;
+    noteKeywords: string[] | string;
+    referenceActions: string[] | string | null;
     revertPattern: Pattern;
@@ -95,3 +95,3 @@ revertCorrespondence: Correspondence;
     footerPartial: string;
-    generateOn: ((commit: Commit, commits: Commit[], context: Context, options: WriterOptions) => unknown) | string;
+    generateOn: string | ((commit: Commit, commits: Commit[], context: Context, options: WriterOptions) => unknown);
     groupBy: string;
@@ -98,0 +98,0 @@ headerPartial: string;

lib/writerOpts.js

@@ -9,4 +9,4 @@ "use strict";
 const path_1 = __importDefault(require("path"));
+const constants_1 = require("./constants");
 const getTypeGroup_1 = __importDefault(require("./getTypeGroup"));
-const constants_1 = require("./constants");
 const groupEmojis = constants_1.GROUPS.reduce((data, group) => ({
@@ -22,7 +22,8 @@ ...data,
     Security: 0,
+    Performance: -1,
     Styles: -1,
-    Types: -1,
-    Docs: -2,
+    Types: -2,
     Dependencies: -3,
-    Misc: -3,
+    Docs: -4,
+    Misc: -4,
     Reverts: -4,
@@ -56,3 +57,3 @@ Internals: -5,
         'src',
-    ].forEach(browsePart => {
+    ].forEach((browsePart) => {
         if (base.includes(`/${browsePart}/`)) {
@@ -116,3 +117,3 @@ [base] = base.split(`/${browsePart}/`);
         commit.hashLink = createLink([context.commit, commit.hash], context);
-        commit.references.forEach(reference => {
+        commit.references.forEach((reference) => {
             reference.issueLink = createLink([context.issue, reference.issue], context, reference);
@@ -119,0 +120,0 @@ let source = `${reference.repository || ''}#${reference.issue}`;

package.json

 {
   "name": "conventional-changelog-beemo",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Conventional changelog preset for Beemo and associated projects.",
@@ -24,3 +24,3 @@ "keywords": [
     "jest": "beemo jest -i",
-    "prettier": "beemo prettier",
+    "format": "beemo prettier",
     "release": "npx np --yolo",
@@ -34,7 +34,7 @@ "type": "beemo typescript --noEmit",
   "devDependencies": {
-    "@milesj/build-tools": "^2.9.0",
-    "@types/node": "^14.0.23",
+    "@milesj/build-tools": "^2.17.0",
+    "@types/node": "^14.14.25",
     "@types/shelljs": "^0.8.8",
-    "conventional-changelog-core": "^4.1.7",
-    "conventional-recommended-bump": "^6.0.9",
+    "conventional-changelog-core": "^4.2.2",
+    "conventional-recommended-bump": "^6.1.0",
     "shelljs": "^0.8.4"
@@ -41,0 +41,0 @@ },

README.md

@@ -35,3 +35,3 @@ # conventional-changelog-beemo
 - `update` - Updates an existing feature.
-- `feature` - Both a new and update.
+- `feature` - A large feature that consist of multiple types of changes.
 
@@ -43,2 +43,3 @@ #### Patch
 - `docs` - Updates documentation, changelogs, or readmes.
+- `perf` - Performance improvements.
 - `revert` - Reverts previous or broken code.
@@ -45,0 +46,0 @@ - `style`, `styles` - Updates visual styles, like CSS, or code formatting.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26527

increased by1.83%

Lines of code

516

increased by1.38%

Number of lines in readme file

106

increased by0.95%

No dependency changes