juisy 2.0.0-beta.0 → 2.0.0-beta.1

package/bin/cli/cmds/eject.js

@@ -1,28 +0,0 @@
-import { eject } from '#juisy'
-
-/** @type {import('#juisy/cli').Command} */
-export default new CLI.Command({
-  command: 'eject <identifier>',
-  describe: 'Eject file from juisy template to project directory',
-  builder (cli) {
-    cli.option('f', {
-      alias: 'force',
-      type: 'boolean',
-      default: false,
-      describe: 'Overwrites existing files'
-    })
-    cli.option('l', {
-      alias: 'log-level',
-      type: 'string',
-      default: 'trace',
-      describe: 'Can be one of: trace, debug, info, warn, error, silent'
-    })
-    return cli
-  },
-  async handler (argv) {
-    await eject(argv.identifier, {
-      force: argv.force,
-      logLevel: argv['log-level']
-    })
-  }
-})

package/bin/cli/cmds/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/bin/cli/cmds/git-hooks/reset.js

@@ -1,48 +0,0 @@
-import path from '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/bin/cli/cmds/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/bin/cli/cmds/release.js

@@ -1,231 +0,0 @@
-const path = require('path')
-const semver = require('semver')
-const juisy = require('../../../src')
-
-const {
-  $style,
-  log,
-  step,
-  substep,
-  run,
-  error,
-  wait,
-  confirm,
-  prompts
-} = juisy.utils
-
-const rootDir = path.resolve(__dirname, '../../../')
-
-// Get package.json content
-const packageJson = require(path.resolve(rootDir, './package.json'))
-const updateVersion = require('../lib/version/update-version')
-
-// Exports command object
-module.exports = {
-  private: true,
-  /**
-   * Command syntax
-   */
-  command: 'release',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Make a release',
-  /**
-   * Builder
-   * @param {Object} yargs
-   * @return {Object}
-   */
-  builder: function (yargs) {
-    return yargs.option('p', {
-      alias: 'preid',
-      type: 'string',
-      describe: 'Pre-release id',
-      requiresArg: true
-    })
-  },
-  /**
-   * Handler
-   * @param {Object} argv - The argv
-   * @return {void}
-   */
-  handler: async function (argv) {
-    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/bin/cli/lib/docs/generate-api-doc.js

@@ -1,78 +0,0 @@
-// import fs from 'fs-extra'
-// import jsdoc2md from 'jsdoc-to-markdown'
-import path from 'path'
-import { InterfaceUtils, OutputUtils } from '#juisy/cli'
-
-// utils
-const { rootDir } = InterfaceUtils
-const {
-  $style,
-  log,
-  step,
-  substep
-} = OutputUtils
-
-// Default config
-const defaultConfig = {
-  outputDir: 'documentation',
-  jsdoc: {
-    configPath: undefined
-  },
-  jsdoc2md: {
-    partial: []
-  }
-}
-
-/**
- * Generate API doc function
- * @param {object} [options = {}] - The options object
- * @returns {void}
- */
-export default async function generateApiDoc (options = {}) {
-  // Process options
-  options = merge(defaultConfig, options)
-
-  const docs = {
-    API: {
-      sourcePath: path.resolve(rootDir, './src/index.js'),
-      destPath: path.resolve(rootDir, './documentation/api.md')
-    },
-    Utils: {
-      sourcePath: path.resolve(rootDir, './src/utils/index.js'),
-      destPath: path.resolve(rootDir, './documentation/utils.md')
-    }
-  }
-
-  /**
-   * Generate doc
-   */
-  step('Generate doc')
-
-  // // Loop on docs
-  // for (const name in docs) {
-  //   const sourcePath = docs[name].sourcePath
-  //   const destPath = docs[name].destPath
-
-  //   let genResult
-  //   await wait(`Generating "${name}"`, async () => {
-  //     genResult = await jsdoc2md.render({
-  //       'no-cache': Boolean(options.jsdoc.configPath),
-  //       files: sourcePath,
-  //       template: `# ${name} documentation\n\n{{>main}}`,
-  //       partial: options.jsdoc2md.partial,
-  //       configure: options.jsdoc.configPath
-  //     })
-  //   })
-  //   // f*cking windows compat:
-  //   // jsdoc2md will generate CR (\r) character for @example blocks content line endings
-  //   genResult = genResult.replace(/\r(\n)?/g, '\n')
-  //   // Write output
-  //   await wait(`Writing file "${path.basename(destPath)}"`, async () => {
-  //     await fs.writeFile(destPath, genResult, { encoding: 'utf8' })
-  //   })
-  //   substep(`File "${path.basename(destPath)}" successfuly generated`)
-  // }
-
-  substep($style.green('✔ Success'), { last: true })
-  log() // Blank line
-}

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

@@ -1,52 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-const juisy = require('../../../../src')
-
-const {
-  $style,
-  error,
-  step,
-  substep,
-  run,
-  wait
-} = juisy.utils
-
-const rootDir = path.resolve(__dirname, '../../../../')
-
-// 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', cwd: rootDir })
-    } catch (e) {
-      error('Unable to update package-lock.json file', e)
-    }
-  })
-  substep($style.green('✔ package-lock.json successfuly updated'), { last: true })
-}

package/bin/scripts/commit-msg.js

@@ -1,32 +0,0 @@
-import run from 'execa'
-/**
- * commit-msg git hook
- */
-;(async function () {
-  console.log('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
-    ])
-  } catch (e) {
-    console.error('❌ Git hook: "commit-msg" failed. Please check ./COMMIT_CONVENTION.md for more informations.', e)
-    console.log() // blank line
-    process.exit(1) // Abort with error
-  }
-
-  // Everything is okay
-  console.log('✔ Git hook: "commit-msg" passed')
-
-  console.log() // blank line
-})()

package/bin/scripts/pre-commit.js

@@ -1,24 +0,0 @@
-import run from 'execa'
-
-/**
- * Pre commit git hook
- */
-;(async function () {
-  console.log('Git hook: pre-commit')
-
-  try {
-    // npx lint-staged
-    await run('npx', [
-      'lint-staged'
-    ], { stdio: 'pipe' })
-  } catch (e) {
-    console.error('Git hook: "commit-msg" error: ', e)
-    console.log() // blank line
-    process.exit(1)
-  }
-
-  // Everything is okay
-  console.log('✔ Git hook: "pre-commit" passed')
-
-  console.log() // blank line
-})()

package/dist/cli/command-visitors/index.d.ts

@@ -1,9 +0,0 @@
-import * as commandHandlerInjections from './command-handler-injections';
-import * as getCommandMeta from './get-command-meta';
-import * as privateCommand from './private-command';
-declare const _default: {
-    commandHandlerInjections: typeof commandHandlerInjections;
-    getCommandMeta: typeof getCommandMeta;
-    privateCommand: typeof privateCommand;
-};
-export default _default;