standard-changelog 5.0.0 → 7.0.0

package/README.md

@@ -1,15 +1,60 @@
-# Standard CHANGELOG
+# standard-changelog
 
-[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage Status][coverage-image]][coverage-url]
+[![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]
 
-> An opinionated approach to CHANGELOG generation using angular commit conventions.
+[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
+[package-url]: https://nodejs.org/api/esm.html
 
-## Quick Start
+[npm]: https://img.shields.io/npm/v/standard-changelog.svg
+[npm-url]: https://npmjs.com/package/standard-changelog
+
+[node]: https://img.shields.io/node/v/standard-changelog.svg
+[node-url]: https://nodejs.org
+
+[deps]: https://img.shields.io/librariesio/release/npm/standard-changelog
+[deps-url]: https://libraries.io/npm/standard-changelog/tree
+
+[size]: https://packagephobia.com/badge?p=standard-changelog
+[size-url]: https://packagephobia.com/result?p=standard-changelog
+
+[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
+
+An opinionated approach to CHANGELOG generation using angular commit conventions.
+
+<hr />
+<a href="#install">Install</a>
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+<a href="#usage">Usage</a>
+<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+<a href="#js-api">JS API</a>
+<br />
+<hr />
+
+## Install
+
+```bash
+# pnpm
+pnpm add standard-changelog
+# yarn
+yarn add standard-changelog
+# npm
+npm i standard-changelog
+```
+
+## Usage
 
 ```sh
-$ npm install -g standard-changelog
-$ cd my-project
-$ standard-changelog
+standard-changelog
 ```
 
 The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
@@ -19,46 +64,36 @@ The above generates a changelog based on commits since the last semver tag that
 If you're using this tool for the first time and want to generate new content in CHANGELOG.md, you can run:
 
 ```sh
-$ standard-changelog --first-release
+standard-changelog --first-release
 ```
 
 **advanced topics:**
 
-All available command line parameters can be listed using [CLI](#cli) : `standard-changelog --help`.
+All available command line parameters can be listed using CLI: `standard-changelog --help`.
 
-## Programmatic Usage
-
-```sh
-$ npm install --save standard-changelog
-```
+## JS API
 
 ```js
-var standardChangelog = require('standard-changelog');
+import { StandardChangelog } from 'standard-changelog'
 
-standardChangelog()
-  .pipe(process.stdout); // or any writable stream
-```
+const generator = new StandardChangelog()
+  .readPackage()
 
-## CLI
+generator
+  .writeStream()
+  .pipe(process.stdout)
 
-```sh
-$ npm install -g standard-changelog
-$ standard-changelog --help
+// or
+
+for await (const chunk of generator.write()) {
+  console.log(chunk)
+}
 ```
 
-## API
+StandardChangelog is a class based on ConventionalChangelog and with preloaded angular preset.
 
-See the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) docs with the angular preset.
+See the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog/README.md#js-api) JS API docs.
 
 ## License
 
 MIT
-
-[npm-image]: https://badge.fury.io/js/standard-changelog.svg
-[npm-url]: https://npmjs.org/package/standard-changelog
-[travis-image]: https://travis-ci.org/conventional-changelog/standard-changelog.svg?branch=master
-[travis-url]: https://travis-ci.org/conventional-changelog/standard-changelog
-[daviddm-image]: https://david-dm.org/conventional-changelog/standard-changelog.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/conventional-changelog/standard-changelog
-[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,14 +1,18 @@
 {
   "name": "standard-changelog",
-  "version": "5.0.0",
-  "description": "Generate a changelog from git metadata with Angular commit convention",
-  "bugs": {
-    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
-  },
+  "type": "module",
+  "version": "7.0.0",
+  "description": "Generate a changelog from git metadata with Angular commit convention.",
+  "author": "Steve Mao",
+  "license": "MIT",
   "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/conventional-changelog/conventional-changelog.git"
+    "url": "https://github.com/conventional-changelog/conventional-changelog.git",
+    "directory": "packages/standard-changelog"
+  },
+  "bugs": {
+    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
   },
   "keywords": [
     "conventional-changelog",
@@ -17,20 +21,23 @@
     "changelog",
     "log"
   ],
-  "license": "MIT",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
+  },
+  "bin": {
+    "standard-changelog": "./dist/cli.js"
+  },
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js"
   },
   "files": [
-    "index.js",
-    "figures.js",
-    "cli.mjs"
+    "dist"
   ],
   "dependencies": {
-    "meow": "^12.0.1",
-    "picocolors": "^1.0.0",
-    "conventional-changelog-angular": "^7.0.0",
-    "conventional-changelog-core": "^7.0.0"
-  },
-  "bin": "cli.mjs"
+    "meow": "^13.0.0",
+    "@conventional-changelog/git-client": "^2.1.0",
+    "conventional-changelog-angular": "^8.0.0",
+    "conventional-changelog": "^7.0.0"
+  }
 }

package/cli.mjs

@@ -1,162 +0,0 @@
-#!/usr/bin/env node
-import { createWriteStream } from 'fs'
-import {
-  readFile,
-  writeFile
-} from 'fs/promises'
-import pc from 'picocolors'
-import meow from 'meow'
-import standardChangelog, {
-  createIfMissing,
-  checkpoint
-} from './index.js'
-
-function printError (err) {
-  if (flags.verbose) {
-    console.error(pc.gray(err.stack))
-  } else {
-    console.error(pc.red(err.toString()))
-  }
-
-  process.exit(1)
-}
-
-function waitStreamFinish (stream) {
-  return new Promise((resolve) => {
-    stream.on('finish', resolve)
-    stream.on('error', printError)
-  })
-}
-
-const cli = meow(`
-  Usage
-    standard-changelog
-
-  Options
-    -i, --infile              Read the CHANGELOG from this file
-    -f, --first-release       Generate the CHANGELOG for the first time
-    -o, --outfile             Write the CHANGELOG to this file. If unspecified (default: CHANGELOG.md)
-    -s, --same-file           Overwrite the infile (default: true)
-    -p, --preset              Name of the preset you want to use (default: angular)
-    -k, --pkg                 A filepath of where your package.json is located
-    -a, --append              Should the generated block be appended
-    -r, --release-count       How many releases to be generated from the latest
-    -v, --verbose             Verbose output
-    -c, --context             A filepath of a json that is used to define template variables
-    -l, --lerna-package       Generate a changelog for a specific lerna package (:pkg-name@1.0.0)
-    --commit-path             Generate a changelog scoped to a specific directory
-`, {
-  importMeta: import.meta,
-  booleanDefault: undefined,
-  flags: {
-    infile: {
-      shortFlag: 'i',
-      default: 'CHANGELOG.md',
-      type: 'string'
-    },
-    help: {
-      shortFlag: 'h'
-    },
-    outfile: {
-      shortFlag: 'o',
-      type: 'string'
-    },
-    sameFile: {
-      shortFlag: 's',
-      default: true,
-      type: 'boolean'
-    },
-    preset: {
-      shortFlag: 'p',
-      type: 'string'
-    },
-    pkg: {
-      shortFlag: 'k',
-      type: 'string'
-    },
-    append: {
-      shortFlag: 'a',
-      type: 'boolean'
-    },
-    releaseCount: {
-      shortFlag: 'r',
-      type: 'number'
-    },
-    verbose: {
-      shortFlag: 'v',
-      type: 'boolean'
-    },
-    context: {
-      shortFlag: 'c',
-      type: 'string'
-    },
-    firstRelease: {
-      shortFlag: 'f',
-      type: 'boolean'
-    },
-    lernaPackage: {
-      shortFlag: 'l',
-      type: 'string'
-    }
-  }
-})
-
-const flags = cli.flags
-const infile = flags.infile
-const sameFile = flags.sameFile
-const outfile = sameFile ? (flags.outfile || infile) : flags.outfile
-const append = flags.append
-const releaseCount = flags.firstRelease ? 0 : flags.releaseCount
-
-const options = {
-  preset: flags.preset,
-  pkg: {
-    path: flags.pkg
-  },
-  append,
-  releaseCount,
-  lernaPackage: flags.lernaPackage
-}
-
-if (flags.verbose) {
-  options.warn = console.warn.bind(console)
-}
-
-let templateContext
-
-try {
-  if (flags.context) {
-    templateContext = JSON.parse(await readFile(flags.context, 'utf8'))
-  }
-} catch (err) {
-  printError(err)
-}
-
-const changelogStream = standardChangelog(options, templateContext, flags.commitPath ? { path: flags.commitPath } : {})
-
-await createIfMissing(infile)
-
-if (options.append) {
-  await waitStreamFinish(
-    changelogStream
-      .pipe(createWriteStream(outfile, {
-        flags: 'a'
-      }))
-  )
-
-  checkpoint('appended changes to %s', [outfile])
-} else {
-  let changelog = ''
-
-  for await (const chunk of changelogStream) {
-    changelog += chunk.toString()
-  }
-
-  if (releaseCount !== 0) {
-    changelog += await readFile(infile, 'utf8')
-  }
-
-  await writeFile(outfile, changelog)
-
-  checkpoint('output changes to %s', [outfile])
-}

package/figures.js

@@ -1,19 +0,0 @@
-function isUnicodeSupported () {
-  if (process.platform !== 'win32') {
-    return process.env.TERM !== 'linux' // Linux console (kernel)
-  }
-
-  return Boolean(process.env.CI) ||
-    Boolean(process.env.WT_SESSION) || // Windows Terminal
-    Boolean(process.env.TERMINUS_SUBLIME) || // Terminus (<0.2.27)
-    process.env.ConEmuTask === '{cmd::Cmder}' || // ConEmu and cmder
-    process.env.TERM_PROGRAM === 'Terminus-Sublime' ||
-    process.env.TERM_PROGRAM === 'vscode' ||
-    process.env.TERM === 'xterm-256color' ||
-    process.env.TERM === 'alacritty' ||
-    process.env.TERMINAL_EMULATOR === 'JetBrains-JediTerm'
-}
-
-const tick = isUnicodeSupported() ? '✔' : '√'
-
-exports.tick = tick

package/index.js

@@ -1,31 +0,0 @@
-const fs = require('fs/promises')
-const pc = require('picocolors')
-const conventionalChangelogCore = require('conventional-changelog-core')
-const angular = require('conventional-changelog-angular')
-const { tick } = require('./figures')
-
-function conventionalChangelog (options, context, gitRawCommitsOpts, parserOpts, writerOpts) {
-  options = options || {}
-  options.config = angular
-
-  return conventionalChangelogCore(options, context, gitRawCommitsOpts, parserOpts, writerOpts)
-}
-
-async function createIfMissing (infile) {
-  try {
-    await fs.access(infile, fs.F_OK)
-  } catch (err) {
-    if (err.code === 'ENOENT') {
-      checkpoint('created %s', [infile])
-      await fs.writeFile(infile, '\n', 'utf-8')
-    }
-  }
-}
-
-function checkpoint (msg, args) {
-  console.info(`${pc.green(tick)} ${msg}`, ...args.map(arg => pc.bold(arg)))
-}
-
-module.exports = conventionalChangelog
-module.exports.createIfMissing = createIfMissing
-module.exports.checkpoint = checkpoint