standard-changelog 4.0.0 → 6.0.0

package/README.md

@@ -33,7 +33,7 @@ $ npm install --save standard-changelog
 ```
 
 ```js
-var standardChangelog = require('standard-changelog');
+import standardChangelog from 'standard-changelog';
 
 standardChangelog()
   .pipe(process.stdout); // or any writable stream

package/{cli.mjs → cli.js}

@@ -1,25 +1,50 @@
 #!/usr/bin/env node
-import {
-  createReadStream,
-  createWriteStream
-} from 'fs'
+import { resolve, extname } from 'path'
+import { pathToFileURL } from 'url'
+import { createWriteStream } from 'fs'
 import {
   readFile,
-  rm
+  writeFile
 } from 'fs/promises'
-import { resolve } from 'path'
-import { pathToFileURL } from 'url'
-import { Readable } from 'stream'
-import addStream from 'add-stream'
 import pc from 'picocolors'
-import tempfile from 'tempfile'
 import meow from 'meow'
-import standardChangelog from './index.js'
+import standardChangelog, {
+  createIfMissing,
+  checkpoint
+} from './index.js'
 
 function relativeResolve (filePath) {
   return pathToFileURL(resolve(process.cwd(), filePath))
 }
 
+async function loadDataFile (filePath) {
+  const resolvedFilePath = relativeResolve(filePath)
+  const ext = extname(resolvedFilePath.toString())
+
+  if (ext === '.json') {
+    return JSON.parse(await readFile(resolvedFilePath, 'utf8'))
+  }
+
+  return (await import(resolvedFilePath)).default
+}
+
+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
@@ -116,61 +141,39 @@ if (flags.verbose) {
 
 let templateContext
 
-function outputError (err) {
-  if (flags.verbose) {
-    console.error(pc.gray(err.stack))
-  } else {
-    console.error(pc.red(err.toString()))
-  }
-  process.exit(1)
-}
-
 try {
   if (flags.context) {
-    templateContext = JSON.parse(await readFile(relativeResolve(flags.context), 'utf8'))
+    templateContext = await loadDataFile(flags.context)
   }
 } catch (err) {
-  outputError(err)
+  printError(err)
 }
 
 const changelogStream = standardChangelog(options, templateContext, flags.commitPath ? { path: flags.commitPath } : {})
-  .on('error', (err) => {
-    outputError(err)
-  })
 
-standardChangelog.createIfMissing(infile)
-
-let readStream = null
-if (releaseCount !== 0) {
-  readStream = createReadStream(infile)
-    .on('error', (err) => {
-      outputError(err)
-    })
-} else {
-  readStream = new Readable()
-  readStream.push(null)
-}
+await createIfMissing(infile)
 
 if (options.append) {
-  changelogStream
-    .pipe(createWriteStream(outfile, {
-      flags: 'a'
-    }))
-    .on('finish', () => {
-      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(createWriteStream(tmp))
-    .on('finish', () => {
-      createReadStream(tmp)
-        .pipe(createWriteStream(outfile))
-        .on('finish', () => {
-          standardChangelog.checkpoint('output changes to %s', [outfile])
-          rm(tmp, { recursive: true })
-        })
-    })
+  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,17 @@
+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'
+}
+
+export const tick = isUnicodeSupported() ? '✔' : '√'

package/index.js

@@ -1,33 +1,27 @@
-'use strict'
+import fs from 'fs/promises'
+import pc from 'picocolors'
+import conventionalChangelogCore from 'conventional-changelog-core'
+import angular from 'conventional-changelog-angular'
+import { tick } from './figures.js'
 
-const conventionalChangelogCore = require('conventional-changelog-core')
-const angular = require('conventional-changelog-angular')
-const fs = require('fs')
-const pc = require('picocolors')
-const figures = require('figures')
-const sprintf = require('sprintf-js').sprintf
-
-function conventionalChangelog (options, context, gitRawCommitsOpts, parserOpts, writerOpts) {
+export default function conventionalChangelog (options, context, gitRawCommitsOpts, parserOpts, writerOpts) {
   options = options || {}
   options.config = angular
+
   return conventionalChangelogCore(options, context, gitRawCommitsOpts, parserOpts, writerOpts)
 }
 
-conventionalChangelog.createIfMissing = function (infile) {
+export async function createIfMissing (infile) {
   try {
-    fs.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(pc.green(figures.tick) + ' ' + sprintf(msg, args.map(function (arg) {
-    return pc.bold(arg)
-  })))
+export function checkpoint (msg, args) {
+  console.info(`${pc.green(tick)} ${msg}`, ...args.map(arg => pc.bold(arg)))
 }
-
-module.exports = conventionalChangelog

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "standard-changelog",
-  "version": "4.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": "6.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,23 +21,20 @@
     "changelog",
     "log"
   ],
-  "license": "MIT",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
+  "bin": "cli.js",
+  "exports": "./index.js",
   "files": [
     "index.js",
-    "cli.mjs"
+    "figures.js",
+    "cli.js"
   ],
   "dependencies": {
-    "add-stream": "^1.0.0",
-    "figures": "^3.2.0",
-    "meow": "^12.0.1",
+    "meow": "^13.0.0",
     "picocolors": "^1.0.0",
-    "sprintf-js": "^1.1.2",
-    "tempfile": "^5.0.0",
-    "conventional-changelog-core": "^6.0.0",
-    "conventional-changelog-angular": "^7.0.0"
-  },
-  "bin": "cli.mjs"
+    "conventional-changelog-angular": "^8.0.0",
+    "conventional-changelog-core": "^8.0.0"
+  }
 }