create-juisy 2.0.0-beta.10 → 2.0.0-beta.11

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,16 @@
 # 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!
 
-[[*TOC*]]
+## Table of contents
+
+<%#
+  // Table of contents is automatically injected here by
+  // [remark-toc](https://github.com/remarkjs/remark-toc)
+-%>
 
 ## 🚀 Get started
 
@@ -13,9 +18,8 @@
 # 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
 

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"

package/template/project.globals.js

@@ -1,33 +1,24 @@
-import pkg from './package.json' assert { type: 'json' }
+import { defineGlobals } from 'juisy'
 
-// Exports globals object
-export default {
-  ENV: {
-    NODE_ENV: process.env.NODE_ENV
+export default defineGlobals(
+  {
+    // The environment variables to auto includes in "ENV" property
+    env: { map: [ 'NODE_ENV' ] }
   },
-  PACKAGE: {
-    NAME: pkg.name,
-    URL: `https://www.npmjs.com/package/${pkg.name}`
-  },
-  VERSION: pkg.version,
-  AUTHOR: {
-    EMAIL: pkg.author.email,
-    NAME: pkg.author.name,
-    URL: pkg.author.url
-  },
-  REPOSITORY: {
-    TYPE: pkg.repository.type,
-    URL: pkg.repository.url
-  },
-  ISSUES_URL: pkg.bugs.url,
-  HOMEPAGE: pkg.homepage,
-  BRAND: {
-    COLORS: {
-      GERALDINE: '#FF8E92',
-      SAND: '#FFC17A',
-      COGNAC: '#A04113',
-      DARK_PINK: '#E95185',
-      PINK_SHERBET: '#F583A3'
+  // Access to all environment variables and package.json info
+  ({ env, pkg }) => {
+    return {
+      // Define your brand specific constants
+      BRAND: {
+        NAME: 'My brand',
+        COLORS: {
+          GERALDINE: '#FF8E92',
+          SAND: '#FFC17A',
+          COGNAC: '#A04113',
+          DARK_PINK: '#E95185',
+          PINK_SHERBET: '#F583A3'
+        }
+      }
     }
   }
-}
+)

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

@@ -1,44 +0,0 @@
-/** @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-cli.js

@@ -1,11 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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/lint.js

@@ -1,42 +0,0 @@
-/** @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

@@ -1,20 +0,0 @@
-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

@@ -1,48 +0,0 @@
-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

@@ -1,19 +0,0 @@
-/** @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' ])
-  }
-})