create-juisy 2.0.0-beta.9 → 2.1.0

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

@@ -1,14 +1,17 @@
-const juisy = require('@hperchec/juisy')
+import { InterfaceUtils, OutputUtils } from 'juisy/cli'
 
 const {
-  $style,
   abort,
+  run
+} = InterfaceUtils
+
+const {
+  $style,
   log,
-  rootDir,
+  error,
   step,
-  substep,
-  run
-} = juisy.utils
+  substep
+} = OutputUtils
 
 /**
  * commit-msg git hook
@@ -17,26 +20,18 @@ const {
   step('Git hook: commit-msg')
 
   // Get git commit msg path from args
-  const args = process.argv.slice(2)
-  const gitMsgPath = args[0]
+  // We call this script as: node ./bin/scripts/commit-msg $1
+  const gitMsgPath = process.argv[2]
 
   try {
-    // original is: npx --no -- commitlint --edit ${1}
-    // we replace "${1}" by gitMsgPath arg
-    await run('npx', [
-      '--no',
-      '--',
-      'commitlint',
-      '--edit',
-      gitMsgPath
-    ], { cwd: rootDir })
+    await run('node', [ './bin/cli', 'lint:commit', '--edit', gitMsgPath ])
   } catch (e) {
     substep($style.red('❌ Git hook: "commit-msg" failed. Please check ./COMMIT_CONVENTION.md for more informations.'), { last: true })
+    error('Error:', e)
     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

@@ -1,14 +1,17 @@
-const juisy = require('@hperchec/juisy')
+import { InterfaceUtils, OutputUtils } from 'juisy/cli'
+
+const {
+  abort,
+  run
+} = InterfaceUtils
 
 const {
   $style,
-  error,
   log,
-  rootDir,
+  error,
   step,
-  substep,
-  run
-} = juisy.utils
+  substep
+} = OutputUtils
 
 /**
  * Pre commit git hook
@@ -17,12 +20,11 @@ const {
   step('Git hook: pre-commit')
 
   try {
-    // npx lint-staged
-    await run('npx', [
-      'lint-staged'
-    ], { stdio: 'pipe', cwd: rootDir })
+    await run('node', [ './bin/cli', 'lint:staged' ])
   } catch (e) {
-    error('Git hook: "commit-msg" error: ', e)
+    substep($style.red('❌ Git hook: "pre-commit" failed.'), { last: true })
+    error('Error:', e)
+    abort(1) // Abort with error
   }
 
   // Everything is okay

package/template/dev.config.js

@@ -18,17 +18,49 @@ export default {
     'commit-msg': 'node ./bin/scripts/commit-msg.js ${1}'
   },
   lint: {
+    default: {
+      config: 'eslint.config.js'
+    },
+    commit: {
+      // See also: https://github.com/conventional-changelog/commitlint
+      extends: [
+        '@commitlint/config-conventional'
+      ]
+    },
+    markdown: [
+      {
+        globs: [ 'README.md' ],
+        config: './docs/.markdownlint-cli2.mjs'
+      },
+      {
+        globs: [ 'cli.private.md', 'cli.public.md' ],
+        config: './docs/.markdownlint-cli2.mjs'
+      }
+    ],
     staged: {
       '*.{js,cjs,ts}': [
-        'eslint --fix'
+        'node ./bin/cli lint --fix'
       ]
     }
   },
   release: {
-    git: {
-      commitMessage: 'chore(release): v${version}',
-      requireBranch: 'main',
-      tagAnnotation: 'v${version}'
+    /**
+     * See: https://github.com/release-it/release-it?tab=readme-ov-file#hooks
+     */
+    hooks: {
+      'before:init': [
+        // Lint and run tests
+        'node ./bin/cli lint --fix',
+        'node ./bin/cli test'
+      ],
+      'after:bump': [
+        // Build code and generate docs
+        'vite build',
+        'node ./bin/cli docs generate:api',
+        'node ./bin/cli docs generate:readme',
+        'node ./bin/cli docs generate:cli -c ./docs/cli/private/config.js',
+        'node ./bin/cli docs generate:cli -c ./docs/cli/public/config.js'
+      ]
     }
   }
 }

package/template/dev.config.json

@@ -18,9 +18,27 @@
     "commit-msg": "node ./bin/scripts/commit-msg.js ${1}"
   },
   "lint": {
+    "default": {
+      "config": "eslint.config.js"
+    },
+    "commit": {
+      "extends": [
+        "@commitlint/config-conventional"
+      ]
+    },
+    "markdown": [
+      {
+        "globs": [ "README.md" ],
+        "config": "./docs/.markdownlint-cli2.mjs"
+      },
+      {
+        "globs": [ "cli.private.md", "cli.public.md" ],
+        "config": "./docs/.markdownlint-cli2.mjs"
+      }
+    ],
     "staged": {
       "*.{js,cjs,ts}": [
-        "eslint --fix"
+        "node ./bin/cli lint --fix"
       ]
     }
   }

package/template/dev.config.ts

@@ -19,9 +19,48 @@ export default {
     'commit-msg': 'node ./bin/scripts/commit-msg.js ${1}'
   },
   lint: {
+    default: {
+      config: 'eslint.config.js'
+    },
+    commit: {
+      // See also: https://github.com/conventional-changelog/commitlint
+      extends: [
+        '@commitlint/config-conventional'
+      ]
+    },
+    markdown: [
+      {
+        globs: [ 'README.md' ],
+        config: './docs/.markdownlint-cli2.mjs'
+      },
+      {
+        globs: [ 'cli.private.md', 'cli.public.md' ],
+        config: './docs/.markdownlint-cli2.mjs'
+      }
+    ],
     staged: {
       '*.{js,cjs,ts}': [
-        'eslint --fix'
+        'node ./bin/cli lint --fix'
+      ]
+    }
+  },
+  release: {
+    /**
+     * See: https://github.com/release-it/release-it?tab=readme-ov-file#hooks
+     */
+    hooks: {
+      'before:init': [
+        // Lint and run tests
+        'node ./bin/cli lint --fix',
+        'node ./bin/cli test'
+      ],
+      'after:bump': [
+        // Build code and generate docs
+        'vite build',
+        'node ./bin/cli docs generate:api',
+        'node ./bin/cli docs generate:readme',
+        'node ./bin/cli docs generate:cli -c ./docs/cli/private/config.js',
+        'node ./bin/cli docs generate:cli -c ./docs/cli/public/config.js'
       ]
     }
   }

package/template/docs/.markdownlint-cli2.mjs

@@ -0,0 +1,21 @@
+import { init } from '@github/markdownlint-github'
+
+const options = {
+  // See also https://www.npmjs.com/package/@github/markdownlint-github
+  config: init({
+    // ... Custom overrides
+  }),
+  customRules: [
+    '@github/markdownlint-github'
+  ],
+  outputFormatters: [
+    [
+      'markdownlint-cli2-formatter-pretty',
+      {
+        appendLink: true // ensures the error message includes a link to the rule documentation
+      }
+    ]
+  ]
+}
+
+export default options

package/template/docs/cli/private/config.js

@@ -0,0 +1,37 @@
+/**
+ * ReadmeTemplater configuration file
+ */
+
+import path, { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+/** @type {import('juisy/templater').ReadmeTemplaterUserConfig} */
+export default {
+  /**
+   * Output file name: 'README.md' by default
+   */
+  fileName: 'cli.private.md',
+  /**
+   * Change destination folder
+   */
+  destFolder: path.resolve(__dirname, '../../..'),
+  /**
+   * Template entry file path
+   */
+  templatePath: path.resolve(__dirname, './template.md'),
+  /**
+   * EJS data file
+   */
+  ejsDataPath: path.resolve(__dirname, './data.js'),
+  /**
+   * EJS options
+   */
+  ejsOptions: {
+    views: [
+      path.resolve(__dirname, './partials')
+    ]
+  }
+}

package/template/docs/cli/private/data.js

@@ -0,0 +1,14 @@
+/**
+ * ReadmeTemplater EJS data file
+ */
+
+import stripAnsi from 'strip-ansi'
+import cli from '../../../bin/cli/cli.js'
+
+import { extractUsage } from 'juisy/cli'
+
+export const rootDoclet = await extractUsage(cli, true) // recursively extract usage
+// Add filters
+export const $filters = {
+  stripAnsi
+}

package/template/docs/cli/private/partials/child-command.md

@@ -0,0 +1,26 @@
+<%%
+  // Optional props
+  if (hLevel === undefined) { hLevel = 3 }
+  if (recursive === undefined) { recursive = true }
+-%>
+<%%= $utils.h(hLevel, '`' + cmdDoclet.args.join(' ') + '`') %>
+
+```
+<%%- $filters.stripAnsi(cmdDoclet.rawUsage) %>
+```
+
+<%%
+  if (recursive) { 
+    for (const child in cmdDoclet.children) {
+%>
+<%%-
+      await include('child-command.md', {
+        cmdDoclet: cmdDoclet.children[child],
+        hLevel: hLevel + 1,
+        recursive: true
+      })
+%>
+<%%
+    }
+  }
+%>

package/template/docs/cli/private/template.md

@@ -0,0 +1,26 @@
+# CLI
+
+## Table of contents
+
+<%%#
+  // Table of contents is automatically injected here by
+  // [remark-toc](https://github.com/remarkjs/remark-toc)
+-%>
+
+## Usage
+
+```console
+<%%- $filters.stripAnsi(rootDoclet.rawUsage) %>
+```
+
+## Commands
+
+<%% for (const child in rootDoclet.children) { %>
+<%%-
+  await include('child-command.md', {
+    cmdDoclet: rootDoclet.children[child],
+    hLevel: 3,
+    recursive: true
+  })
+%>
+<%% } %>

package/template/docs/cli/public/config.js

@@ -0,0 +1,21 @@
+/**
+ * ReadmeTemplater configuration file
+ */
+
+import path, { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import baseConfig from '../private/config.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+// Force process.env.CLI_ENV to "public"
+process.env.CLI_ENV = 'public'
+
+/** @type {import('juisy/templater').ReadmeTemplaterUserConfig} */
+export default {
+  ...baseConfig,
+  fileName: 'cli.public.md',
+  templatePath: path.resolve(__dirname, './template.md')
+}

package/template/docs/cli/public/template.md

@@ -0,0 +1,19 @@
+# CLI
+
+## Usage
+
+```console
+<%%- $filters.stripAnsi(rootDoclet.rawUsage) %>
+```
+
+## Commands
+
+<%% for (const child in rootDoclet.children) { %>
+<%%-
+  await include('child-command.md', {
+    cmdDoclet: rootDoclet.children[child],
+    hLevel: 3,
+    recursive: true
+  })
+%>
+<%% } %>

package/template/docs/readme/config.js

@@ -1,22 +1,33 @@
 /**
- * @hperchec/readme-generator Example configuration file
+ * ReadmeTemplater configuration file
  */
 
-const path = require('path')
+import path, { dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
 
-// 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
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+/** @type {import('juisy/templater').ReadmeTemplaterUserConfig} */
+export default {
+  /**
+   * Output file name: 'README.md' by default
+   */
+  fileName: 'README.md',
+  /**
+   * Change destination folder
+   */
+  destFolder: path.resolve(__dirname, '../..'),
+  /**
+   * Template entry file path
+   */
+  templatePath: path.resolve(__dirname, './template.md'),
+  /**
+   * EJS data file
+   */
+  ejsDataPath: path.resolve(__dirname, './data.js'),
   // EJS options (see https://www.npmjs.com/package/ejs#options)
   ejsOptions: {
-    async: true
     /* your ejs options... */
   }
 }

package/template/docs/readme/data.js

@@ -0,0 +1,45 @@
+/**
+ * ReadmeTemplater EJS data file
+ */
+
+import { getPackageInfo } from 'juisy'
+
+// Based on the package.json file, get some data and informations
+const pkg = getPackageInfo()
+
+/**
+ * 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
+ */
+export const packageName = pkg.name
+export const packageUrl = `https://www.npmjs.com/package/${packageName}`
+export const dependencies = pkg.dependencies || {}
+export const devDependencies = pkg.devDependencies || {}
+export const peerDependencies = pkg.peerDependencies || {}
+export const projectUrl = pkg.repository.url.match(/^git\+(.*)\.git$/)[1] // find string between 'git+' and '.git'
+export const projectPath = projectUrl.replace('https://gitlab.com/', '') // remove domain name
+export const issuesUrl = pkg.bugs.url
+export const license = pkg.license || 'Unknown'
+export const author = getMdAuthor(pkg.author)
+export const contributors = getMdContributors(pkg.contributors || [])

package/template/docs/readme/template.md

@@ -1,11 +1,17 @@
 # Awesome project
 
-[![author](https://img.shields.io/static/v1?label=&message=Author:&color=black)]()
+[![author](https://img.shields.io/static/v1?label=&message=Author:&color=black)](http://herve-perchec.com/)
 [![herve-perchec](http://herve-perchec.com/badge.svg)](http://herve-perchec.com/)
 
-**Table of contents**:
+> You can use [shields.io](https://shields.io/) to generate your own badges!
+
+## Table of contents
+
+<%%#
+  // Table of contents is automatically injected here by
+  // [remark-toc](https://github.com/remarkjs/remark-toc)
+-%>
 
-[[*TOC*]]
 
 ## 🚀 Get started
 
@@ -13,33 +19,51 @@
 # Let's go!
 ```
 
-## 📙 Documentation
-
-Please check the [documentation](https://www.npmjs.com/package/@hperchec/juisy)
+This project is made with [Juisy](https://www.npmjs.com/package/juisy).
+Read the [documentation](https://hperchec.gitlab.io/juisy) to learn more!
 
 ## 🧱 Dependencies
 
 <details>
 <summary>Global</summary>
 
-<%%= dependencies %>
+<%%-
+  $utils.table([
+    ['name', 'version'],
+    ...(Object.entries(dependencies))
+  ])
+%>
 
 </details>
 
 <details>
 <summary>Dev</summary>
 
-<%%= devDependencies %>
+<%%-
+  $utils.table([
+    ['name', 'version'],
+    ...(Object.entries(devDependencies))
+  ])
+%>
 
 </details>
 
 <details>
 <summary>Peer</summary>
 
-<%%= peerDependencies %>
+<%%-
+  $utils.table([
+    ['name', 'version'],
+    ...(Object.entries(peerDependencies))
+  ])
+%>
 
 </details>
 
+## 🤝 Contribute
+
+See the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
+
 ## ✍ Author
 
 <%%= author %>
@@ -48,6 +72,10 @@ Please check the [documentation](https://www.npmjs.com/package/@hperchec/juisy)
 
 <%%= license %>
 
+## 🧬 Changelog
+
+See all changes to this project in the [CHANGELOG.md](./CHANGELOG.md) file.
+
 ----
 
 Made with ❤ by <%%= author %>

package/template/eslint.config.js

@@ -0,0 +1,47 @@
+import globals from 'globals'
+import js from '@eslint/js'
+import stylistic from '@stylistic/eslint-plugin'
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    }
+  },
+  /**
+   * See: https://eslint.style/packages/default
+   */
+  stylistic.configs.customize({
+    // ...
+  }),
+  /**
+   * Our rules configuration
+   */
+  {
+    rules: {
+      // @eslint/js
+      ...js.configs.recommended.rules,
+      'no-unused-vars': [ 'error', {
+        args: 'none'
+      } ],
+      // @stylistic/eslint-plugin
+      '@stylistic/array-bracket-spacing': [ 'error', 'always' ],
+      '@stylistic/brace-style': [ 'error', '1tbs' ],
+      '@stylistic/comma-dangle': [ 'error', 'never' ],
+      '@stylistic/space-before-function-paren': [ 'error', 'always' ]
+    }
+  },
+  {
+    files: [
+      '**/bin/cli/**/*.js'
+    ],
+    languageOptions: {
+      globals: {
+        CLI: 'readonly'
+      }
+    }
+  }
+]

package/template/package.json

@@ -1,11 +1,9 @@
 {
-    "name": "new-project",
+    "name": "<%= __PROJECT_NAME__ %>",
     "version": "1.0.0",
     "description": "New project based on Juisy template",
     "type": "module",
-    "scripts": {
-      "test": "echo \"Error: no test specified\" && exit 1"
-    },
+    "scripts": {},
     "repository": {
         "type": "git",
         "url": "git+https://gitlab.com/hperchec/juisy.git"
@@ -18,8 +16,13 @@
     "bugs": {
         "url": "https://gitlab.com/hperchec/juisy/issues"
     },
-    "homepage": "https://gitlab.com/hperchec/juisy#readme",
+    "homepage": "<%= __JUISY_DOCS_HOMEPAGE__ %>",
     "dependencies": {
-        "juisy": "^__JUISY_VERSION__"
+        "juisy": "^<%= __JUISY_VERSION__ %>"
+    },
+    "devDependencies": {
+        "@vitest/coverage-v8": "^3",
+        "@vitest/ui": "^3",
+        "vitest": "^3"
     }
 }