create-juisy 2.0.0-beta.10

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

@@ -0,0 +1,223 @@
+// const path = require('path')
+// const {
+//   $style,
+//   log,
+//   step,
+//   substep,
+//   run,
+//   error,
+//   wait,
+//   confirm,
+//   prompts
+// } = juisy.utils
+
+// const rootDir = path.resolve(__dirname, '../../../')
+
+// const updateVersion = require('../lib/version/update-version')
+
+import semver from 'semver'
+
+import { getPackageInfo } from 'juisy'
+
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'release',
+  describe: 'Make a release',
+  meta: {
+    private: true
+  },
+  builder: function (cli) {
+    cli.option('p', {
+      alias: 'preid',
+      type: 'string',
+      describe: 'Pre-release id',
+      requiresArg: true
+    })
+    return cli
+  },
+  async handler (argv) {
+    const { step } = CLI.OutputUtils
+    const { abort, run } = CLI.InterfaceUtils
+
+    /**
+     * Generate docs
+     */
+    step('Release-it')
+    await run('npx', [ 'release-it' ], { stdio: 'pipe' })
+
+    // const packageJson = getPackageInfo()
+    // let targetVersion
+    // const currentVersion = packageJson.version
+    // const packageName = packageJson.name
+    // const preId = argv.preid || (semver.prerelease(currentVersion) && semver.prerelease(currentVersion)[0])
+    // const inc = i => semver.inc(currentVersion, i, preId)
+    // const versionIncrements = [
+    //   'patch',
+    //   'minor',
+    //   'major',
+    //   ...(preId ? [ 'prepatch', 'preminor', 'premajor', 'prerelease' ] : [])
+    // ]
+
+    // /**
+    //  * First, check if local repository is clean
+    //  */
+    // step('Checking changes to commit')
+    // const { stdout } = await run('git', [ 'diff' ], { stdio: 'pipe', cwd: rootDir })
+    // if (stdout) {
+    //   error('Please commit your changes before creating a new release!', new Error('There are changes to commit'))
+    // }
+    // substep($style.green('✔ Local repository is clean'), { last: true })
+    // log() // Blank line
+
+    // /**
+    //  * Release prompt
+    //  */
+    // step('Setup')
+    // const { release } = await prompts([
+    //   {
+    //     type: 'select',
+    //     name: 'release',
+    //     message: 'Release type:',
+    //     choices: versionIncrements.map(i => ({ title: `${i} (${inc(i)})`, value: inc(i) })).concat([ { title: 'custom', value: 'custom' } ])
+    //   }
+    // ])
+    // // If custom release
+    // if (release === 'custom') {
+    //   const { version: customVersion } = await prompts([
+    //     {
+    //       type: 'text',
+    //       name: 'version',
+    //       message: 'New custom version:',
+    //       initial: currentVersion,
+    //       validate: value => Boolean(semver.valid(value))
+    //     }
+    //   ])
+    //   targetVersion = customVersion
+    // } else {
+    //   targetVersion = release
+    // }
+
+    // /**
+    //  * Demand confirmation
+    //  */
+    // await confirm({ message: `Releasing v${targetVersion}. Confirm?` })
+    // log() // Blank line
+
+    // /**
+    //  * Run tests
+    //  */
+    // // step(`Running tests`)
+    // // ... here run tests
+
+    // /**
+    //  * Update version in necessary files
+    //  */
+    // await updateVersion(targetVersion)
+    // log() // Blank line
+
+    // /**
+    //  * Generate docs
+    //  */
+    // step('Generate docs')
+    // await wait('API docs', async () => {
+    //   await run('node', [ './bin/cli', 'docs', 'generate:api' ], { stdio: 'pipe', cwd: rootDir })
+    // })
+    // substep($style.green('✔ API docs successfuly generated'))
+    // await wait('CLI docs', async () => {
+    //   await run('node', [ './bin/cli', 'docs', 'generate:cli' ], { stdio: 'pipe', cwd: rootDir })
+    // })
+    // substep($style.green('✔ CLI docs successfuly generated'))
+    // await wait('README', async () => {
+    //   await run('node', [ './bin/cli', 'docs', 'generate:readme' ], { stdio: 'pipe', cwd: rootDir })
+    // })
+    // substep($style.green('✔ README successfuly generated'), { last: true })
+    // // await wait('Linting', async () => {
+    // //   await run('node', [ './bin/cli', 'docs', 'lint', '-c', './docs/.markdownlint-cli2.cjs' ], { stdio: 'pipe', cwd: rootDir })
+    // // })
+    // log() // Blank line
+
+    // /**
+    //  * Generate changelog file
+    //  */
+    // step('Generating changelog')
+    // await wait('Generating', async () => {
+    //   await run('node', [ './bin/cli', 'changelog' ], { stdio: 'pipe', cwd: rootDir })
+    // })
+    // substep($style.green('✔ Success'), { last: true })
+    // log() // Blank line
+
+    // /**
+    //  * Confirm changes to commit
+    //  */
+    // step('Confirm changes to commit')
+    // substep($style.yellow('↓ The following changes will be committed:'))
+    // await run('git', [ 'status', '-s' ], { stdio: 'inherit', cwd: rootDir })
+    // substep($style.yellow('- The following tag will be created: ') + `v${targetVersion}`, { last: true })
+
+    // /**
+    //  * Demand confirmation
+    //  */
+    // await confirm()
+    // log() // Blank line
+
+    // /**
+    //  * Publish package
+    //  */
+    // step(`Publishing ${packageName}`)
+    // const releaseTag = targetVersion.includes('alpha')
+    //   ? 'alpha'
+    //   : targetVersion.includes('beta')
+    //     ? 'beta'
+    //     : targetVersion.includes('rc')
+    //       ? 'rc'
+    //       : null
+    // let alreadyPublished = false
+    // await wait('Publishing', async () => {
+    //   try {
+    //     await run('npm', [ 'publish', ...(releaseTag ? [ '--tag', releaseTag ] : []) ], { stdio: 'pipe', cwd: rootDir })
+    //   } catch (e) {
+    //     if (e.stderr.match(/previously published/)) {
+    //       alreadyPublished = true
+    //     } else {
+    //       error('Unknown error during publishing', e)
+    //     }
+    //   }
+    // })
+    // substep(
+    //   alreadyPublished
+    //     ? $style.yellow(`Skipping already published: ${packageName}`)
+    //     : $style.green('✔ Success'),
+    //   { last: true }
+    // )
+    // log() // Blank line
+
+    // /**
+    //  * Push to git
+    //  */
+    // step('Pushing changes')
+    // await wait('Committing', async () => {
+    //   try {
+    //     await run('git', [ 'add', '.' ], { stdio: 'pipe', cwd: rootDir })
+    //     await run('git', [ 'commit', '-m', `chore(release): v${targetVersion}` ], { stdio: 'pipe', cwd: rootDir })
+    //   } catch (e) {
+    //     error('Unable to commit', e)
+    //   }
+    // })
+    // substep($style.green('✔ Committed'))
+    // await wait('Creating tag', async () => {
+    //   try {
+    //     await run('git', [ 'tag', '-a', `v${targetVersion}`, '-m', `v${targetVersion}` ], { stdio: 'pipe', cwd: rootDir })
+    //   } catch (e) {
+    //     error('Unable to create tag', e)
+    //   }
+    // })
+    // substep($style.green('✔ Tagged'))
+    // log() // blank line
+
+    // log($style.green(`✔ Release v${targetVersion} successfuly created`))
+    // log()
+
+    // log($style.yellow('IMPORTANT: You should now run ') + 'git push origin --follow-tags')
+    // log()
+  }
+})

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

@@ -0,0 +1,33 @@
+/** @type {import('juisy/cli').Command} */
+export default new CLI.Command({
+  command: 'test',
+  describe: 'Run project tests',
+  meta: {
+    private: true
+  },
+  builder (cli) {
+    cli.option('watch', {
+      alias: 'w',
+      type: 'boolean',
+      default: false,
+      describe: 'Run vitest in watch mode'
+    })
+    cli.option('ui', {
+      type: 'boolean',
+      default: false,
+      describe: 'Launch vitest UI'
+    })
+    return cli
+  },
+  async handler (args) {
+    const watchMode = args.watch || args.ui
+    const { run } = CLI.InterfaceUtils
+    /**
+     * Run tests
+     */
+    await run('vitest', [
+      ...(watchMode ? [] : [ 'run' ]),
+      ...(args.ui ? [ '--ui' ] : [])
+    ], { stdio: 'inherit' })
+  }
+})

package/template/bin/cli/index.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+'use strict'
+
+const cli = require('./cli')
+
+cli().parse(process.argv.slice(2))

package/template/bin/cli/lib/docs/generate-api-doc.js

@@ -0,0 +1,33 @@
+const fs = require('fs-extra')
+const path = require('path')
+const juisy = require('@hperchec/juisy')
+
+const {
+  rootDir,
+  $style,
+  step,
+  substep
+} = juisy.utils
+
+/**
+ * Generate doc function
+ * @param {Object} [options = {}] - The options object
+ */
+module.exports = async function generateAPIDoc (options = {}) {
+  // Process options
+  const distDir = options.distDir
+  const outputDir = options.outputDir
+
+  const outputFullPath = path.resolve(rootDir, distDir, outputDir)
+
+  /**
+   * Generate api documentation
+   */
+  step('Generating API documentation')
+
+  // Here do logic to generate your documentation
+  // ex: jsdoc
+  fs.writeFileSync(path.resolve(outputFullPath, './api.md'), '# Awesome API !', { encoding: 'utf8' })
+
+  substep($style.yellow('This command just creates an example file. Let\'s write your logic!'), { last: true })
+}

package/template/bin/cli/lib/release/generate-release-note.js

@@ -0,0 +1,3 @@
+module.exports = async function genReleaseNote () {
+  console.log('Not configured...')
+}

package/template/bin/cli/lib/version/update-version.js

@@ -0,0 +1,51 @@
+const fs = require('fs')
+const path = require('path')
+const juisy = require('@hperchec/juisy')
+
+const {
+  rootDir,
+  $style,
+  error,
+  step,
+  substep,
+  run,
+  wait
+} = juisy.utils
+
+// File paths
+const filePaths = {
+  packageJson: path.resolve(rootDir, './package.json')
+}
+// Get package.json content
+const packageJson = require(filePaths.packageJson)
+
+/**
+ * Update version in necessary files
+ * @param {string} version - The version
+ * @return {void}
+ */
+module.exports = async function updateVersion (version) {
+  // Update version for each file
+  packageJson.version = version
+
+  /**
+   * Update files
+   */
+  step('Updating version in necessary files')
+  // Update package.json
+  try {
+    fs.writeFileSync(filePaths.packageJson, JSON.stringify(packageJson, null, 4), 'utf8')
+  } catch (e) {
+    error('Unable to update package.json file', e)
+  }
+  substep($style.green('✔ package.json successfuly updated'))
+  // Updating package-lock
+  await wait('Updating package-lock.json', async () => {
+    try {
+      await run('npm', [ 'install', '--prefer-offline' ], { stdio: 'pipe' })
+    } catch (e) {
+      error('Unable to update package-lock.json file', e)
+    }
+  })
+  substep($style.green('✔ package-lock.json successfuly updated'), { last: true })
+}

package/template/bin/scripts/commit-msg.js

@@ -0,0 +1,42 @@
+const juisy = require('@hperchec/juisy')
+
+const {
+  $style,
+  abort,
+  log,
+  rootDir,
+  step,
+  substep,
+  run
+} = juisy.utils
+
+/**
+ * commit-msg git hook
+ */
+;(async function () {
+  step('Git hook: commit-msg')
+
+  // Get git commit msg path from args
+  const args = process.argv.slice(2)
+  const gitMsgPath = args[0]
+
+  try {
+    // original is: npx --no -- commitlint --edit ${1}
+    // we replace "${1}" by gitMsgPath arg
+    await run('npx', [
+      '--no',
+      '--',
+      'commitlint',
+      '--edit',
+      gitMsgPath
+    ], { cwd: rootDir })
+  } catch (e) {
+    substep($style.red('❌ Git hook: "commit-msg" failed. Please check ./COMMIT_CONVENTION.md for more informations.'), { last: true })
+    abort(1) // Abort with error
+  }
+
+  // Everything is okay
+  substep($style.green('✔ Git hook: "commit-msg" passed'), { last: true })
+
+  log() // blank line
+})()

package/template/bin/scripts/pre-commit.js

@@ -0,0 +1,32 @@
+const juisy = require('@hperchec/juisy')
+
+const {
+  $style,
+  error,
+  log,
+  rootDir,
+  step,
+  substep,
+  run
+} = juisy.utils
+
+/**
+ * Pre commit git hook
+ */
+;(async function () {
+  step('Git hook: pre-commit')
+
+  try {
+    // npx lint-staged
+    await run('npx', [
+      'lint-staged'
+    ], { stdio: 'pipe', cwd: rootDir })
+  } catch (e) {
+    error('Git hook: "commit-msg" error: ', e)
+  }
+
+  // Everything is okay
+  substep($style.green('✔ Git hook: "pre-commit" passed'), { last: true })
+
+  log() // blank line
+})()

package/template/dev.config.js

@@ -0,0 +1,34 @@
+/** @type {import('juisy/cli').GlobalSettings} */
+export default {
+  changelog: {
+    infile: 'CHANGELOG.md',
+    preset: 'angular',
+    sameFile: true
+  },
+  docs: {
+    readme: {
+      config: './docs/readme/config.js'
+    },
+    cli: {
+      config: './docs/cli/config.js'
+    }
+  },
+  gitHooks: {
+    'pre-commit': 'node ./bin/scripts/pre-commit.js',
+    'commit-msg': 'node ./bin/scripts/commit-msg.js ${1}'
+  },
+  lint: {
+    staged: {
+      '*.{js,cjs,ts}': [
+        'eslint --fix'
+      ]
+    }
+  },
+  release: {
+    git: {
+      commitMessage: 'chore(release): v${version}',
+      requireBranch: 'main',
+      tagAnnotation: 'v${version}'
+    }
+  }
+}

package/template/dev.config.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "./node_modules/juisy/dist/GlobalSettings.schema.json",
+  "changelog": {
+    "infile": "CHANGELOG.md",
+    "preset": "angular",
+    "sameFile": true
+  },
+  "docs": {
+    "readme": {
+      "config": "./docs/readme/config.js"
+    },
+    "cli": {
+      "config": "./docs/cli/config.js"
+    }
+  },
+  "gitHooks": {
+    "pre-commit": "node ./bin/scripts/pre-commit.js",
+    "commit-msg": "node ./bin/scripts/commit-msg.js ${1}"
+  },
+  "lint": {
+    "staged": {
+      "*.{js,cjs,ts}": [
+        "eslint --fix"
+      ]
+    }
+  }
+}

package/template/dev.config.ts

@@ -0,0 +1,28 @@
+import type { GlobalSettings } from 'juisy/cli'
+
+export default {
+  changelog: {
+    infile: 'CHANGELOG.md',
+    preset: 'angular',
+    sameFile: true
+  },
+  docs: {
+    readme: {
+      config: './docs/readme/config.js'
+    },
+    cli: {
+      config: './docs/cli/config.js'
+    }
+  },
+  gitHooks: {
+    'pre-commit': 'node ./bin/scripts/pre-commit.js',
+    'commit-msg': 'node ./bin/scripts/commit-msg.js ${1}'
+  },
+  lint: {
+    staged: {
+      '*.{js,cjs,ts}': [
+        'eslint --fix'
+      ]
+    }
+  }
+} satisfies GlobalSettings

package/template/docs/api/docs.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  /**
+   * Dist directory (relative to root folder)
+   */
+  distDir: './docs/api',
+  /**
+   * Output directory (relative to distDir folder)
+   */
+  outputDir: 'output'
+}

package/template/docs/readme/config.js

@@ -0,0 +1,22 @@
+/**
+ * @hperchec/readme-generator Example configuration file
+ */
+
+const path = require('path')
+
+// Export configuration
+module.exports = {
+  // Template path
+  templatePath: path.resolve(__dirname, './template.md'), // Default template file
+  // Output path
+  outputPath: path.resolve(__dirname, '../../'), // Your project root directory by default
+  // Output file name
+  outputName: 'README.md', // 'README.md' by default
+  // Path to ejs data file
+  ejsDataPath: path.resolve(__dirname, './readme.js'), // Default template ejs data file
+  // EJS options (see https://www.npmjs.com/package/ejs#options)
+  ejsOptions: {
+    async: true
+    /* your ejs options... */
+  }
+}

package/template/docs/readme/readme.js

@@ -0,0 +1,70 @@
+/**
+ * @hperchec/readme-generator Template EJS data example file
+ */
+
+const markdownTable = require('markdown-table') // ! v3 not compatible, use v2
+
+// Based on the package.json file, get some data and informations
+const pkg = require('../../package.json')
+const packageName = pkg.name
+const packageUrl = `https://www.npmjs.com/package/${packageName}`
+const dependencies = pkg.dependencies || {}
+const devDependencies = pkg.devDependencies || {}
+const peerDependencies = pkg.peerDependencies || {}
+const author = pkg.author
+const contributors = pkg.contributors || []
+const license = pkg.license || 'Unknown'
+const homepage = pkg.homepage
+const projectUrl = pkg.repository.url
+const issuesUrl = pkg.bugs.url
+
+// Output a markdown formatted table from a js object
+// Like:
+// |name|version|
+// |----|-------|
+// |    |       |
+function getMdDependencies (deps) {
+  return markdownTable([
+    [ 'name', 'version' ],
+    ...(Object.entries(deps))
+  ])
+}
+
+/**
+ * Return author link
+ * @param {Object} author
+ * @return {string}
+ */
+function getMdAuthor (author) {
+  return '[' + author.name + '](' + author.url + ')'
+}
+
+/**
+ * Return markdown list of persons
+ * @param {Array} contributors
+ * @return {String}
+ */
+function getMdContributors (contributors) {
+  let mdString = ''
+  contributors.forEach((person) => {
+    mdString += '- [' + person.name + '](' + person.url + ')\n'
+  })
+  return mdString
+}
+
+/**
+ * Export data for readme file templating
+ */
+module.exports = {
+  packageName,
+  packageUrl,
+  projectUrl,
+  homepage,
+  issuesUrl,
+  dependencies: getMdDependencies(dependencies),
+  devDependencies: getMdDependencies(devDependencies),
+  peerDependencies: getMdDependencies(peerDependencies),
+  author: getMdAuthor(author),
+  contributors: getMdContributors(contributors),
+  license
+}

package/template/docs/readme/template.md

@@ -0,0 +1,53 @@
+# Awesome project
+
+[![author](https://img.shields.io/static/v1?label=&message=Author:&color=black)]()
+[![herve-perchec](http://herve-perchec.com/badge.svg)](http://herve-perchec.com/)
+
+**Table of contents**:
+
+[[*TOC*]]
+
+## 🚀 Get started
+
+```sh
+# Let's go!
+```
+
+## 📙 Documentation
+
+Please check the [documentation](https://www.npmjs.com/package/@hperchec/juisy)
+
+## 🧱 Dependencies
+
+<details>
+<summary>Global</summary>
+
+<%%= dependencies %>
+
+</details>
+
+<details>
+<summary>Dev</summary>
+
+<%%= devDependencies %>
+
+</details>
+
+<details>
+<summary>Peer</summary>
+
+<%%= peerDependencies %>
+
+</details>
+
+## ✍ Author
+
+<%%= author %>
+
+## 📄 License
+
+<%%= license %>
+
+----
+
+Made with ❤ by <%%= author %>