git-semver-tags 7.0.1 → 8.0.0

package/README.md

@@ -1,54 +1,65 @@
-#  [![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
+
+[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
+
+[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
 
-```js
-var gitSemverTags = require('git-semver-tags');
+Get all git semver tags of your repository in reverse chronological order.
 
-// gitSemverTags([options])
+*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.
 
-const tags = await gitSemverTags();
+## Install
 
-console.log(tags);
-//=> [ 'v2.0.0', 'v1.0.0' ]
+```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).
 
 ## 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

package/package.json

@@ -1,28 +1,23 @@
 {
   "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": {
     "name": "Steve Mao",
     "email": "maochenyan@gmail.com",
     "url": "https://github.com/stevemao"
   },
+  "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": [
     "git-semver-tags",
     "order",
@@ -31,11 +26,18 @@
     "git-tag",
     "git"
   ],
-  "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"
   }
 }

package/{cli.mjs → src/cli.js}

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import meow from 'meow'
-import gitSemverTags from './index.js'
+import { getSemverTags } from './index.js'
 
 const args = meow(`
   Usage
@@ -33,7 +33,7 @@ const args = meow(`
   }
 })
 
-const tags = await gitSemverTags({
+const tags = await getSemverTags({
   lernaTags: args.flags.lerna,
   package: args.flags.package,
   tagPrefix: args.flags.tagPrefix,

package/src/index.js

@@ -0,0 +1,42 @@
+import {
+  ConventionalGitClient,
+  packagePrefix
+} from '@conventional-changelog/git-client'
+
+function getFinalOptions (options = {}) {
+  if (options.package && !options.lernaTags) {
+    throw new Error('opts.package should only be used when running in lerna mode')
+  }
+
+  const finalOptions = {
+    cwd: options.cwd || process.cwd(),
+    prefix: options.lernaTags ? packagePrefix(options.package) : options.tagPrefix,
+    skipUnstable: options.skipUnstable
+  }
+
+  return finalOptions
+}
+
+/**
+ * Get semver tags from git.
+ * @param {*} options
+ * @param {string} [options.cwd=process.cwd()] - Current working directory to run git.
+ * @param {boolean} [options.lernaTags=false] - Extract lerna style tags.
+ * @param {string} [options.package] - Filter lerna style tags by package.
+ * @param {string} [options.tagPrefix] - Filter semver tags by prefix.
+ * @returns Semver tags.
+ */
+export async function getSemverTags (options = {}) {
+  const {
+    cwd,
+    ...finalOptions
+  } = getFinalOptions(options)
+  const client = new ConventionalGitClient(cwd)
+  const tags = []
+
+  for await (const tag of client.getSemverTags(finalOptions)) {
+    tags.push(tag)
+  }
+
+  return tags
+}

package/index.js

@@ -1,71 +0,0 @@
-const { exec } = require('child_process')
-const { valid: semverValid } = require('semver')
-
-const regex = /tag:\s*(.+?)[,)]/gi
-const cmd = 'git log --decorate --no-color --date-order'
-const unstableTagTest = /.+-\w+\.\d+$/
-
-function lernaTag (tag, pkg) {
-  if (pkg && !tag.startsWith(`${pkg}@`)) {
-    return false
-  }
-
-  return /^.+@[0-9]+\.[0-9]+\.[0-9]+(-.+)?$/.test(tag)
-}
-
-function gitSemverTags (opts = {}) {
-  return new Promise((resolve, reject) => {
-    const options = {
-      maxBuffer: Infinity,
-      cwd: process.cwd(),
-      ...opts
-    }
-
-    if (options.package && !options.lernaTags) {
-      throw new Error('opts.package should only be used when running in lerna mode')
-    }
-
-    exec(cmd, options, (err, data) => {
-      if (err) {
-        reject(err)
-        return
-      }
-
-      const tags = []
-      let match
-      let tag
-      let unprefixedTag
-
-      data.split('\n').forEach((decorations) => {
-        while ((match = regex.exec(decorations))) {
-          tag = match[1]
-
-          if (options.skipUnstable && unstableTagTest.test(tag)) {
-            // skip unstable tag
-            continue
-          }
-
-          if (options.lernaTags) {
-            if (lernaTag(tag, options.package)) {
-              tags.push(tag)
-            }
-          } else if (options.tagPrefix) {
-            if (tag.startsWith(options.tagPrefix)) {
-              unprefixedTag = tag.replace(options.tagPrefix, '')
-
-              if (semverValid(unprefixedTag)) {
-                tags.push(tag)
-              }
-            }
-          } else if (semverValid(tag)) {
-            tags.push(tag)
-          }
-        }
-      })
-
-      resolve(tags)
-    })
-  })
-}
-
-module.exports = gitSemverTags