create-juisy 2.0.0-beta.13 → 2.0.0-beta.15

package/index.js

@@ -40,7 +40,10 @@ const argv = mri(process.argv.slice(2), {
 const cwd = process.cwd()
 
 // Get juisy version from this package.json file
-const { version: JUISY_VERSION } = JSON.parse(
+const {
+  version: JUISY_VERSION,
+  homepage: JUISY_DOCS_HOMEPAGE
+} = JSON.parse(
   fs.readFileSync(path.resolve(__dirname, './package.json'), 'utf-8')
 )
 
@@ -107,15 +110,21 @@ async function main () {
       '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') {
-        let newContent = content.replace(/__PROJECT_NAME__/g, targetDir)
-        newContent = newContent.replace(/__JUISY_VERSION__/g, JUISY_VERSION)
-        return newContent
-      } else {
-        return content
+    templateData: (identifier) => {
+      return {
+        __PROJECT_NAME__: targetDir,
+        __JUISY_VERSION__: JUISY_VERSION,
+        __JUISY_DOCS_HOMEPAGE__: JUISY_DOCS_HOMEPAGE
       }
     }
+    // processor: (content, identifier) => {
+    //   if (identifier === 'package.json') {
+    //     let newContent = content.replace(/__PROJECT_NAME__/g, targetDir)
+    //     return newContent
+    //   } else {
+    //     return content
+    //   }
+    // }
   })
 
   substep($style.green(`✔ Successfuly copied`), { last: true })
@@ -141,12 +150,16 @@ async function main () {
     'changelog': `${targetCliCommand} changelog`,
     'git-hooks:reset': `${targetCliCommand} git-hooks reset`,
     'git-hooks:sync': `${targetCliCommand} git-hooks sync`,
-    'test': `${targetCliCommand} test`
+    'test': `${targetCliCommand} test run`,
+    'test:watch': `${targetCliCommand} test`,
+    'test:ui': 'npm run test:watch -- --ui --coverage.enabled=true',
+    'test:coverage': 'npm run test -- --coverage.enabled=true'
   }
 
   step('Adding scripts to package.json')
+  const packageJsonPath = path.join(path.resolve(cwd, targetDir), 'package.json')
   const pkg = JSON.parse(
-    fs.readFileSync(path.join(path.resolve(cwd, targetDir), 'package.json'), 'utf-8')
+    fs.readFileSync(packageJsonPath, 'utf-8')
   )
   pkg.scripts = pkg.scripts || {}
 
@@ -157,13 +170,16 @@ async function main () {
       : 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) })
+      pkg.scripts[scriptName] = scripts[scriptName]
       substep($style.green(`✔ Script "${scriptName}" successfuly added`), { last: isLastStep })
     } else {
       substep($style.yellow(`Script "${scriptName}" already set. Use --force option to overwrite`), { last: isLastStep })
     }
   }
 
+  // Replace package.json content
+  fs.writeFileSync(packageJsonPath, JSON.stringify(pkg, null, 2) + '\n')
+
   log() // Blank line
   log('You should now move into the created folder and run the following command:\n  - npm install')
   log() // Blank line

package/package.json

@@ -1,63 +1,61 @@
 {
-    "name": "create-juisy",
-    "version": "2.0.0-beta.13",
-    "description": "Juisy boilerplate for npm init",
-    "type": "module",
-    "bin": {
-        "create-juisy": "index.js"
-    },
-    "files": [
-        "template",
-        "index.js"
-    ],
-    "publishConfig": {
-        "access": "public"
-    },
-    "scripts": {
-        "release": "release-it --no-increment",
-        "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.13"
-    },
-    "dependencies": {
-        "execa": "^8",
-        "mri": "^1.2.0"
-    },
-    "release-it": {
-        "git": false,
-        "plugins": {
-            "@release-it/bumper": {
-                "out": {
-                    "file": "package.json",
-                    "path": [
-                        "devDependencies.juisy"
-                    ]
-                }
-            }
+  "name": "create-juisy",
+  "version": "2.0.0-beta.15",
+  "description": "Juisy boilerplate for npm init",
+  "type": "module",
+  "bin": {
+    "create-juisy": "index.js"
+  },
+  "files": [
+    "template",
+    "index.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "release": "release-it --no-increment",
+    "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",
+  "dependencies": {
+    "execa": "^9.5.2",
+    "juisy": "2.0.0-beta.15",
+    "mri": "^1.2.0"
+  },
+  "release-it": {
+    "git": false,
+    "plugins": {
+      "@release-it/bumper": {
+        "out": {
+          "file": "package.json",
+          "path": [
+            "dependencies.juisy"
+          ]
         }
+      }
     }
+  }
 }

package/template/CONTRIBUTING.md

@@ -4,14 +4,54 @@
 
 Commit messages are linted with `commitlint` in the `commit-msg` git hook, following the **angular** convention. Please check the [commit convention](./COMMIT_CONVENTION.md).
 
+## Build
+
+Write here the instructions to build your code, if needed.
+
+To build, run the following command:
+
+```sh
+npm run build
+```
+
+## Tests
+
+### Units
+
+To run unit tests, run the following command:
+
+```sh
+npm run test
+# With coverage enabled
+npm run test:coverage
+# Watch mode
+npm run test:watch
+# With @vitest/ui
+npm run test:ui
+```
+
 ## Releases
 
 Run the following command to make a release:
 
 ```sh
-npm run release
+# Show help
+npm run release --help
+# Release a patch
+npm run release --increment patch
+# Release a specific version
+npm run release -i 2.0.0
+# To increment the current prerelease. For example:
+# from   1.0.0-beta.1
+# to     1.0.0-beta.2
+npm run release -i pre
 ```
 
+> 💡 See also:
+>
+> - the **juisy** [release tool documentation](<%= __JUISY_DOCS_HOMEPAGE__ %>)
+> - the **release-it** [package documentation](https://github.com/release-it/release-it)
+
 ## Documentation
 
 Run the following command to generate project documentation:

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

@@ -1,33 +1,30 @@
 /** @type {import('juisy/cli').Command} */
 export default new CLI.Command({
   command: 'test',
-  describe: 'Run project tests',
+  describe: 'Run project tests with vitest. Accepts all arguments of vitest command.',
   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'
-    })
+    cli.strict(false) // to forward all arguments
     return cli
   },
   async handler (args) {
-    const watchMode = args.watch || args.ui
     const { run } = CLI.InterfaceUtils
+
+    // Forward arguments to vitest command
+    const testCommandArgs = CLI.helpers.hideBin(process.argv).slice(1)
+
     /**
      * Run tests
      */
-    await run('vitest', [
-      ...(watchMode ? [] : [ 'run' ]),
-      ...(args.ui ? [ '--ui' ] : [])
-    ], { stdio: 'inherit' })
+    await run('npx', [
+      'vitest',
+      ...testCommandArgs
+    ])
+      // Prevent an error be thrown when Ctrl+C is pressed in watch mode
+      .catch((err) => {
+        if (err.exitCode !== 130) throw err
+      })
   }
 })

package/template/dev.config.js

@@ -42,5 +42,25 @@ export default {
         '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
+        'npm run build',
+        'node ./bin/cli docs generate:api',
+        'node ./bin/cli docs generate:readme',
+        'node ./bin/cli docs:cli:private',
+        'node ./bin/cli docs:cli:public'
+      ]
+    }
   }
 }

package/template/dev.config.ts

@@ -43,5 +43,25 @@ export default {
         '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
+        'npm run build',
+        'node ./bin/cli docs generate:api',
+        'node ./bin/cli docs generate:readme',
+        'node ./bin/cli docs:cli:private',
+        'node ./bin/cli docs:cli:public'
+      ]
+    }
   }
 } satisfies GlobalSettings

package/template/docs/readme/template.md

@@ -7,11 +7,12 @@
 
 ## Table of contents
 
-<%#
+<%%#
   // Table of contents is automatically injected here by
   // [remark-toc](https://github.com/remarkjs/remark-toc)
 -%>
 
+
 ## 🚀 Get started
 
 ```sh
@@ -59,6 +60,10 @@ Read the [documentation](https://hperchec.gitlab.io/juisy) to learn more!
 
 </details>
 
+## 🤝 Contribute
+
+See the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
+
 ## ✍ Author
 
 <%%= author %>
@@ -67,6 +72,10 @@ Read the [documentation](https://hperchec.gitlab.io/juisy) to learn more!
 
 <%%= license %>
 
+## 🧬 Changelog
+
+See all changes to this project in the [CHANGELOG.md](./CHANGELOG.md) file.
+
 ----
 
 Made with ❤ by <%%= author %>

package/template/package.json

@@ -1,5 +1,5 @@
 {
-    "name": "__PROJECT_NAME__",
+    "name": "<%= __PROJECT_NAME__ %>",
     "version": "1.0.0",
     "description": "New project based on Juisy template",
     "type": "module",
@@ -16,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"
     }
 }

package/template/tests/unit/example.spec.ts

@@ -0,0 +1,13 @@
+import { describe, it, expect } from 'vitest'
+
+/**
+ * See also Vitest documentation: https://vitest.dev/guide/
+ */
+
+// ---------------------------------------------------
+
+describe('Example test set', () => {
+  it('should return "foo"', () => {
+    expect('foo').toBe('foo')
+  })
+})

package/template/tests/unit/setup.unit.ts

@@ -0,0 +1,14 @@
+import { expect, afterAll, beforeAll } from 'vitest'
+
+// // Custom CSS matcher
+// expect.extend({
+//   toBeFoo ...
+// })
+
+beforeAll(() => {
+  // ...
+})
+
+afterAll(() => {
+  // ...
+})

package/template/tests/vitest.d.ts

@@ -0,0 +1,16 @@
+import 'vitest'
+
+/**
+ * Here, you can augment types from vitest.
+ * For example to add custom matchers
+ * See also: https://vitest.dev/guide/extending-matchers.html#extending-matchers
+ */
+
+interface CustomMatchers<R = unknown> {
+  toBeFoo: () => R
+}
+
+declare module 'vitest' {
+  interface Assertion<T = any> extends CustomMatchers<T> {}
+  interface AsymmetricMatchersContaining extends CustomMatchers {}
+}

package/template/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "Bundler",
+    "types": [
+      "vitest/globals",
+      "./tests/**/*.d.ts"
+    ]
+  },
+  "include": [
+    "tests/**/*.ts"
+  ],
+  "exclude": [
+    "bin",
+    "node_modules"
+  ]
+}

package/template/vite.config.ts

@@ -0,0 +1,22 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    setupFiles: [
+      './tests/unit/setup.unit.ts'
+    ],
+    include: [
+      './tests/**/*.spec.ts'
+    ],
+    coverage: {
+      enabled: true,
+      provider: 'v8',
+      reporter: [ 'text', 'json', 'html' ],
+      reportsDirectory: './tests/unit/.coverage',
+      include: [
+        // 'src/**'
+      ]
+    }
+  }
+})