up: upgrade dependencies and devDependencies

Author: isuke

.eslintrc

@@ -9,7 +9,8 @@
     "plugin:prettier/recommended"
   ],
   "parserOptions": {
-    "ecmaVersion": 2017
+    "ecmaVersion": "latest",
+    "sourceType": "module"
   },
   "rules": {
     "no-console": "off",

README.md

@@ -39,7 +39,7 @@ $ export EDITOR='subl -w'
 ### Init
 
 ```sh
-$ git consistent init
+$ git consistent --init
 Use Type? (Y/n): Y
 Use Emoji? (y/N): N
 Does the subject start with lower case? (Y/n): Y
@@ -311,6 +311,7 @@ Date:   Sat Feb 10 15:13:40 2018 +0900
 | `-D, --dry-run`     | run dry-run mode          |
 | `-i, --interactive` | run interactive mode      |
 | `-S, --silent`      | don't show commit command |
+| `-I, --init`        | generate config files     |
 | `-V, --version`     | output the version number |
 
 ## Badges

lib/colors.js

@@ -8,7 +8,7 @@ const _cyan = '\u001b[36m'
 const _white = '\u001b[37m'
 const reset = '\u001b[0m'
 
-module.exports = {
+export default {
   success: green,
   warning: yellow,
   info: magenta,

lib/gen-config.js

@@ -1,12 +1,17 @@
-const path = require('path')
-const fs = require('fs')
-const _ = require('lodash')
-const prompt = require('prompt-sync')()
-const inquirer = require('inquirer')
-const csvParse = require('csv-parse/lib/sync')
-const yaml = require('js-yaml')
+import path from 'path'
+import fs from 'fs'
+import _ from 'lodash'
+import promptSync from 'prompt-sync'
+import inquirer from 'inquirer'
+import yaml from 'js-yaml'
+import url from 'url'
+import { parse as csvParse } from 'csv-parse/sync'
 
-const colors = require('./colors')
+import colors from './colors.js'
+
+const prompt = promptSync()
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 const getMaxLength = (types, headName) => {
   return _(types)
@@ -149,7 +154,7 @@ const generateDefinitionsFile = (definitionsFileName, answers, dryRun = false) =
     },
   }
 
-  writeFile(path.join('.', definitionsFileName), yaml.safeDump(content), dryRun)
+  writeFile(path.join('.', definitionsFileName), yaml.dump(content), dryRun)
 }
 
 const promptBool = (text, defaultValue = true) => {
@@ -198,10 +203,12 @@ const writeFile = (path, text, dryRun = false) => {
 //
 // Main
 //
-module.exports = async (program, templateFileName, definitionsFileName) => {
+export default async (program, templateFileName, definitionsFileName) => {
+  const options = program.opts()
+
   await inquirer.prompt(createQuestions()).then((answers) => {
-    generateTemplateFile(templateFileName, answers, program.dryRun)
-    generateDefinitionsFile(definitionsFileName, answers, program.dryRun)
+    generateTemplateFile(templateFileName, answers, options.dryRun)
+    generateDefinitionsFile(definitionsFileName, answers, options.dryRun)
 
     console.log()
     console.log(`${colors.success}Generated '${templateFileName}' and '${definitionsFileName}'.${colors.reset}`)

lib/index.js

@@ -1,20 +1,21 @@
 #!/usr/bin/env node
 
-const program = require('commander')
-const path = require('path')
-const fs = require('fs')
-const _ = require('lodash')
-const execSync = require('child_process').execSync
-const yaml = require('js-yaml')
-
-const colors = require('./colors')
-const main = require('./main')
-const genConfig = require('./gen-config')
-const pk = require('../package.json')
+import path from 'path'
+import fs from 'fs'
+import _ from 'lodash'
+import yaml from 'js-yaml'
+import { Command } from 'commander'
+import { execSync } from 'child_process'
+
+import colors from './colors.js'
+import main from './main.js'
+import genConfig from './gen-config.js'
 
 const templateFileName = '.gitcommit_template'
 const definitionsFileName = '.git_consistent'
 
+const program = new Command()
+const pk = JSON.parse(fs.readFileSync('./package.json'))
 const version = pk.version
 
 //
@@ -35,18 +36,16 @@ const getFilePath = (filePaths, fileName) => {
 }
 
 const loadYaml = (path) => {
-  return yaml.safeLoad(fs.readFileSync(path, 'utf8'))
+  return yaml.load(fs.readFileSync(path, 'utf8'))
 }
 
 const setCustomOptions = (program, definitions) => {
-  program.option('', '---- custom options ----')
   _.forEach(definitions, (definition, term) => {
     const optionName = term == 'subject' ? `-m, --${term}` : `--${term}`
     const valueStr = definition.required ? `<${term}>` : `[${term}]`
     const defaultValue = definition.default
     if (!['variable', 'branch'].includes(definition.type)) program.option(`${optionName} ${valueStr}`, definition.description, defaultValue)
   })
-  program.option('', '---- custom options ----')
 }
 
 const showErrorMessageAndExit = (e) => {
@@ -92,6 +91,7 @@ program
   .option('-D, --dry-run', 'run dry-run mode')
   .option('-i, --interactive', 'run interactive mode')
   .option('-S, --silent', "don't show commit command")
+  .option('-I, --init', 'generate config files')
   .on('--help', () => {
     console.log('')
     console.log('File Paths:')
@@ -100,15 +100,7 @@ program
   })
   .version(version)
 
-program
-  .command('init')
-  .description('generate config files')
-  .option('-D, --dry-run', 'run dry-run mode')
-  .action(() => {
-    /* no-op */
-  })
-
-if (process.argv[2] === 'init') {
+if (['-I', '--init'].includes(process.argv[2])) {
   runInit(program)
 } else if (['-h', '--help'].includes(process.argv[2])) {
   runHelp(program, definitionsFilePath)

lib/main.js

@@ -1,9 +1,9 @@
-const _ = require('lodash')
-const execSync = require('child_process').execSync
-const inquirer = require('inquirer')
-const emoji = require('node-emoji')
+import _ from 'lodash'
+import inquirer from 'inquirer'
+import emoji from 'node-emoji'
+import { execSync } from 'child_process'
 
-const colors = require('./colors')
+import colors from './colors.js'
 
 //
 // Functions
@@ -171,29 +171,29 @@ const createQuestion = (definition, term) => {
   }
 }
 
-const createQuestions = (program, definitions) => {
+const createQuestions = (options, definitions) => {
   return _(definitions)
     .map((definition, term) => {
-      if (!_.isUndefined(program[term]) || !_.isUndefined(definition.default)) return
+      if (!_.isUndefined(options[term]) || !_.isUndefined(definition.default)) return
       return createQuestion(definitions[term], term)
     })
     .compact()
     .value()
 }
 
-const getValue = (program, definition, answer, term) => {
+const getValue = (options, definition, answer, term) => {
   const val = branchText(definition)
 
   switch (definition.type) {
     case 'enum':
     case 'string':
     case 'text':
-      if (!_.isUndefined(program[term])) return program[term]
+      if (!_.isUndefined(options[term])) return options[term]
       if (!_.isUndefined(answer)) return answer
       if (!_.isUndefined(definition.default)) return definition.default
       return ''
     case 'variable':
-      if (!_.isUndefined(program[definition.origin])) return program[definition.origin]
+      if (!_.isUndefined(options[definition.origin])) return options[definition.origin]
       return ''
     case 'branch':
       if (!_.isUndefined(val)) return val
@@ -203,17 +203,16 @@ const getValue = (program, definition, answer, term) => {
   }
 }
 
-const replaceTerms = async (program, template, definitions, callback) => {
+const replaceTerms = async (options, template, definitions, callback) => {
   await inquirer
-    .prompt(createQuestions(program, definitions))
+    .prompt(createQuestions(options, definitions))
     .then((answers) => {
       let result = template
       _.forEach(definitions, (definition, term) => {
         const answer = answers[term]
-        const value = getValue(program, definition, answer, term).trim()
-
-        program[term] = value
+        const value = getValue(options, definition, answer, term).trim()
 
+        options[term] = value
         const errorMessages = checkValue(term, value, definition)
         if (!_.isEmpty(errorMessages)) throw new Error(errorMessages)
 
@@ -256,10 +255,12 @@ const gitCommit = (commitMessage, duet = false, silent = false, dryRun = false)
 //
 // Main
 //
-module.exports = async (program, template, definitions) => {
-  if (!program.dryRun) checkAddedFile()
+export default async (program, template, definitions) => {
+  const options = program.opts()
+
+  if (!options.dryRun) checkAddedFile()
 
-  await replaceTerms(program, template, definitions, (commitMessage) => {
-    gitCommit(commitMessage.trim(), program.duet, program.silent, program.dryRun)
+  await replaceTerms(options, template, definitions, (commitMessage) => {
+    gitCommit(commitMessage.trim(), options.duet, options.silent, options.dryRun)
   })
 }

package.json

@@ -16,6 +16,7 @@
   "engines": {
     "node": "<=12"
   },
+  "type": "module",
   "bin": {
     "git-consistent": "./lib/index.js"
   },
@@ -26,21 +27,21 @@
     "test": "ava --verbose"
   },
   "dependencies": {
-    "commander": "4.1.1",
-    "csv-parse": "4.11.1",
-    "inquirer": "7.3.2",
-    "js-yaml": "3.14.0",
-    "lodash": "4.17.19",
-    "node-emoji": "1.10.0",
+    "commander": "9.4.1",
+    "csv-parse": "5.3.1",
+    "inquirer": "9.1.4",
+    "js-yaml": "4.1.0",
+    "lodash": "4.17.21",
+    "node-emoji": "1.11.0",
     "prompt-sync": "4.2.0"
   },
   "devDependencies": {
-    "ava": "3.10.1",
-    "eslint": "7.4.0",
-    "eslint-config-prettier": "6.11.0",
-    "eslint-plugin-prettier": "3.1.4",
-    "outdent": "0.7.1",
-    "prettier": "2.0.5",
-    "sinon": "9.0.2"
+    "ava": "4.3.3",
+    "eslint": "8.26.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "outdent": "0.8.0",
+    "prettier": "2.7.1",
+    "sinon": "14.0.1"
   }
 }

test/index.test.js

@@ -1,6 +1,9 @@
-const test = require('ava')
-const execSync = require('child_process').execSync
-const path = require('path')
+import test from 'ava'
+import path from 'path'
+import url from 'url'
+import { execSync } from 'child_process'
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
 test('--version', (t) => {
   const output = execSync(`${path.join(__dirname, '../lib/index.js')} --version`)

test/main.test.js

@@ -1,8 +1,8 @@
-const test = require('ava')
-const sinon = require('sinon')
-const outdent = require('outdent')
+import test from 'ava'
+import sinon from './../node_modules/sinon/pkg/sinon-esm.js'
+import outdent from 'outdent'
 
-const main = require('../lib/main')
+import main from './../lib/main.js'
 
 test.beforeEach((t) => {
   t.context.consoleStub = sinon.stub(console, 'log')
@@ -16,12 +16,15 @@ test('main : simple case', async (t) => {
   const type = 'feat'
   const subject = 'first commit'
   const body = `this is body`
-  const program = {
-    type: type,
-    subject: subject,
-    body: body,
-    dryRun: true,
-    silent: true,
+  const program = {}
+  program.opts = function () {
+    return {
+      type: type,
+      subject: subject,
+      body: body,
+      dryRun: true,
+      silent: true,
+    }
   }
   const template = outdent`
     <type>: <subject>