git-cz-emoji - npm Package Compare versions

Comparing version 1.1.17 to 1.1.18

dist/main.d.ts

@@ -0,1 +1,2 @@
+import { commitTypes } from './types';
 export declare const CommitProfile: {
@@ -120,1 +121,2 @@ bodyLineLength: number;
 };
+export declare type CommitTypes = commitTypes;

dist/types.d.ts

@@ -120,2 +120,3 @@ export declare const commitProfile: {
 };
+export declare type commitTypes = 'build' | 'ci' | 'docs' | 'feat' | 'fix' | 'perf' | 'refactor' | 'revert' | 'style' | 'test' | 'wip' | 'chore';
 export declare const types: {
@@ -122,0 +123,0 @@ build: {

dist/types.js

@@ -33,3 +33,3 @@ "use strict";
             description: 'Changes to our CI configuration files and scripts (example scopes: Travis, GitLab, GitHub, BrowserStack, etc.)',
-            emoji: '⚙️',
+            emoji: '📦',
             release: false,
@@ -36,0 +36,0 @@ title: 'Continuous Integrations'

package.json

 {
   "private": false,
   "name": "git-cz-emoji",
-  "version": "1.1.17",
+  "version": "1.1.18",
   "description": "Commitizen configuration that follows the Conventional Changelog format with emoji support",
@@ -20,6 +20,8 @@ "license": "MIT",
   "files": [
-    "dist"
+    "dist",
+    "lib"
   ],
   "scripts": {
     "build": "task npm:build:tsconfig",
+    "bump": "npm run build && npm version patch --no-commit-hooks --no-git-tag-version --force && npm publish",
     "help": "task --menu",
@@ -47,6 +49,7 @@ "prepare": "task common:husky",
     "@washingtondc/development": "latest",
+    "cz-emoji-conventional": "^1.0.1",
     "esbuild": "^0.12.29",
     "esbuild-node-externals": "^1.3.0",
     "eslint-config-strict-mode": "latest",
-    "git-cz-emoji": "^1.1.15",
+    "git-cz-emoji": "latest",
     "glob": "^7.2.0",
@@ -142,9 +145,9 @@ "handlebars-helpers": "^0.10.0",
       "require-unicode-regexp": "warn",
+      "security/detect-object-injection": "warn",
       "sonarjs/cognitive-complexity": "warn",
       "sonarjs/no-nested-template-literals": "warn",
       "unicorn/consistent-destructuring": "warn",
-      "unicorn/prefer-module": "warn",
-      "security/detect-object-injection": "warn",
       "unicorn/import-style": "warn",
       "unicorn/no-array-reduce": "warn",
+      "unicorn/prefer-module": "warn",
       "unicorn/prevent-abbreviations": "warn",
@@ -234,2 +237,3 @@ "yml/sort-keys": "warn"
       "build": "Builds the project using the build command specified under scripts in package.json",
+      "bump": "Used to quickly build, increase the package.json version, and publish the package",
       "help": "Display the Bodega Taskfile.yml interactive help menu",
@@ -236,0 +240,0 @@ "prepare": "A hook triggered by running npm install that runs logic such as installing pre-commit hooks",

README.md

@@ -32,4 +32,4 @@ <!-- ⚠️ This README has been generated from the file(s) ".config/docs/blueprint-readme-config.md" ⚠️--><div align="center">
 <div align="center">
-  <a href="https://www.npmjs.com/package/git-cz-emoji" title="Version 1.0.2" target="_blank">
-    <img alt="Version: 1.0.2" src="https://img.shields.io/badge/version-1.0.2-blue.svg?cacheSeconds=2592000&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQMAAABJtOi3AAAABlBMVEUAAAD///+l2Z/dAAAAAXRSTlMAQObYZgAAACNJREFUCNdjIACY//+BEp9hhM3hAzYQwoBIAqEDYQrCZLwAAGlFKxU1nF9cAAAAAElFTkSuQmCC&style=flat-square" />
+  <a href="https://www.npmjs.com/package/git-cz-emoji" title="Version 1.1.16" target="_blank">
+    <img alt="Version: 1.1.16" src="https://img.shields.io/badge/version-1.1.16-blue.svg?cacheSeconds=2592000&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQMAAABJtOi3AAAABlBMVEUAAAD///+l2Z/dAAAAAXRSTlMAQObYZgAAACNJREFUCNdjIACY//+BEp9hhM3hAzYQwoBIAqEDYQrCZLwAAGlFKxU1nF9cAAAAAElFTkSuQmCC&style=flat-square" />
   </a>
@@ -69,5 +69,6 @@ <a href="https://gitlab.com/megabyte-labs/npm/configs/git-cz-emoji/-/commits/master" title="GitLab CI build status" target="_blank">
 - [Preview](#preview)
+- [Format](#format)
 - [Installation](#installation)
-  - [Globally](#globally)
-  - [Locally](#locally)
+  - [Installing Globally](#installing-globally)
+  - [Installing Locally](#installing-locally)
 - [Usage](#usage)
@@ -111,16 +112,25 @@ - [Contributing](#contributing)
 
-After you set this configuration up, when you do `git commit` you will be prompted with a menu like the one below. It will prompt you for the type of commit, ask for a subject, and a few other options. The whole process guides your commits and your repository's users commits to come out consistently in such a way that you can generate automated CHANGELOG.md files. **[semantic-release-config](https://github.com/ProfessorManhattan/semantic-release-config)** and **[conventional-changelog-emoji-config](https://github.com/ProfessorManhattan/conventional-changelog-emoji-config)** rely on this Commitizen configuration to generate commit messages that are in a consistent format.
+After you set this configuration up, when you do `git commit` you will be prompted with an interactive menu. It will prompt you for the type of commit, ask for a subject, and a few other options. The whole process guides your commits and your repository's users commits to come out consistently in such a way that you can generate automated CHANGELOG.md files. **[semantic-release-config](https://github.com/ProfessorManhattan/semantic-release-config)** and **[conventional-changelog-emoji-config](https://github.com/ProfessorManhattan/conventional-changelog-emoji-config)** rely on this Commitizen configuration to generate commit messages that are in a consistent format.
 
-```shell
- Select the type of change that you're committing: (Use arrow keys)
-❯ ✨  Feat:              Introducing new features.
-  🐛  Bug:               Fixing a bug.
-  📝  Docs:              Writing docs.
-  🎨  Style:             Improving structure / format of the code.
-  💄  UI:                Updating the UI and style files.
-  🚑  Quickfix:          Critical hotfix.
-  ⚡️  Pref:              Improving performance.
-(Move up and down to reveal more choices)
+Some of your commit message titles may look something like:
+
+```md
+- ✨ feat: add signup pages from (#11)
+- 🐛 fix(test): get browser width for android devices
+- ♻️ refactor(sc): refactor to styled component
+- 🧪 test: add test for splitmerge
 ```
 
+<a href="#format" style="width:100%"><img style="width:100%" src="https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png" /></a>
+
+## Format
+
+Format of the commit is below:
+
+```text
+[emoji] [type]([scope]): [commit msg] (#[issue number])
+```
+
+_Note:_ `scope` & `issue number` are optional.
+
 <a href="#installation" style="width:100%"><img style="width:100%" src="https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png" /></a>
@@ -132,3 +142,3 @@
 
-### Globally
+### Installing Globally
 
@@ -147,3 +157,3 @@ You can install this library globally and have it run on all projects using the following method. First, install the package globally:
 
-### Locally
+### Installing Locally
 
@@ -150,0 +160,0 @@ To install the library locally (so that the configuration is portable with your repository), add it to your `devDependencies` by running:

No alert changes

Improved metrics

Total package byte prevSize

54741

increased by1.21%

Lines of code

675

increased by0.45%

Number of lines in readme file

218

increased by4.81%

Worsened metrics

Dev dependency count

13

increased by8.33%

No dependency changes