git-semver-tags - npm Package Compare versions

Comparing version 7.0.1 to 8.0.0

package.json

 {
   "name": "git-semver-tags",
-  "version": "7.0.1",
-  "description": "Get all git semver tags of your repository in reverse chronological order",
-  "bugs": {
-    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
-  },
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-semver-tags#readme",
+  "type": "module",
+  "version": "8.0.0",
+  "description": "Get all git semver tags of your repository in reverse chronological order.",
   "author": {
@@ -14,14 +11,12 @@ "name": "Steve Mao",
   },
+  "license": "MIT",
+  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-semver-tags#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-semver-tags"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=16"
+  "bugs": {
+    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
   },
-  "files": [
-    "index.js",
-    "cli.mjs"
-  ],
   "keywords": [
@@ -35,9 +30,16 @@ "git-semver-tags",
   ],
-  "dependencies": {
-    "meow": "^12.0.1",
-    "semver": "^7.5.2"
+  "engines": {
+    "node": ">=18"
   },
   "bin": {
-    "git-semver-tags": "cli.mjs"
+    "git-semver-tags": "./src/cli.js"
+  },
+  "exports": "./src/index.js",
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "meow": "^13.0.0",
+    "@conventional-changelog/git-client": "^1.0.0"
   }
 }

README.md

@@ -1,41 +0,62 @@
-#  [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
+# git-semver-tags
 
-> Get all git semver tags of your repository in reverse chronological order
+[![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]
 
-*Note:* since lightweight tags do not store date information, the date of a tag is the date of the commit that is tagged on. If two tags on one commit, the order is not guaranteed.
+[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
+[package-url]: https://nodejs.org/api/esm.html
 
+[npm]: https://img.shields.io/npm/v/git-semver-tags.svg
+[npm-url]: https://npmjs.com/package/git-semver-tags
 
-## Install
+[node]: https://img.shields.io/node/v/git-semver-tags.svg
+[node-url]: https://nodejs.org
 
-```sh
-$ npm install --save git-semver-tags
-```
+[deps]: https://img.shields.io/librariesio/release/npm/git-semver-tags
+[deps-url]: https://libraries.io/npm/git-semver-tags/tree
 
-## Usage
+[size]: https://packagephobia.com/badge?p=git-semver-tags
+[size-url]: https://packagephobia.com/result?p=git-semver-tags
 
-```js
-var gitSemverTags = require('git-semver-tags');
+[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
 
-// gitSemverTags([options])
+[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
 
-const tags = await gitSemverTags();
+Get all git semver tags of your repository in reverse chronological order.
 
-console.log(tags);
-//=> [ 'v2.0.0', 'v1.0.0' ]
+*Note:* since lightweight tags do not store date information, the date of a tag is the date of the commit that is tagged on. If two tags on one commit, the order is not guaranteed.
+
+## Install
+
+```bash
+# pnpm
+pnpm add git-semver-tags
+# yarn
+yarn add git-semver-tags
+# npm
+npm i git-semver-tags
 ```
 
-```sh
-$ npm install --global git-semver-tags
-$ git-semver-tags
-v2.0.0
-v1.0.0
+## CLI
+
+```bash
+# Example
+git-semver-tags
+# Output:
+# v2.0.0
+# v1.0.0
+# For more details
+git-semver-tags --help
 ```
 
-## Options
+## API
 
-* `opts.lernaTags`: extract lerna style tags (`foo-package@2.0.0`) from the
-  git history, rather than `v1.0.0` format.
-* `opts.package`: what package should lerna style tags be listed for, e.g.,
-  `foo-package`.
-* `opts.tagPrefix`: specify a prefix for the git tag to be ignored from the semver checks
+For JS API see [@conventional-changelog/git-client](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-client).
 
@@ -45,11 +66,1 @@ ## License
 MIT © [Steve Mao](https://github.com/stevemao)
-
-
-[npm-image]: https://badge.fury.io/js/git-semver-tags.svg
-[npm-url]: https://npmjs.org/package/git-semver-tags
-[travis-image]: https://travis-ci.org/conventional-changelog/git-semver-tags.svg?branch=master
-[travis-url]: https://travis-ci.org/conventional-changelog/git-semver-tags
-[daviddm-image]: https://david-dm.org/stevemao/git-semver-tags.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/stevemao/git-semver-tags
-[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

Number of lines in readme file

66

increased by20%

Is type module

Yes

Worsened metrics

Total package byte prevSize

6400

decreased by-3.12%

Lines of code

76

decreased by-22.45%

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)

• - Removedsemver@^7.5.2

• - Removedmeow@12.1.1(transitive)

• Updatedmeow@^13.0.0