juisy 2.0.0-beta.0 → 2.0.0-beta.8

package/template/bin/cli/cli.js

@@ -1,27 +0,0 @@
-const { createCli, utils } = require('@hperchec/juisy')
-const path = require('path')
-const {
-  rootDir,
-  $style
-} = utils
-// Get package.json content
-const packageJson = require(path.resolve(rootDir, './package.json'))
-
-function getBanner () {
-  let str = ''
-  const title = $style.bold('CLI: ') + packageJson.name
-  const length = title.length - 9 // removes characters generated by $style.bold from length
-  str += $style.cyan('-'.repeat(length) + '\n')
-  str += $style.cyan(title + '\n')
-  str += $style.cyan('-'.repeat(length) + '\n')
-  str += $style.italic('Made with') + ' ' + $style.red('❤') + '  ' + $style.italic('by ') + $style.bold('Hervé Perchec <contact@herve-perchec.com') + '\n'
-  return str
-}
-
-// CLI
-module.exports = createCli(cli => cli
-  .scriptName('./bin/cli')
-  .usage(`${getBanner()}\nUsage: $0 <command> [<options>]`)
-  .commandDir('cmds')
-  .demandCommand(1, ('Command is missing. See help to learn more.').red)
-)

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

@@ -1,71 +0,0 @@
-const juisy = require('@hperchec/juisy')
-
-// Utils
-const {
-  $style,
-  log,
-  step,
-  substep,
-  run,
-  error,
-  wait
-} = juisy.utils
-
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'changelog',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Generate changelog file with conventional-changelog-cli',
-  /**
-   * Builder
-   * @param {Object} yargs
-   * @return {Object}
-   */
-  builder: function (yargs) {
-    return yargs.option('i', {
-      alias: 'infile',
-      type: 'string',
-      describe: 'Same as conventional-changelog option',
-      default: 'CHANGELOG.md',
-      requiresArg: true
-    })
-  },
-  /**
-   * Handler
-   * @param {Object} argv - The argv
-   * @return {void}
-   */
-  handler: async function (argv) {
-    /**
-     * 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 })
-    log() // Blank line
-  }
-}

package/template/bin/cli/cmds/docs.js

@@ -1,30 +0,0 @@
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'docs <command>',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Manage project documentation',
-  /**
-   * Builder
-   * @param {Object} yargs
-   * @return {Object}
-   */
-  builder: function (yargs) {
-    return yargs.commandDir('docs_cmds')
-      .demandCommand(1, ('Command is missing. See help to learn more.').red)
-  },
-  /**
-   * Handler
-   * @param {Object} argv - The argv
-   * @return {void}
-   */
-  handler: async function (argv) {}
-}

package/template/bin/cli/cmds/docs_cmds/generate-api.js

@@ -1,75 +0,0 @@
-const fs = require('fs-extra')
-const path = require('path')
-const juisy = require('@hperchec/juisy')
-
-const {
-  rootDir,
-  $style,
-  log,
-  step,
-  substep,
-  error,
-  abort
-} = juisy.utils
-
-const generateAPIDoc = require('../../lib/docs/generate-api-doc')
-
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'generate:api',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Generate docs from source code',
-  /**
-   * Builder
-   * @param {Object} yargs
-   * @return {Object}
-   */
-  builder: function (yargs) {
-    yargs.option('c', {
-      alias: 'config',
-      type: 'string',
-      default: './docs/api/docs.config.js',
-      describe: 'Path to custom config file relative to root folder (default: "./docs/api/docs.config.js")',
-      requiresArg: true
-    })
-    return yargs
-  },
-  /**
-   * Handler
-   * @param {Object} argv - The argv
-   * @return {void}
-   */
-  handler: async function (argv) {
-    let options = {}
-
-    /**
-     * Process config option
-     */
-    step('Configuration')
-    const configPath = path.resolve(rootDir, argv.config)
-    // Check if file exist
-    if (fs.existsSync(configPath)) {
-      options = require(configPath)
-    } else {
-      // Else log error and exit
-      error(`Can't find config file: "${configPath}"`)
-      abort(1)
-    }
-    substep($style.green('✔ Successfuly configured'), { last: true })
-    log() // blank line
-
-    /**
-     * Call generateAPIDoc function
-     */
-    await generateAPIDoc(options)
-  }
-}

package/template/bin/cli/cmds/docs_cmds/generate-readme.js

@@ -1,51 +0,0 @@
-const juisy = require('@hperchec/juisy')
-
-const { run } = juisy.utils
-
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'generate:readme',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Generate README.md file based on template with @hperchec/readme-generator package',
-  /**
-   * Builder
-   * @param {Object} yargs
-   * @return {Object}
-   */
-  builder: function (yargs) {
-    yargs.option('c', {
-      alias: 'config',
-      type: 'string',
-      describe: 'Same as @hperchec/readme-generator --config option',
-      requiresArg: true
-    })
-    return yargs
-  },
-  /**
-   * Handler
-   * @param {Object} argv - The argv
-   * @return {void}
-   */
-  handler: async function (argv) {
-    /**
-     * Call readme-generator command
-     */
-    await run(
-      'npx',
-      [
-        'readme-generator',
-        ...(argv.config ? [ '--config', argv.config ] : [])
-      ],
-      { stdio: 'inherit' }
-    )
-  }
-}

package/template/bin/cli/cmds/git-hooks.js

@@ -1,30 +0,0 @@
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'git-hooks <command>',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Git relative commands',
-  /**
-   * Builder
-   * @param {Object} yargs
-   * @return {Object}
-   */
-  builder: function (yargs) {
-    return yargs.commandDir('git_hooks_cmds')
-      .demandCommand(1, ('Command is missing. See help to learn more.').red)
-  },
-  /**
-   * Handler
-   * @param {Object} argv - The argv
-   * @return {void}
-   */
-  handler: async function (argv) {}
-}

package/template/bin/cli/cmds/git_hooks_cmds/reset.js

@@ -1,76 +0,0 @@
-const fs = require('fs-extra')
-const path = require('path')
-const juisy = require('@hperchec/juisy')
-
-const {
-  $style,
-  abort,
-  log,
-  rootDir,
-  step,
-  substep,
-  run
-} = juisy.utils
-
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'reset',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Reset git hooks',
-  /**
-   * Builder
-   * @param {object} yargs - yargs
-   * @returns {object} Returns yargs
-   */
-  builder: function (yargs) {
-    return yargs
-  },
-  /**
-   * Handler
-   * @param {object} argv - The argv
-   * @returns {void}
-   */
-  handler: async function (argv) {
-    /**
-     * 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 })
-      log() // blank line
-    }
-  }
-}

package/template/bin/cli/cmds/git_hooks_cmds/sync.js

@@ -1,44 +0,0 @@
-const juisy = require('@hperchec/juisy')
-
-const {
-  rootDir,
-  step,
-  run
-} = juisy.utils
-
-// Exports command object
-module.exports = {
-  /**
-   * Command syntax
-   */
-  command: 'sync',
-  /**
-   * Aliases
-   */
-  aliases: [],
-  /**
-   * Command description
-   */
-  describe: 'Sync git hooks',
-  /**
-   * Builder
-   * @param {object} yargs - yargs
-   * @returns {object} Returns yargs
-   */
-  builder: function (yargs) {
-    return yargs
-  },
-  /**
-   * Handler
-   * @param {object} argv - The argv
-   * @returns {void}
-   */
-  handler: async function (argv) {
-    /**
-     * Sync git hooks
-     */
-    step('Sync git hooks')
-
-    await run('npx', [ 'simple-git-hooks' ], { cwd: rootDir })
-  }
-}

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

@@ -1,219 +0,0 @@
-const juisy = require('@hperchec/juisy')
-const path = require('path')
-const semver = require('semver')
-
-const {
-  rootDir,
-  $style,
-  log,
-  step,
-  substep,
-  run,
-  error,
-  wait,
-  abort,
-  prompts
-} = juisy.utils
-
-// Get package.json content
-const packageJson = require(path.resolve(rootDir, './package.json'))
-const updateVersion = require('../lib/version/update-version')
-
-// Exports command object
-module.exports = {
-  /**
-   * 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' })
-    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
-     */
-    const { confirmed } = await prompts([
-      {
-        type: 'confirm',
-        name: 'confirmed',
-        message: `Releasing v${targetVersion}. Confirm?`,
-        initial: true
-      }
-    ])
-    if (!confirmed) {
-      abort()
-      return // exit if not confirmed
-    }
-    log() // Blank line
-
-    /**
-     * Run tests
-     */
-    step('Running tests')
-    await wait('Testing', async () => {
-      await run('npm', [ 'run', 'test' ], { stdio: 'pipe' })
-    })
-    substep($style.green('✔ Success'), { last: true })
-    log() // Blank line
-
-    /**
-     * Update version in necessary files
-     */
-    await updateVersion(targetVersion)
-    log() // Blank line
-
-    /**
-     * Generate changelog file
-     */
-    step('Generating changelog')
-    await wait('Generating', async () => {
-      await run('node', [ './bin/cli', 'changelog' ], { stdio: 'pipe' })
-    })
-    substep($style.green('✔ Success'), { last: true })
-    log() // Blank line
-
-    /**
-     * Publish package
-     */
-    step(`Publishing ${packageName}`)
-    // Skip by default
-    substep($style.yellow('Not configured. Skipping...'), { last: true })
-    log()
-    // OR: Uncomment to auto-publish package
-    //
-    // 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' })
-    //   } 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' })
-        await run('git', [ 'commit', '-m', `release: v${targetVersion}` ], { stdio: 'pipe' })
-      } 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' })
-      } catch (e) {
-        error('Unable to create tag', e)
-      }
-    })
-    substep($style.green('✔ Tagged'))
-    await wait('Pushing', async () => {
-      try {
-        await run('git', [ 'push', 'origin', '--follow-tags' ], { stdio: 'pipe' })
-      } catch (e) {
-        error('Unable to push', e)
-      }
-    })
-    substep($style.green('✔ Pushed'), { last: true })
-    log() // blank line
-
-    log($style.green(`✔ Release v${targetVersion} successfuly created`))
-    log()
-  }
-}

package/template/bin/cli/index.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-
-'use strict'
-
-const cli = require('./cli')
-
-cli().parse(process.argv.slice(2))

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