standard-changelog 3.0.0 → 5.0.0

package/README.md

@@ -48,7 +48,7 @@ $ standard-changelog --help
 
 ## API
 
-See the [conventional-changelog](https://github.com/ajoslin/conventional-changelog) docs with the angular preset.
+See the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) docs with the angular preset.
 
 ## License
 

package/{cli.js → cli.mjs}

@@ -1,14 +1,32 @@
 #!/usr/bin/env node
-'use strict'
-const addStream = require('add-stream')
-const chalk = require('chalk')
-const standardChangelog = require('./')
-const fs = require('fs')
-const meow = require('meow')
-const tempfile = require('tempfile')
-const resolve = require('path').resolve
-const Readable = require('stream').Readable
-const rimraf = require('rimraf')
+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
@@ -28,55 +46,56 @@ const cli = meow(`
     -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: {
-      alias: 'i',
+      shortFlag: 'i',
       default: 'CHANGELOG.md',
       type: 'string'
     },
     help: {
-      alias: 'h'
+      shortFlag: 'h'
     },
     outfile: {
-      alias: 'o',
+      shortFlag: 'o',
       type: 'string'
     },
-    'same-file': {
-      alias: 's',
+    sameFile: {
+      shortFlag: 's',
       default: true,
       type: 'boolean'
     },
     preset: {
-      alias: 'p',
+      shortFlag: 'p',
       type: 'string'
     },
     pkg: {
-      alias: 'k',
+      shortFlag: 'k',
       type: 'string'
     },
     append: {
-      alias: 'a',
+      shortFlag: 'a',
       type: 'boolean'
     },
-    'release-count': {
-      alias: 'r',
+    releaseCount: {
+      shortFlag: 'r',
       type: 'number'
     },
     verbose: {
-      alias: 'v',
+      shortFlag: 'v',
       type: 'boolean'
     },
     context: {
-      alias: 'c',
+      shortFlag: 'c',
       type: 'string'
     },
-    'first-release': {
-      alias: 'f',
+    firstRelease: {
+      shortFlag: 'f',
       type: 'boolean'
     },
-    'lerna-package': {
-      alias: 'l',
+    lernaPackage: {
+      shortFlag: 'l',
       type: 'string'
     }
   }
@@ -94,8 +113,8 @@ const options = {
   pkg: {
     path: flags.pkg
   },
-  append: append,
-  releaseCount: releaseCount,
+  append,
+  releaseCount,
   lernaPackage: flags.lernaPackage
 }
 
@@ -105,61 +124,39 @@ if (flags.verbose) {
 
 let templateContext
 
-function outputError (err) {
-  if (flags.verbose) {
-    console.error(chalk.grey(err.stack))
-  } else {
-    console.error(chalk.red(err.toString()))
-  }
-  process.exit(1)
-}
-
 try {
   if (flags.context) {
-    templateContext = require(resolve(process.cwd(), flags.context))
+    templateContext = JSON.parse(await readFile(flags.context, 'utf8'))
   }
 } catch (err) {
-  outputError(err)
+  printError(err)
 }
 
 const changelogStream = standardChangelog(options, templateContext, flags.commitPath ? { path: flags.commitPath } : {})
-  .on('error', function (err) {
-    outputError(err)
-  })
 
-standardChangelog.createIfMissing(infile)
-
-let readStream = null
-if (releaseCount !== 0) {
-  readStream = fs.createReadStream(infile)
-    .on('error', function (err) {
-      outputError(err)
-    })
-} else {
-  readStream = new Readable()
-  readStream.push(null)
-}
+await createIfMissing(infile)
 
 if (options.append) {
-  changelogStream
-    .pipe(fs.createWriteStream(outfile, {
-      flags: 'a'
-    }))
-    .on('finish', function () {
-      standardChangelog.checkpoint('appended changes to %s', [outfile])
-    })
+  await waitStreamFinish(
+    changelogStream
+      .pipe(createWriteStream(outfile, {
+        flags: 'a'
+      }))
+  )
+
+  checkpoint('appended changes to %s', [outfile])
 } else {
-  const tmp = tempfile()
-
-  changelogStream
-    .pipe(addStream(readStream))
-    .pipe(fs.createWriteStream(tmp))
-    .on('finish', function () {
-      fs.createReadStream(tmp)
-        .pipe(fs.createWriteStream(outfile))
-        .on('finish', function () {
-          standardChangelog.checkpoint('output changes to %s', [outfile])
-          rimraf.sync(tmp)
-        })
-    })
+  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

@@ -0,0 +1,19 @@
+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,34 +1,31 @@
-'use strict'
-
+const fs = require('fs/promises')
+const pc = require('picocolors')
 const conventionalChangelogCore = require('conventional-changelog-core')
 const angular = require('conventional-changelog-angular')
-const fs = require('fs')
-const accessSync = require('fs-access').sync
-const chalk = require('chalk')
-const figures = require('figures')
-const sprintf = require('sprintf-js').sprintf
+const { tick } = require('./figures')
 
 function conventionalChangelog (options, context, gitRawCommitsOpts, parserOpts, writerOpts) {
   options = options || {}
   options.config = angular
+
   return conventionalChangelogCore(options, context, gitRawCommitsOpts, parserOpts, writerOpts)
 }
 
-conventionalChangelog.createIfMissing = function (infile) {
+async function createIfMissing (infile) {
   try {
-    accessSync(infile, fs.F_OK)
+    await fs.access(infile, fs.F_OK)
   } catch (err) {
     if (err.code === 'ENOENT') {
-      conventionalChangelog.checkpoint('created %s', [infile])
-      fs.writeFileSync(infile, '\n', 'utf-8')
+      checkpoint('created %s', [infile])
+      await fs.writeFile(infile, '\n', 'utf-8')
     }
   }
 }
 
-conventionalChangelog.checkpoint = function (msg, args) {
-  console.info(chalk.green(figures.tick) + ' ' + sprintf(msg, args.map(function (arg) {
-    return chalk.bold(arg)
-  })))
+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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "standard-changelog",
-  "version": "3.0.0",
+  "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"
@@ -19,26 +19,18 @@
   ],
   "license": "MIT",
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "files": [
     "index.js",
-    "cli.js"
+    "figures.js",
+    "cli.mjs"
   ],
   "dependencies": {
-    "add-stream": "^1.0.0",
-    "chalk": "^4.1.2",
-    "conventional-changelog-angular": "^6.0.0",
-    "conventional-changelog-core": "^5.0.0",
-    "figures": "^3.2.0",
-    "fs-access": "^1.0.1",
-    "meow": "^8.1.2",
-    "rimraf": "^3.0.2",
-    "sprintf-js": "^1.1.2",
-    "tempfile": "^3.0.0"
+    "meow": "^12.0.1",
+    "picocolors": "^1.0.0",
+    "conventional-changelog-angular": "^7.0.0",
+    "conventional-changelog-core": "^7.0.0"
   },
-  "bin": "cli.js",
-  "scripts": {
-    "test-windows": "echo 'make work on windows'"
-  }
+  "bin": "cli.mjs"
 }