create-juisy 2.0.0-beta.9 → 2.1.0

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/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/**'
+      ]
+    }
+  }
+})

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' ])
-  }
-})

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

@@ -1,223 +0,0 @@
-// 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/lib/docs/generate-api-doc.js

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

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

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

@@ -1,51 +0,0 @@
-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 })
-}