create-juisy 2.0.0-beta.10

package/index.js

@@ -0,0 +1,162 @@
+#!/usr/bin/env node
+
+/**
+ * Create a new Juisy project
+ * @author Hervé Perchec
+ * @see https://github.com/hperchec/juisy
+ */
+
+import fs from 'node:fs'
+import path, { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import mri from 'mri'
+import { eject } from 'juisy'
+import { InterfaceUtils, OutputUtils } from 'juisy/cli'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+const {
+  run,
+  prompts
+} = InterfaceUtils
+
+const {
+  $style,
+  log,
+  step,
+  substep
+} = OutputUtils
+
+// Use `mri` library to parse command line arguments
+// Usage: npm create juisy <project-name> -- [--template|-t <template>] [--force|-f]
+const argv = mri(process.argv.slice(2), {
+  alias: { t: 'template', f: 'force' },
+  boolean: [ 'force' ],
+  string: [ 'template' ]
+})
+
+const cwd = process.cwd()
+
+// Get juisy version from this package.json file
+const { version: JUISY_VERSION } = JSON.parse(
+  fs.readFileSync(path.resolve(__dirname, './package.json'), 'utf-8')
+)
+
+const defaultTargetDir = 'juisy-project'
+
+const rmTrailingSlashes = str => str.trim().replace(/\/+$/g, '') // remove trailing slashes
+
+async function main () {
+  // Get target dir argument (optional)
+  let targetDir = argv._[0]
+    ? rmTrailingSlashes(String(argv._[0])) // remove trailing slashes
+    : undefined
+
+  let devConfigFormat = '.ts' // default is typescript config
+
+  // Project name (& directory name)
+  if (!targetDir) {
+    const promptsResult = await prompts([
+      {
+        type: 'text',
+        message: 'Project name (directory):',
+        initial: defaultTargetDir,
+        name: 'projectName'
+      }
+    ])
+    targetDir = rmTrailingSlashes(promptsResult.projectName)
+  }
+
+  // Dev config format
+  const promptsResult = await prompts([
+    {
+      type: 'select',
+      message: 'Dev config format:',
+      choices: [
+        { title: 'TypeScript', description: 'dev.config.ts', value: '.ts' },
+        { title: 'JavaScript', description: 'dev.config.js', value: '.js' },
+        { title: 'JSON', description: 'dev.config.json', value: '.json' }
+      ],
+      initial: 0,
+      name: 'devConfigFormat'
+    }
+  ])
+  devConfigFormat = promptsResult.devConfigFormat
+
+  /**
+   * Eject files from template
+   */
+  step('Copying files')
+
+  await eject(path.resolve(__dirname, './template'), '**/*', {
+    force: argv.force,
+    targetDir: path.resolve(cwd, targetDir),
+    ignoreFiles: [
+      'dev.config.ts',
+      'dev.config.js',
+      'dev.config.json'
+    ].filter(identifier => !identifier.endsWith(devConfigFormat)), // don't ignore dev config file of chosen format
+    logLevel: 'warn',
+    processor: (content, identifier) => {
+      if (identifier === 'package.json') {
+        return content.replace(/__JUISY_VERSION__/g, JUISY_VERSION)
+      } else {
+        return content
+      }
+    }
+  })
+
+  substep($style.green(`✔ Successfuly copied`), { last: true })
+  log() // Blank line
+
+  const targetCliCommand = 'node ./bin/cli'
+
+  /**
+   * Update package.json file
+   */
+  const scripts = {
+    'docs:api': `${targetCliCommand} docs generate -c ./docs/docs.config.js`,
+    'docs:readme': `${targetCliCommand} docs generate:readme`,
+    'docs:lint': `${targetCliCommand} docs lint`,
+    'docs:lint:fix': 'npm run docs:lint -- --fix',
+    'docs': 'npm run docs:readme && npm run docs:api && npm run docs:lint',
+    'lint': `${targetCliCommand} lint`,
+    'lint:fix': 'npm run lint -- --fix',
+    'lint:markdown': 'npm run docs:lint',
+    'lint:markdown:fix': 'npm run docs:lint:fix',
+    'release': `${targetCliCommand} release`,
+    'changelog': `${targetCliCommand} changelog`,
+    'git-hooks:reset': `${targetCliCommand} git-hooks reset`,
+    'git-hooks:sync': `${targetCliCommand} git-hooks sync`,
+    'test': `${targetCliCommand} test`
+  }
+
+  step('Adding scripts to package.json')
+  const pkg = JSON.parse(
+    fs.readFileSync(path.join(path.resolve(cwd, targetDir), 'package.json'), 'utf-8')
+  )
+  pkg.scripts = pkg.scripts || {}
+
+  for (const scriptName of Object.keys(scripts)) {
+    // Is script already defined?
+    const setScript = pkg.scripts[scriptName]
+      ? argv.force
+      : true
+    const isLastStep = scriptName === Object.keys(scripts)[Object.keys(scripts).length - 1]
+    if (setScript) {
+      await run('npm', [ 'set-script', scriptName, scripts[scriptName] ], { stdio: 'pipe', cwd: path.resolve(cwd, targetDir) })
+      substep($style.green(`✔ Script "${scriptName}" successfuly added`), { last: isLastStep })
+    } else {
+      substep($style.yellow(`Script "${scriptName}" already set. Use --force option to overwrite`), { last: isLastStep })
+    }
+  }
+
+  log() // Blank line
+  log('You should now move into the created folder and run the following command:\n  - npm install')
+  log() // Blank line
+  log('You can use feature of .env file by copying .env.example:\n  - cp .env.example .env')
+  log() // Blank line
+}
+
+main()

package/package.json

@@ -0,0 +1,63 @@
+{
+    "name": "create-juisy",
+    "version": "2.0.0-beta.10",
+    "description": "Juisy boilerplate for npm init",
+    "type": "module",
+    "bin": {
+        "create-juisy": "index.js"
+    },
+    "files": [
+        "template",
+        "index.js"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "release": "release-it",
+        "test": "echo No test found..."
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://gitlab.com/hperchec/juisy.git"
+    },
+    "keywords": [
+        "js",
+        "build",
+        "release",
+        "changelog",
+        "bin",
+        "cmd",
+        "easy"
+    ],
+    "author": {
+        "name": "Hervé Perchec",
+        "email": "contact@herve-perchec.com",
+        "url": "https://gitlab.com/herveperchec"
+    },
+    "license": "GPL-3.0-only",
+    "bugs": {
+        "url": "https://gitlab.com/hperchec/juisy/issues"
+    },
+    "homepage": "https://hperchec.gitlab.io/juisy",
+    "devDependencies": {
+        "juisy": "2.0.0-beta.10"
+    },
+    "dependencies": {
+        "execa": "^8",
+        "mri": "^1.2.0"
+    },
+    "release-it": {
+        "git": false,
+        "plugins": {
+            "@release-it/bumper": {
+                "out": {
+                    "file": "package.json",
+                    "path": [
+                        "devDependencies.juisy"
+                    ]
+                }
+            }
+        }
+    }
+}

package/template/.env.example

@@ -0,0 +1,4 @@
+NODE_ENV=development
+
+# CLI specific environement variables
+__JUISY_CLI_ENV__=private

package/template/bin/cli/cli.js

@@ -0,0 +1,27 @@
+const { createCli, utils } = require('@hperchec/juisy')
+const path = require('path')
+const {
+  rootDir,
+  $style
+} = utils
+// Get package.json content
+const packageJson = require(path.resolve(rootDir, './package.json'))
+
+function getBanner () {
+  let str = ''
+  const title = $style.bold('CLI: ') + packageJson.name
+  const length = title.length - 9 // removes characters generated by $style.bold from length
+  str += $style.cyan('-'.repeat(length) + '\n')
+  str += $style.cyan(title + '\n')
+  str += $style.cyan('-'.repeat(length) + '\n')
+  str += $style.italic('Made with') + ' ' + $style.red('❤') + '  ' + $style.italic('by ') + $style.bold('Hervé Perchec <contact@herve-perchec.com') + '\n'
+  return str
+}
+
+// CLI
+module.exports = createCli(cli => cli
+  .scriptName('./bin/cli')
+  .usage(`${getBanner()}\nUsage: $0 <command> [<options>]`)
+  .commandDir('cmds')
+  .demandCommand(1, ('Command is missing. See help to learn more.').red)
+)

package/template/bin/cli/cmds/index.js

@@ -0,0 +1,13 @@
+// Private commands
+import docs from './private/docs/index.js'
+import release from './private/release.js'
+import test from './private/test.js'
+
+export const commands = [
+  // Private commands
+  docs,
+  release,
+  test
+  // Public commands
+  // ...
+]

package/template/bin/cli/cmds/private/changelog.js

@@ -0,0 +1,44 @@
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'changelog',
+  describe: 'Generate CHANGELOG file',
+  meta: {
+    private: true
+  },
+  builder: function (cli) {
+    return cli.option('i', {
+      alias: 'infile',
+      type: 'string',
+      describe: 'Same as conventional-changelog option',
+      default: 'CHANGELOG.md',
+      requiresArg: true
+    })
+  },
+  async handler (argv) {
+    // Utils
+    const { $style, step, substep, error } = CLI.OutputUtils
+    const { run, wait } = CLI.InterfaceUtils
+    /**
+     * Generate changelog file
+     */
+    step('Generating changelog')
+    await wait('Generating', async () => {
+      try {
+        await run(
+          'npx',
+          [
+            'conventional-changelog',
+            '-p', 'angular',
+            '-i', argv.infile,
+            '-s' // same file to output
+          ],
+          { stdio: 'pipe' }
+        )
+      } catch (e) {
+        error('Unable to generate changelog', e)
+      }
+    })
+    substep($style.green('✔ Success'), { last: true })
+    this.log() // Blank line
+  }
+})

package/template/bin/cli/cmds/private/docs/generate-api.js

@@ -0,0 +1,22 @@
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'generate:api',
+  describe: 'Generate API docs from source code',
+  builder (cli) {
+    cli
+  },
+  async handler (argv) {
+    // Utils
+    const { $style, step, substep } = CLI.OutputUtils
+
+    /**
+     * Generate api documentation
+     */
+    step('Generating API documentation')
+
+    substep($style.yellow('⚠ This command does nothing...'), { last: true })
+    this.log() // blank line
+    this.log($style.yellow('You can use JSDoc or TypeDoc for example. See documentation'))
+    this.log() // blank line
+  }
+})

package/template/bin/cli/cmds/private/docs/generate-cli.js

@@ -0,0 +1,11 @@
+import { ReadmeTemplater } from 'juisy/templater'
+
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'generate:cli',
+  describe: 'Generate CLI docs',
+  async handler (argv) {
+    const templater = new ReadmeTemplater('./docs/cli/config.js')
+    await templater.generate()
+  }
+})

package/template/bin/cli/cmds/private/docs/generate-readme.js

@@ -0,0 +1,11 @@
+import { ReadmeTemplater } from 'juisy/templater'
+
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'generate:readme',
+  describe: 'Generate README.md',
+  async handler (argv) {
+    const templater = new ReadmeTemplater('./docs/readme/config.js')
+    await templater.generate()
+  }
+})

package/template/bin/cli/cmds/private/docs/index.js

@@ -0,0 +1,20 @@
+import generateAPI from './generate-api.js'
+
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'docs <command>',
+  describe: 'Manage project documentation',
+  meta: {
+    private: true
+  },
+  builder (cli) {
+    return cli
+      .command([
+        /**
+         * Default command are automatically injected here...
+         */
+        generateAPI
+      ])
+  },
+  handler (argv) {}
+})

package/template/bin/cli/cmds/private/docs/lint.js

@@ -0,0 +1,42 @@
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'lint',
+  describe: 'Lint markdown with markdownlint',
+  builder: function (cli) {
+    cli.option('c', {
+      alias: 'config',
+      type: 'string',
+      describe: 'Path to custom markdownlint config file (relative to root folder)',
+      requiresArg: true
+    })
+    cli.option('f', {
+      alias: 'fix',
+      type: 'boolean',
+      describe: 'Auto fix by passing --fix option to markdownlint-cli2',
+      default: false
+    })
+    return cli
+  },
+  async handler (argv) {
+    const { abort, run } = CLI.InterfaceUtils
+    const configPath = argv.config || './docs/.markdownlint-cli2.cjs' // default relative to root folder
+
+    /**
+     * Call markdownlint command
+     */
+    try {
+      await run(
+        'npx',
+        [
+          'markdownlint-cli2',
+          '--config',
+          configPath,
+          ...(argv.fix ? [ '--fix' ] : [])
+        ],
+        { stdio: 'inherit' }
+      )
+    } catch (error) {
+      abort(error.exitCode)
+    }
+  }
+})

package/template/bin/cli/cmds/private/git-hooks/index.js

@@ -0,0 +1,20 @@
+import reset from './reset.js'
+import sync from './sync.js'
+
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'git-hooks <command>',
+  describe: 'Git relative commands',
+  meta: {
+    private: true
+  },
+  builder: function (cli) {
+    return cli
+      .command([
+        reset,
+        sync
+      ])
+      .demandCommand(1, 'Command is missing. See help to learn more.')
+  },
+  handler: async function (argv) {}
+})

package/template/bin/cli/cmds/private/git-hooks/reset.js

@@ -0,0 +1,48 @@
+import path from 'node:path'
+import fs from 'fs-extra'
+
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'reset',
+  describe: 'Reset git hooks',
+  builder (cli) {
+    return cli
+  },
+  async handler (argv) {
+    // Utils
+    const { $style, step, substep } = CLI.OutputUtils
+    const { rootDir, run, abort } = CLI.InterfaceUtils
+    /**
+     * Reset git hooks
+     */
+    step('Reset git hooks')
+
+    // Create temporary empty configuration file
+    const tempConfigFilePath = './__TEMP_SIMPLE_GIT_HOOKS_CONFIG__.json' // relative to project root folder
+    fs.writeFileSync(path.resolve(rootDir, tempConfigFilePath), '{}')
+
+    // Run command with empty configuration
+    let commandError = false
+    try {
+      await run('npx', [
+        'simple-git-hooks',
+        tempConfigFilePath
+      ], { stdio: 'pipe', cwd: rootDir })
+    } catch (e) {
+      commandError = e
+    }
+
+    // Don't forget to always remove temporary file
+    fs.unlinkSync(path.resolve(rootDir, tempConfigFilePath))
+
+    // If error
+    if (commandError) {
+      substep($style.red('❌ Unable to reset git hooks.'), { last: true })
+      abort(1) // Abort with error
+    } else {
+      // Everything is okay
+      substep($style.green('✔ Git hooks successfuly reset'), { last: true })
+      this.log() // blank line
+    }
+  }
+})

package/template/bin/cli/cmds/private/git-hooks/sync.js

@@ -0,0 +1,19 @@
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'sync',
+  describe: 'Sync git hooks',
+  builder (cli) {
+    return cli
+  },
+  async handler (argv) {
+    // Utils
+    const { step } = CLI.OutputUtils
+    const { run } = CLI.InterfaceUtils
+    /**
+     * Sync git hooks
+     */
+    step('Sync git hooks')
+
+    await run('npx', [ 'simple-git-hooks' ])
+  }
+})