chore: upgrade cli-style

.github/workflows/dhis2-verify-commits.yml

@@ -0,0 +1,38 @@
+name: 'dhis2: verify (commits)'
+
+on:
+    pull_request:
+        types: ['opened', 'edited', 'reopened', 'synchronize']
+
+jobs:
+    lint-pr-title:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+                  cache: 'yarn'
+            - run: yarn install --frozen-lockfile
+            - id: commitlint
+              run: echo ::set-output name=config_path::$(node -e "process.stdout.write(require('@dhis2/cli-style').config.commitlint)")
+            - uses: JulienKode/[email protected]
+              with:
+                  configuration-path: ${{ steps.commitlint.outputs.config_path }}
+
+    lint-commits:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 16
+                  cache: 'yarn'
+            - run: yarn install --frozen-lockfile
+            - id: commitlint
+              run: echo ::set-output name=config_path::$(node -e "process.stdout.write(require('@dhis2/cli-style').config.commitlint)")
+            - uses: wagoid/commitlint-github-action@v5
+              with:
+                  configFile: ${{ steps.commitlint.outputs.config_path }}

package.json

@@ -11,8 +11,8 @@
     ],
     "license": "BSD-3-Clause",
     "devDependencies": {
-        "@dhis2/cli-style": "^9.0.1",
-        "@dhis2/cli-utils-docsite": "^3.1.2",
+        "@dhis2/cli-style": "^10.5.1",
+        "@dhis2/cli-utils-docsite": "^3.2.0",
         "tape": "^4.13.2",
         "tape-await": "^0.1.2"
     },
@@ -26,5 +26,8 @@
             "name": "DHIS2 CLI",
             "description": "A unified CLI for DHIS2 development workflows."
         }
+    },
+    "resolutions": {
+        "@ls-lint/ls-lint": "2.0.1"
     }
 }

packages/app/src/commands/i18n.js

@@ -2,5 +2,5 @@ const { namespace } = require('@dhis2/cli-helpers-engine')
 
 module.exports = namespace('i18n', {
     description: 'Handle translations in apps',
-    builder: yargs => yargs.commandDir('i18n'),
+    builder: (yargs) => yargs.commandDir('i18n'),
 })

packages/app/src/helpers/modernize/checkRequirements.js

@@ -43,7 +43,7 @@ const checkMainTranslationFilePresent = (
     primaryLanguage,
     translationFiles
 ) => {
-    const mainTranslationFile = translationFiles.find(file =>
+    const mainTranslationFile = translationFiles.find((file) =>
         file.match(`i18n_module_${primaryLanguage}.properties`)
     )
     const mainTranslationFilePath = path.join(inDir, mainTranslationFile)

packages/app/src/helpers/modernize/createNewTranslationFiles.js

@@ -115,7 +115,7 @@ const createNewTranslationFiles = ({
                     } else {
                         newContents += `msgid ""\n`
                         const newLines = splitTranslation(originalTranslation)
-                        newLines.forEach(translationPart => {
+                        newLines.forEach((translationPart) => {
                             newContents += `"${unescape(translationPart)}"\n`
                         })
                     }
@@ -125,7 +125,7 @@ const createNewTranslationFiles = ({
                     } else {
                         newContents += `msgstr ""\n`
                         const newLines = splitTranslation(translation)
-                        newLines.forEach(translationPart => {
+                        newLines.forEach((translationPart) => {
                             newContents += `"${unescape(translationPart)}"\n`
                         })
                     }

packages/app/src/helpers/modernize/deleteLegacyFiles.js

@@ -8,7 +8,7 @@ const { reporter } = require('@dhis2/cli-helpers-engine')
  * @returns {void}
  */
 const deleteLegacyFiles = ({ translationFiles, languagesToTransform }) => {
-    translationFiles.forEach(file => {
+    translationFiles.forEach((file) => {
         const language = file.replace(/i18n_module_|.properties/g, '')
 
         if (

packages/app/src/helpers/modernize/generateTranslationMappings.js

@@ -21,7 +21,7 @@ const generateTranslationMappings = ({
         })
         const lines = contents
             .split('\n')
-            .filter(line => line !== '' && !line[0].match(/\s*#/))
+            .filter((line) => line !== '' && !line[0].match(/\s*#/))
 
         if (
             languagesToTransform.length &&

packages/app/src/helpers/modernize/getTemplates.js

@@ -1,7 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 
-const getTemplateMainLanguage = creationDate => {
+const getTemplateMainLanguage = (creationDate) => {
     const template = fs.readFileSync(
         path.join(__dirname, 'main_language.template'),
         { encoding: 'utf8' }

packages/app/src/helpers/modernize/getTranslationFileNames.js

@@ -2,9 +2,9 @@ const fs = require('fs')
 const {
     checkIODirectories,
     checkMainTranslationFilePresent,
-} = require('./checkRequirements')
+} = require('./checkRequirements.js')
 
-const fileIsOldTranslationFile = fileName => fileName.match(/\.properties$/)
+const fileIsOldTranslationFile = (fileName) => fileName.match(/\.properties$/)
 
 /**
  * @param {Object} args

packages/app/src/helpers/modernize/splitTranslation.js

@@ -7,7 +7,7 @@ const LENGTH_TO_SPLIT_LINE_AT = 77
  * The translation needs to be split by whitespaces first in order to create the
  * correct structure of the new translation
  */
-const splitTranslation = translation =>
+const splitTranslation = (translation) =>
     translation.split(' ').reduce((parts, curSplit) => {
         const latestPart = parts[parts.length - 1]
         const latestPartEscaped = escape(latestPart)
@@ -27,7 +27,7 @@ const splitTranslation = translation =>
             return parts
         }
 
-        curSplitEscaped.match(/.{1,76}(?=(%5Cu))?/g).forEach(escapedSplit => {
+        curSplitEscaped.match(/.{1,76}(?=(%5Cu))?/g).forEach((escapedSplit) => {
             parts.push(unescape(escapedSplit))
         })
 

packages/app/src/index.js

@@ -2,7 +2,7 @@ const { namespace, createModuleLoader } = require('@dhis2/cli-helpers-engine')
 
 module.exports = namespace('app', {
     description: 'Front-end application and library commands',
-    builder: yargs => {
+    builder: (yargs) => {
         const loader = createModuleLoader({
             parentModule: __filename,
         })

packages/cluster/src/commands/compose.js

@@ -6,13 +6,13 @@ const {
     makeComposeProject,
     makeEnvironment,
     resolveConfiguration,
-} = require('../common')
+} = require('../common.js')
 
 const run = async function (argv) {
     const { name, _ } = argv
     const cfg = await resolveConfiguration(argv)
 
-    const args = _.slice(_.findIndex(x => x === 'compose') + 1)
+    const args = _.slice(_.findIndex((x) => x === 'compose') + 1)
     reporter.debug('Passing arguments to docker-compose', args)
 
     const cacheLocation = await initDockerComposeCache({

packages/cluster/src/commands/db.js

@@ -2,7 +2,7 @@ const { namespace } = require('@dhis2/cli-helpers-engine')
 
 const command = namespace('db', {
     desc: 'Manage the database in a DHIS2 Docker cluster',
-    builder: yargs =>
+    builder: (yargs) =>
         yargs.commandDir('db_cmds').parserConfiguration({
             'parse-numbers': false,
         }),

packages/cluster/src/commands/db_cmds/backup.js

@@ -1,6 +1,9 @@
 const { reporter, tryCatchAsync } = require('@dhis2/cli-helpers-engine')
-const { initDockerComposeCache, resolveConfiguration } = require('../../common')
-const { backup } = require('../../helpers/db')
+const {
+    initDockerComposeCache,
+    resolveConfiguration,
+} = require('../../common.js')
+const { backup } = require('../../helpers/db.js')
 
 const run = async function (argv) {
     const { name, getCache, path, fat } = argv

packages/cluster/src/commands/db_cmds/restore.js

@@ -1,6 +1,9 @@
 const { reporter, tryCatchAsync } = require('@dhis2/cli-helpers-engine')
-const { initDockerComposeCache, resolveConfiguration } = require('../../common')
-const { restore } = require('../../helpers/db')
+const {
+    initDockerComposeCache,
+    resolveConfiguration,
+} = require('../../common.js')
+const { restore } = require('../../helpers/db.js')
 
 const run = async function (argv) {
     const { name, getCache } = argv

packages/cluster/src/commands/down.js

@@ -6,7 +6,7 @@ const {
     makeComposeProject,
     makeEnvironment,
     cleanCache,
-} = require('../common')
+} = require('../common.js')
 
 const run = async function (argv) {
     const { name, clean, getCache } = argv

packages/cluster/src/commands/list.js

@@ -1,8 +1,8 @@
 const { reporter, exec, chalk } = require('@dhis2/cli-helpers-engine')
 const Table = require('cli-table3')
-const { makeComposeProject, listClusters } = require('../common')
+const { makeComposeProject, listClusters } = require('../common.js')
 
-const getStatus = async cluster =>
+const getStatus = async (cluster) =>
     // TODO: check the status of the other services, not just `core`
     await exec({
         cmd: 'docker',
@@ -18,7 +18,7 @@ const getStatus = async cluster =>
         captureOut: true,
     })
 
-const formatStatus = status => {
+const formatStatus = (status) => {
     status = status.trim()
 
     if (status.length === 0) {
@@ -49,7 +49,7 @@ const run = async function (argv) {
     })
 
     await Promise.all(
-        clusters.map(async cluster => {
+        clusters.map(async (cluster) => {
             const status = await getStatus(cluster)
             table.push([
                 chalk.blue(cluster.name),

packages/cluster/src/commands/logs.js

@@ -10,7 +10,7 @@ const {
     makeComposeProject,
     makeEnvironment,
     resolveConfiguration,
-} = require('../common')
+} = require('../common.js')
 
 const run = async function (argv) {
     const { service, name } = argv

packages/cluster/src/commands/restart.js

@@ -10,8 +10,8 @@ const {
     makeComposeProject,
     makeEnvironment,
     resolveConfiguration,
-} = require('../common')
-const defaults = require('../defaults')
+} = require('../common.js')
+const defaults = require('../defaults.js')
 
 const run = async function (argv) {
     const { name, service } = argv

packages/cluster/src/commands/status.js

@@ -1,5 +1,5 @@
 const { exec, reporter } = require('@dhis2/cli-helpers-engine')
-const { makeComposeProject } = require('../common')
+const { makeComposeProject } = require('../common.js')
 
 const run = async function ({ name, ...argv }) {
     try {

packages/cluster/src/commands/up.js

@@ -10,9 +10,9 @@ const {
     makeEnvironment,
     makeComposeProject,
     resolveConfiguration,
-} = require('../common')
-const defaults = require('../defaults')
-const { restore } = require('../helpers/db')
+} = require('../common.js')
+const defaults = require('../defaults.js')
+const { restore } = require('../helpers/db.js')
 
 const run = async function (argv) {
     const { name, seed, seedFile, update, getCache } = argv

packages/cluster/src/common.js

@@ -1,6 +1,6 @@
 const path = require('path')
 const { reporter } = require('@dhis2/cli-helpers-engine')
-const defaults = require('./defaults')
+const defaults = require('./defaults.js')
 
 const clusterDir = 'clusters'
 const dockerComposeCacheName = 'docker-compose'
@@ -111,10 +111,10 @@ function dockerImageUsingJib(version) {
 
     const segments = version
         .split('.')
-        .map(s => s.trim())
-        .filter(s => s.length > 0) // to remove empty segments we get with versions like "2."
-        .map(n => parseInt(n, 10))
-        .filter(n => !Number.isNaN(n))
+        .map((s) => s.trim())
+        .filter((s) => s.length > 0) // to remove empty segments we get with versions like "2."
+        .map((n) => parseInt(n, 10))
+        .filter((n) => !Number.isNaN(n))
     if (segments.length < 2) {
         throw new Error(
             `Invalid version format: '${version}'. Must be 'master' or '2.major.minor.patch'. 'patch' being optional.`
@@ -206,7 +206,7 @@ async function resolveConfiguration(argv = {}) {
 module.exports.cleanCache = async ({ cache, name }) =>
     await cache.purge(path.join(clusterDir, name))
 
-module.exports.makeEnvironment = cfg => {
+module.exports.makeEnvironment = (cfg) => {
     const env = {
         DHIS2_HOME: cfg.dhis2Home,
         DHIS2_CORE_NAME: cfg.name,
@@ -227,20 +227,23 @@ module.exports.makeEnvironment = cfg => {
 
 // This has to match the normalization done by docker-compose to reliably get container statuses
 //   from https://github.com/docker/compose/blob/c8279bc4db56f49cf2e2b80c8734ced1c418b856/compose/cli/command.py#L154
-const normalizeName = name => name.replace(/[^-_a-z0-9]/g, '')
+const normalizeName = (name) => name.replace(/[^-_a-z0-9]/g, '')
 
-module.exports.makeComposeProject = name => `d2-cluster-${normalizeName(name)}`
+module.exports.makeComposeProject = (name) =>
+    `d2-cluster-${normalizeName(name)}`
 
-module.exports.listClusters = async argv => {
+module.exports.listClusters = async (argv) => {
     const cache = argv.getCache()
 
     const exists = await cache.exists(clusterDir)
-    if (!exists) return []
+    if (!exists) {
+        return []
+    }
 
     const stat = await cache.stat(clusterDir)
     const promises = Object.keys(stat.children)
-        .filter(name => cache.exists(path.join(clusterDir, name)))
-        .map(name => resolveConfiguration({ name, getCache: argv.getCache }))
+        .filter((name) => cache.exists(path.join(clusterDir, name)))
+        .map((name) => resolveConfiguration({ name, getCache: argv.getCache }))
     return await Promise.all(promises)
 }
 

packages/cluster/src/helpers/db/backup.js

@@ -1,6 +1,6 @@
 const path = require('path')
 const { reporter, exec, chalk } = require('@dhis2/cli-helpers-engine')
-const { makeComposeProject } = require('../../common')
+const { makeComposeProject } = require('../../common.js')
 
 module.exports = async ({ cacheLocation, name, path: dbPath, fat }) => {
     const destinationFile = path.resolve(dbPath)

packages/cluster/src/helpers/db/index.js

@@ -1,2 +1,2 @@
-module.exports.backup = require('./backup')
-module.exports.restore = require('./restore')
+module.exports.backup = require('./backup.js')
+module.exports.restore = require('./restore.js')

packages/cluster/src/helpers/db/restore.js

@@ -1,6 +1,6 @@
 const path = require('path')
 const { reporter, exec, chalk } = require('@dhis2/cli-helpers-engine')
-const { makeComposeProject, substituteVersion } = require('../../common')
+const { makeComposeProject, substituteVersion } = require('../../common.js')
 
 const downloadDatabase = async ({ cache, dbVersion, update, url }) => {
     const ext = '.sql.gz' //dbUrl.endsWith('.gz') ? '.gz' : '.sql'

packages/cluster/src/index.js

@@ -3,7 +3,7 @@ const { namespace } = require('@dhis2/cli-helpers-engine')
 const command = namespace('cluster', {
     desc: 'Manage DHIS2 Docker clusters',
     aliases: 'c',
-    builder: yargs =>
+    builder: (yargs) =>
         yargs.commandDir('commands').parserConfiguration({
             'parse-numbers': false,
         }),