git-raw-commits - npm Package Compare versions

Comparing version 4.0.0 to 5.0.0

package.json

 {
   "name": "git-raw-commits",
-  "version": "4.0.0",
-  "description": "Get raw git commits out of your repository using git-log(1)",
-  "bugs": {
-    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
-  },
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits#readme",
+  "type": "module",
+  "version": "5.0.0",
+  "description": "Get raw git commits out of your repository using git-log(1).",
   "author": {
@@ -14,14 +11,12 @@ "name": "Steve Mao",
   },
+  "license": "MIT",
+  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/conventional-changelog/conventional-changelog.git"
+    "url": "https://github.com/conventional-changelog/conventional-changelog.git",
+    "directory": "packages/git-raw-commits"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=16"
+  "bugs": {
+    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
   },
-  "files": [
-    "index.js",
-    "cli.mjs"
-  ],
   "keywords": [
@@ -36,10 +31,16 @@ "git-raw-commits",
   ],
-  "dependencies": {
-    "dargs": "^8.0.0",
-    "meow": "^12.0.1",
-    "split2": "^4.0.0"
+  "engines": {
+    "node": ">=18"
   },
   "bin": {
-    "git-raw-commits": "cli.mjs"
+    "git-raw-commits": "./src/cli.js"
+  },
+  "exports": "./src/index.js",
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "meow": "^13.0.0",
+    "@conventional-changelog/git-client": "^1.0.0"
   }
 }

README.md

@@ -1,101 +0,60 @@
-#  [![NPM version][npm-image]][npm-url] [![Build Status: Linux][travis-image]][travis-url] [![Build Status: Windows][appveyor-image]][appveyor-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
+# git-raw-commits
 
-> Get raw git commits out of your repository using git-log(1)
+[![ESM-only package][package]][package-url]
+[![NPM version][npm]][npm-url]
+[![Node version][node]][node-url]
+[![Dependencies status][deps]][deps-url]
+[![Install size][size]][size-url]
+[![Build status][build]][build-url]
+[![Coverage status][coverage]][coverage-url]
 
+[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
+[package-url]: https://nodejs.org/api/esm.html
 
-## Install
+[npm]: https://img.shields.io/npm/v/git-raw-commits.svg
+[npm-url]: https://npmjs.com/package/git-raw-commits
 
-```sh
-$ npm install --save git-raw-commits
-```
+[node]: https://img.shields.io/node/v/git-raw-commits.svg
+[node-url]: https://nodejs.org
 
+[deps]: https://img.shields.io/librariesio/release/npm/git-raw-commits
+[deps-url]: https://libraries.io/npm/git-raw-commits/tree
 
-## Usage
+[size]: https://packagephobia.com/badge?p=git-raw-commits
+[size-url]: https://packagephobia.com/result?p=git-raw-commits
 
-```js
-var gitRawCommits = require('git-raw-commits');
+[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
+[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
 
-gitRawCommits(options)
-  .pipe(...);
-```
+[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
+[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
 
+Get raw git commits out of your repository using git-log(1).
 
-## API
+## Install
 
-### gitRawCommits(gitOpts, [execOpts])
+```bash
+# pnpm
+pnpm add git-raw-commits
+# yarn
+yarn add git-raw-commits
+# npm
+npm i git-raw-commits
+```
 
-Returns a readable stream. Stream is split to break on each commit.
-
-#### gitOpts
-
-Type: `object`
-
-Please check the available options at http://git-scm.com/docs/git-log.
-**NOTE:** Single dash arguments are not supported because of https://github.com/sindresorhus/dargs/blob/master/index.js#L5.
-
-*NOTE*: for `<revision range>` we can also use `<from>..<to>` pattern, and this module has the following extra options for shortcut of this pattern:
-
-##### gitOpts.from
-
-Type: `string` Default: `''`
-
-##### gitOpts.to
-
-Type: `string` Default: `'HEAD'`
-
-This module also have the following additions:
-
-##### gitOpts.format
-
-Type: `string` Default: `'%B'`
-
-Please check http://git-scm.com/docs/git-log for format options.
-
-##### gitOpts.debug
-
-Type: `function`
-
-A function to get debug information.
-
-##### gitOpts.path
-
-Type: `string` or `array`
-
-Filter commits to the path(s) provided.
-
-##### execOpts
-
-Options to pass to `git` `childProcess`
-
-Type: `object`
-
-##### execOpts.cwd
-
-Type: `string`
-
-Current working directory to execute git in
-
-
 ## CLI
 
-```sh
-$ npm install --global git-raw-commits
-$ git-raw-commits --help # for more details
+```bash
+# Example
+git-raw-commits --from HEAD~2 --to HEAD^
+# For more details
+git-raw-commits --help
 ```
 
+## API
 
+For JS API see [@conventional-changelog/git-client](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-client).
+
 ## License
 
 MIT © [Steve Mao](https://github.com/stevemao)
-
-
-[npm-image]: https://badge.fury.io/js/git-raw-commits.svg
-[npm-url]: https://npmjs.org/package/git-raw-commits
-[travis-image]: https://travis-ci.org/conventional-changelog/git-raw-commits.svg?branch=master
-[travis-url]: https://travis-ci.org/conventional-changelog/git-raw-commits
-[appveyor-image]: https://ci.appveyor.com/api/projects/status/4qm3bjmg41k3dsbv/branch/master?svg=true
-[appveyor-url]: https://ci.appveyor.com/project/stevemao/git-raw-commits/branch/master
-[daviddm-image]: https://david-dm.org/conventional-changelog/git-raw-commits.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/conventional-changelog/git-raw-commits
-[coverage-image]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
-[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

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

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

Improved metrics

Dependency count

2

decreased by-33.33%

Is type module

Yes

Worsened metrics

Total package byte prevSize

6842

decreased by-12.94%

Lines of code

86

decreased by-20.37%

Number of lines in readme file

61

decreased by-40.2%

Dependency changes

• + Added@conventional-changelog/git-client@^1.0.0

• + Added@conventional-changelog/git-client@1.0.1(transitive)

• + Added@types/semver@7.5.8(transitive)

• + Addedmeow@13.2.0(transitive)

• + Addedsemver@7.6.3(transitive)

• - Removeddargs@^8.0.0

• - Removedsplit2@^4.0.0

• - Removeddargs@8.1.0(transitive)

• - Removedmeow@12.1.1(transitive)

• - Removedsplit2@4.2.0(transitive)

• Updatedmeow@^13.0.0