standard-changelog 3.0.0 → 4.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,24 @@
 #!/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 {
+  createReadStream,
+  createWriteStream
+} from 'fs'
+import {
+  readFile,
+  rm
+} 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'
+
+function relativeResolve (filePath) {
+  return pathToFileURL(resolve(process.cwd(), filePath))
+}
 
 const cli = meow(`
   Usage
@@ -28,55 +38,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 +105,8 @@ const options = {
   pkg: {
     path: flags.pkg
   },
-  append: append,
-  releaseCount: releaseCount,
+  append,
+  releaseCount,
   lernaPackage: flags.lernaPackage
 }
 
@@ -107,23 +118,23 @@ let templateContext
 
 function outputError (err) {
   if (flags.verbose) {
-    console.error(chalk.grey(err.stack))
+    console.error(pc.gray(err.stack))
   } else {
-    console.error(chalk.red(err.toString()))
+    console.error(pc.red(err.toString()))
   }
   process.exit(1)
 }
 
 try {
   if (flags.context) {
-    templateContext = require(resolve(process.cwd(), flags.context))
+    templateContext = JSON.parse(await readFile(relativeResolve(flags.context), 'utf8'))
   }
 } catch (err) {
   outputError(err)
 }
 
 const changelogStream = standardChangelog(options, templateContext, flags.commitPath ? { path: flags.commitPath } : {})
-  .on('error', function (err) {
+  .on('error', (err) => {
     outputError(err)
   })
 
@@ -131,8 +142,8 @@ standardChangelog.createIfMissing(infile)
 
 let readStream = null
 if (releaseCount !== 0) {
-  readStream = fs.createReadStream(infile)
-    .on('error', function (err) {
+  readStream = createReadStream(infile)
+    .on('error', (err) => {
       outputError(err)
     })
 } else {
@@ -142,10 +153,10 @@ if (releaseCount !== 0) {
 
 if (options.append) {
   changelogStream
-    .pipe(fs.createWriteStream(outfile, {
+    .pipe(createWriteStream(outfile, {
       flags: 'a'
     }))
-    .on('finish', function () {
+    .on('finish', () => {
       standardChangelog.checkpoint('appended changes to %s', [outfile])
     })
 } else {
@@ -153,13 +164,13 @@ if (options.append) {
 
   changelogStream
     .pipe(addStream(readStream))
-    .pipe(fs.createWriteStream(tmp))
-    .on('finish', function () {
-      fs.createReadStream(tmp)
-        .pipe(fs.createWriteStream(outfile))
-        .on('finish', function () {
+    .pipe(createWriteStream(tmp))
+    .on('finish', () => {
+      createReadStream(tmp)
+        .pipe(createWriteStream(outfile))
+        .on('finish', () => {
           standardChangelog.checkpoint('output changes to %s', [outfile])
-          rimraf.sync(tmp)
+          rm(tmp, { recursive: true })
         })
     })
 }

package/index.js

@@ -3,8 +3,7 @@
 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 pc = require('picocolors')
 const figures = require('figures')
 const sprintf = require('sprintf-js').sprintf
 
@@ -16,7 +15,7 @@ function conventionalChangelog (options, context, gitRawCommitsOpts, parserOpts,
 
 conventionalChangelog.createIfMissing = function (infile) {
   try {
-    accessSync(infile, fs.F_OK)
+    fs.accessSync(infile, fs.F_OK)
   } catch (err) {
     if (err.code === 'ENOENT') {
       conventionalChangelog.checkpoint('created %s', [infile])
@@ -26,8 +25,8 @@ conventionalChangelog.createIfMissing = function (infile) {
 }
 
 conventionalChangelog.checkpoint = function (msg, args) {
-  console.info(chalk.green(figures.tick) + ' ' + sprintf(msg, args.map(function (arg) {
-    return chalk.bold(arg)
+  console.info(pc.green(figures.tick) + ' ' + sprintf(msg, args.map(function (arg) {
+    return pc.bold(arg)
   })))
 }
 

package/package.json

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