conventional-release-setup - npm Package Compare versions

Comparing version 1.2.2 to 2.0.0

package.json

 {
   "name": "conventional-release-setup",
-  "version": "1.2.2",
+  "version": "2.0.0",
   "description": "Sets up package for committing/releasing with conventional commits.",
   "author": "Mark <[e-mail]>",
-  "bin": "index.js",
+  "bin": "lib/index.js",
   "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf lib",
     "lint": "eslint --ignore-path .gitignore .",
     "lint:fix": "npm run lint -- --fix",
+    "lint:tsc": "tsc --noEmit",
     "_postinstall": "husky install",
     "postpublish": "pinst --enable",
-    "prepublishOnly": "pinst --disable"
+    "prepublishOnly": "pinst --disable && npm run lint && npm run test:ci && npm run clean && npm run build",
+    "test": "jest -u",
+    "test:ci": "CI=true jest --ci --colors --coverage"
   },
@@ -27,16 +32,22 @@ "repository": {
   "devDependencies": {
-    "@commitlint/cli": "^17.0.2",
-    "@commitlint/config-conventional": "^17.0.2",
-    "eslint": "^8.17.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.0",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@types/jest": "^29.5.4",
+    "@typescript-eslint/eslint-plugin": "^6.5.0",
+    "@typescript-eslint/parser": "^6.5.0",
+    "eslint": "^8.48.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "husky": "^8.0.3",
+    "jest": "^29.6.4",
+    "lint-staged": "^14.0.1",
     "pinst": "^3.0.0",
-    "prettier": "^2.6.2"
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
   },
   "files": [
     "/files",
-    "/index.js"
+    "/lib"
   ],
   "license": "MIT"
 }

README.md

@@ -7,2 +7,3 @@ # conventional-release-setup
 [![build](https://github.com/remarkablemark/conventional-release-setup/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablemark/conventional-release-setup/actions/workflows/build.yml)
+[![codecov](https://codecov.io/gh/remarkablemark/conventional-release-setup/graph/badge.svg?token=9U6TQRNAZ9)](https://codecov.io/gh/remarkablemark/conventional-release-setup)
 
@@ -15,29 +16,24 @@ Sets up an npm project for committing and releasing with [Conventional Commits](https://www.conventionalcommits.org/):
 
-## Install
+## Usage
 
-Install the CLI globally:
+Run the CLI:
 
 ```sh
-# with npm
-npm install --global conventional-release-setup
-
-# with yarn
-yarn global add conventional-release-setup
+npx conventional-release-setup
 ```
 
-## Usage
+Or install the CLI globally and run:
 
-If the CLI is installed globally, you can execute it in the command-line:
-
 ```sh
+npm install --global conventional-release-setup
 conventional-release-setup
 ```
 
-Otherwise, you can install and execute the CLI like so:
+If you want to release with [standard-version](https://www.npmjs.com/package/standard-version), then use v1:
 
 ```sh
-npx conventional-release-setup
+npx conventional-release-setup@1
 ```
 
-## Explanation
+## What It Does
 
@@ -55,8 +51,8 @@ The script:
   - [husky](https://www.npmjs.com/package/husky) - sets up git hooks
-  - [standard-version](https://www.npmjs.com/package/standard-version) - generates changelog, bumps version, and creates git commit and tag
-- copies the config:
+- copies the configs:
+  - [.github/workflows/release-please.yml](https://github.com/google-github-actions/release-please-action) - generates changelog, bumps version, and creates git commit, tag, and release
   - [.commitlintrc.json](https://github.com/remarkablemark/conventional-release-setup/blob/master/files/.commitlintrc.json)
 - adds husky hook `commit-msg`
 
-If the package is not `private`, the script also:
+If the package is not `private`, then the script:
 
@@ -71,48 +67,6 @@ - updates `package.json` scripts:
 
-If `-alpha` is appended to your `package.json` version:
+Release is automated with [Release Please](https://github.com/google-github-actions/release-please-action).
 
-```json
-{
-  "version": "1.0.0-alpha"
-}
-```
-
-You can run a release like so:
-
-```sh
-npm run release # npx standard-version --no-verify
-```
-
-Otherwise, you can [release as a target type imperatively](https://github.com/conventional-changelog/standard-version#release-as-a-target-type-imperatively-npm-version-like):
-
-```sh
-npx standard-version --release-as 1.0.0
-```
-
-Or if you want to use the current version as your [first release](https://github.com/conventional-changelog/standard-version#first-release):
-
-```sh
-npx standard-version --first-release
-```
-
-## Lint
-
-Lint files:
-
-```sh
-npm run lint
-```
-
-Fix lint errors:
-
-```sh
-npm run lint:fix
-```
-
-## Release
-
-Release and publish are automated by [Release Please](https://github.com/googleapis/release-please).
-
 ## License
 
 [MIT](https://github.com/remarkablemark/conventional-release-setup/blob/master/LICENSE)

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

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

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11064

increased by25.54%

Number of package files

8

increased by60%

Lines of code

176

increased by24.82%

Worsened metrics

Dev dependency count

14

increased by75%

Number of lines in readme file

69

decreased by-40%

Number of low supply chain risk alerts

3

increased by50%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes