feat: added test coverage

feat: rename to changescribe
removed: removed --includeCommit

.github/workflows/release.yml

@@ -32,7 +32,7 @@ jobs:
           scope: "@ctinnovation"
 
       - name: install dependencies
-        run: npm install -g @ctinnovation/changelogger
+        run: npm install -g changescribe
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_GET_TOKEN}}
 

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - "**"
+      - "!release**"
+    tags:
+      - "v**"
+
+  workflow_dispatch:
+    inputs:
+      logLevel:
+        description: "Log level"
+        required: true
+        default: "warning"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+
+      - uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - run: npm ci
+      - run: npm run test

.gitignore

@@ -108,3 +108,6 @@ PR-*
 KALI-*
 TEST-*
 CHANGELOG
+
+.tap
+!test/unreleased

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

README.md

@@ -129,7 +129,6 @@ Feel free to customize your template by modifying the templates inside `template
 | -p, --fromPackageJson    | Retrieve target version from pkg.json *(overrides `--targetVersion`)*     | [boolean] [default: false]                     |
 | -o, --output             | Ouput CHANGELOG file                                                      | [string] [default: process.pwd()/CHANGELOG.md] |
 | -i, --input              | Input folder for compiling the changelog                                  | [string] [default: process.pwd()/unreleased]   |
-| --includeCommits         | Include branch commits in new release                                     | [boolean] [default: false]                     |
 | -u, --taskUrlTemplate    | Associated task URL template. *Mandatory if `--excludeTaskList` is false* | [string] [required]                            |
 | --excludeTaskList        | Exclude tasks list after release title                                    | [boolean] [default: false]                     |
 | --createOutputIfNotFound | Create a new output file if not found                                     | [boolean] [default: true]                      |

commands/explore/argv.js

@@ -31,17 +31,15 @@ const argvBuilder = function argvBuilder (yargs) {
     .default('input', defaults.input)
     .describe('input', 'Input CHANGELOG for explore diffs')
     .check((args) => {
-      const { range, output } = args
-      if (!range) {
-        throw new Error('Should provide a range!')
-      }
+      const { output } = args
 
-      if (output !== 'console' && !fs.lstatSync(output).isDirectory()) {
-        throw new Error('You must provide a folder as --output, not a file path!')
+      if (output !== 'console' && (!fs.existsSync(output) || !fs.lstatSync(output).isDirectory())) {
+        throw new Error('You must provide a valid and existing folder as --output!')
       }
 
       return true // tell Yargs that the arguments passed the check
     })
+    .demandOption('range')
     .help()
 }
 

commands/explore/handler.js

@@ -66,20 +66,21 @@ async function handler (argv) {
   const pkgPath = path.join(targetRoot, 'package.json')
   let name = 'Unknown'
   if (!fs.existsSync(pkgPath)) {
-    console.warning('Unable to find a valid package.json to retrieve the name from!')
+    console.warn('Unable to find a valid package.json to retrieve the name from!')
   } else {
     name = require(pkgPath).name
   }
   const changelogInputPath = path.isAbsolute(argv.input)
     ? argv.input
     : path.resolve(targetRoot, argv.input)
 
-  const lines = fs.readFileSync(changelogInputPath, 'utf-8')
-
-  if (!lines) {
+  const exists = fs.existsSync(changelogInputPath)
+  if (!exists) {
     throw new Error(`File ${argv.input} not found`)
   }
 
+  const lines = fs.readFileSync(changelogInputPath, 'utf-8')
+
   let min
   let max
   // extract the bounds of the versions
@@ -102,6 +103,7 @@ async function handler (argv) {
       max = splittedVersions[0]
     }
   // any other input
+  /* c8 ignore next 5 */
   } else {
     console.error('Error in the inserted range.')
     console.log('Closing the tool.')

commands/generate/argv.js

@@ -5,9 +5,8 @@ const COMMAND_DEFAULTS = {
   fromPackageJson: false,
   output: path.resolve(process.cwd(), './CHANGELOG.md'),
   input: path.resolve(process.cwd(), './unreleased'),
-  includeCommits: false,
   excludeTaskList: false,
-  createOutputIfNotFound: false
+  createOutputIfNotFound: true
 }
 
 const argvBuilder = function argvBuilder (yargs) {
@@ -37,9 +36,6 @@ const argvBuilder = function argvBuilder (yargs) {
     .alias('input', 'i')
     .default('input', defaults.input)
     .describe('input', 'Input folder for compiling the changelog')
-    .boolean('includeCommits')
-    .default('includeCommits', defaults.includeCommits)
-    .describe('includeCommits', 'Include branch commits in new release')
     .boolean('excludeTaskList')
     .default('excludeTaskList', defaults.excludeTaskList)
     .describe('excludeTaskList', 'Exclude tasks list after release title')
@@ -56,14 +52,14 @@ const argvBuilder = function argvBuilder (yargs) {
         throw new Error('Should provide --targetVersion or use the --fromPackageJson flag!')
       }
 
-      if (!taskUrlTemplate.includes('{taskCode}')) {
-        throw new Error('Should provide a URL that contains `{taskCode}`!')
-      }
-
       if (!excludeTaskList && !taskUrlTemplate) {
         throw new Error('Should provide --taskUrlTemplate when --excludeTaskList is false!')
       }
 
+      if (!excludeTaskList && !taskUrlTemplate.includes('{taskCode}')) {
+        throw new Error('Should provide a URL that contains `{taskCode}`!')
+      }
+
       return true // tell Yargs that the arguments passed the check
     })
     .help()

commands/generate/handler.js

@@ -6,8 +6,8 @@ const {
   Handlebars, versionTemplate, taskTemplate, headerTemplate
 } = require('../../helpers/hbs')
 const { verifyTargetVersion } = require('../../helpers/semver')
-const { VERSION_LINE_REGEX, UNRELEASED_LINE_REGEX, URL_TASK_REGEX } = require('../../helpers/regexprs')
-const { createVersionIndex, createCommitSummary, parseTaskFile } = require('../../helpers/md')
+const { VERSION_LINE_REGEX, UNRELEASED_LINE_REGEX } = require('../../helpers/regexprs')
+const { createVersionIndex, parseTaskFile } = require('../../helpers/md')
 
 async function handler (argv) {
   const targetRoot = path.resolve(process.cwd(), '.')
@@ -47,13 +47,6 @@ async function handler (argv) {
     }
   }
 
-  // check taskUrlTemplate
-  const urlRegexCheck = new RegExp(URL_TASK_REGEX)
-  if (!urlRegexCheck.test(argv.taskUrlTemplate)) {
-    console.error('The inserted URL is not supported: the tools accepts valid URL that contains the keyword {taskCode}.')
-    process.exit(1)
-  }
-
   if (!changelogExists && !argv.createOutputIfNotFound) {
     console.error(`Missing file ${changelogPath} and option createOutputIfNotFound set to false.`)
     console.log('Unable to continue. The tool will be shut down.')
@@ -91,11 +84,6 @@ async function handler (argv) {
   const tempChangelog = `${changelogPath}-temp-${new Date().getTime()}`
   const writeStream = fs.createWriteStream(tempChangelog)
 
-  writeStream.on('error', (e) => {
-    console.error(e)
-    process.exit(1)
-  })
-
   // write header template
   const header = Handlebars.compile(headerTemplate)({
     index: createVersionIndex(targetVersion, oldChangelogBody)
@@ -119,7 +107,7 @@ async function handler (argv) {
     const taskBody = fs.readFileSync(fullPath, 'utf-8')
 
     tasks.push(taskCode)
-    const urlTask = argv.taskUrlTemplate.replace('{taskCode}', taskCode)
+    const urlTask = (argv.taskUrlTemplate || '').replace('{taskCode}', taskCode)
     finalSectionMap = parseTaskFile(taskCode, taskBody, urlTask, finalSectionMap)
   })
 
@@ -144,15 +132,10 @@ async function handler (argv) {
       writeStream.write('\n')
     })
 
-  if (argv.includeCommits) {
-    writeStream.write('\n##### Commit history\n\n')
-    const commitSummary = await createCommitSummary()
-    writeStream.write(commitSummary)
-  }
-
   writeStream.on('finish', () => {
     // write on the final changelog file
     fs.copyFile(tempChangelog, changelogPath, (err) => {
+      /* c8 ignore next 4 */
       if (err) {
         console.error(err)
         process.exit(1)

commands/init/handler.js

@@ -19,12 +19,6 @@ async function handler (argv) {
   }
 
   const writeStream = fs.createWriteStream(changelogPath)
-
-  writeStream.on('error', (e) => {
-    console.error(e)
-    process.exit(1)
-  })
-
   // write header template
   const header = Handlebars.compile(headerTemplate)({})
   writeStream.write(header)

helpers/md.js

@@ -1,14 +1,8 @@
-const git = require('simple-git')({
-  baseDir: process.cwd(),
-  binary: 'git'
-})
-
 const { Handlebars, versionTemplate, lineCodeTemplate } = require('./hbs')
 const {
   VERSION_LINE_REGEX,
   TASK_SECTION_REGEX,
   SUBSECTION_TITLE_REGEX,
-  upperFirst,
   matchesToArray,
   SUBSECTION_POINT_REGEX,
   matchSectionTitle
@@ -104,17 +98,7 @@ function createVersionIndex (targetVersion, currentChangelog) {
   return result
 }
 
-async function createCommitSummary () {
-  const commits = await git.log({
-    from: 'main'
-  })
-  return commits.all
-    .map((c) => ` * ${c.message}`)
-    .join('\n')
-}
-
 module.exports = {
   createVersionIndex,
-  createCommitSummary,
   parseTaskFile
 }

helpers/regexprs.js

@@ -8,15 +8,10 @@ const ADDED_REGEX = /add(ed)?|created?/gi
 const REMOVED_REGEX = /removed?|cancel(led)?/gi
 const REFACTORED_REGEX = /refactor(ed)?/gi
 const SUBSECTION_POINT_REGEX = /( )*- .+(?:\n|$)/gi
-const URL_TASK_REGEX = /^(http(s):\/\/.)[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}([-a-zA-Z0-9@:%_\+.~#?&//=]*.{taskCode}[^\s]+)/
 const EXTRACT_VERSION = /\n+## \[(\d+\.\d+\.\d+)\] - \d{4}-\d{2}-\d{2}\n+/g
 const REMOVE_TASK_BADGES = /\[(.*?)\]\((.*?)\)\]/g
 const REMOVE_TASK_LINK = /( ‧ \[.*?\]\(.*?\))/g
 
-function upperFirst (string = '') {
-  return `${string.charAt(0).toUpperCase()}${string.substr(1).toLowerCase()}`
-}
-
 function matchSectionTitle (currentTitle) {
   if (currentTitle.match(CHANGED_REGEX)) {
     return 'Changed'
@@ -37,6 +32,7 @@ function matchSectionTitle (currentTitle) {
 }
 
 function matchesToArray (regex, string) {
+  /* c8 ignore next */
   regex.lastIndex = 0
   const result = []
   let next = regex.exec(string)
@@ -54,15 +50,13 @@ module.exports = {
   TASK_SECTION_REGEX,
   SUBSECTION_TITLE_REGEX,
   SUBSECTION_POINT_REGEX,
-  upperFirst,
   matchesToArray,
   CHANGED_REGEX,
   FIXED_REGEX,
   ADDED_REGEX,
   REMOVED_REGEX,
   REFACTORED_REGEX,
   matchSectionTitle,
-  URL_TASK_REGEX,
   EXTRACT_VERSION,
   REMOVE_TASK_BADGES,
   REMOVE_TASK_LINK

helpers/semver.js

@@ -10,12 +10,14 @@ function verifyTargetVersion (targetVersion, currentChangelog) {
     currentChangelog
   )
 
+  /* c8 ignore next 2 */
   if (!versionMatches || !versionMatches[1]) {
     return
   }
 
   const lastVersion = versionMatches[1]
 
+  /* c8 ignore next 4 */
   if (!semver.valid(lastVersion)) {
     console.error('Last version is not a valid semver version!', `[${lastVersion}]`)
     process.exit(1)