happy-conventional-commit - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

package.json

 {
 	"name": "happy-conventional-commit",
 	"description": "Tools for getting a happy conventional commit setup.",
-	"version": "0.0.4",
+	"version": "0.0.5",
 	"keywords": [
@@ -6,0 +6,0 @@ "conventional",

README.md

@@ -5,3 +5,3 @@ ![Happy Conventional Commit Logo](https://raw.githubusercontent.com/capricorn86/happy-conventional-commit/main/docs/logo.jpg)
 
-[Happy Conventional Commit](https://github.com/capricorn86/happy-conventional-commit) contains CLI scripts for working with [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+[Happy Conventional Commit](https://github.com/capricorn86/happy-conventional-commit) contains CLI scripts for working with [Conventional Commits](https://www.conventionalcommits.org/en/).
 
@@ -16,108 +16,11 @@ # Installation
 
-- [Current Version](#current-version)
-- [Next Version](#next-version)
-- [Release Notes](#release-notes)
-- [Validate Commit Message](#validate-commit-message)
-- [Lint Changed Files](#lint-changed-files)
+- [Current Version](https://github.com/capricorn86/happy-conventional-commit/wiki/Current-Version)
+- [Next Version](https://github.com/capricorn86/happy-conventional-commit/wiki/Next-Version)
+- [Release Notes](https://github.com/capricorn86/happy-conventional-commit/wiki/Release-Notes)
+- [Validate Commit Message](https://github.com/capricorn86/happy-conventional-commit/wiki/Validate-Commit-Message)
+- [Validate Pull Request Commit Messages](https://github.com/capricorn86/happy-conventional-commit/wiki/Validate-Pull-Request-Commit-Messages)
+- [Lint Changed Files](https://github.com/capricorn86/happy-conventional-commit/wiki/Lint-Changed-Files)
 
-# Usage
+# Contributing
 
-## Current Version
-
-```bash
-happy-current-version
-```
-
-## Next Version
-
-```bash
-happy-next-version
-```
-
-## Release Notes
-
-**Basic Usage**
-
-```bash
-happy-release-notes
-```
-
-**Pipe to file**
-
-```bash
-happy-release-notes > release-notes.md
-```
-
-### Arguments
-
-| Argument                                  | Description                                                                             | Default         |
-| ----------------------------------------- | --------------------------------------------------------------------------------------- | --------------- |
-| --from={version}                          | The version to generate release notes from.                                             | Latest version  |
-| --to={version}                            | The version to generate release notes to.                                               |                 |
-| --versionHeader                           | Set to show version header. Useful when generating release notes for multiple releases. |                 |
-| --author={githubUsername \| nameAndEmail} | Set to show author for each entry.                                                      |                 |
-
-## Validate Commit Message
-
-**Basic Usage**
-
-```bash
-happy-validate-commit-message --commitFile={commitFile}
-```
-
-**With Husky**
-
-1. Install [Husky](https://www.npmjs.com/package/husky)
-2. Create the file ".husky/commit-msg"
-3. Add the following to the file ".husky/commit-msg":
-   ```bash
-   #!/bin/sh
-   . "$(dirname "$0")/_/husky.sh"
-   node ./node_modules/.bin/happy-validate-commit-message --commitFile=$1
-   ```
-
-### Arguments
-
-| Argument                  | Description                             | Default |
-| ------------------------- | --------------------------------------- | ------- |
-| --commitFile={commitFile} | The file containing the commit message. |         |
-
-## Lint Changed Files
-
-**Basic Usage**
-
-```bash
-happy-lint-changed-files
-```
-
-**With Husky**
-
-1. Install [Husky](https://www.npmjs.com/package/husky)
-2. Create the file ".husky/pre-commit"
-3. Add the following to the file ".husky/pre-commit":
-   ```bash
-   #!/bin/sh
-   . "$(dirname "$0")/_/husky.sh"
-   node ./node_modules/.bin/happy-lint-changed
-   ```
-
-### Configuration
-
-Configurations are defined in `package.json`.
-
-#### Rules
-
-```json
-{
-  "happyLintChanged": {
-    "rules": [
-      {
-        "command": "eslint --ignore-path .lintignore --max-warnings 0 --fix",
-        "regex": "^[a-zA-Z0-9_].*\\.(cjs|mjs|js|jsx|ts|tsx|json)$"
-      }
-    ]
-  }
-}
-```
-
-_The rules defaults to the same as in the example above._
+See [Contributing Guide](https://github.com/capricorn86/happy-conventional-commit/blob/main/docs/contributing.md).

No alert changes

Improved metrics

Number of package files

47

increased by2.17%

Worsened metrics

Total package byte prevSize

122909

decreased by-0.77%

Number of lines in readme file

24

decreased by-80.33%

No dependency changes