@zeedhi/teknisa-cli 1.107.1 → 1.108.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Teknisa
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Teknisa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,5 @@
-# Teknisa CLI
-
-### Instalation ###
-To install, run:
-`npm install -g --save @zeedhi/teknisa-cli`
+# Teknisa CLI
+
+### Instalation ###
+To install, run:
+`npm install -g --save @zeedhi/teknisa-cli`

package/bin/teknisa.js

@@ -1,118 +1,118 @@
-#!/usr/bin/env node
-const chalk = require('chalk')
-const semver = require('semver')
-const requiredVersion = require('../package.json').engines.node
-
-function checkNodeVersion (wanted, id) {
-  if (!semver.satisfies(process.version, wanted)) {
-    console.log(chalk.red(
-      'You are using Node ' + process.version + ', but this version of ' + id +
-      ' requires Node ' + wanted + '.\nPlease upgrade your Node version.'
-    ))
-    process.exit(1)
-  }
-}
-
-checkNodeVersion(requiredVersion, 'teknisa-cli')
-
-const program = require('commander')
-const generateOptions = ['component']
-
-program
-  .version(require('../package').version)
-  .usage('<command> [options]')
-
-program
-  .command('create <app-name>')
-  .description('create a new Teknisa project using Zeedhi')
-  .option('-f, --force', 'Overwrite target directory if it exists')
-  .action(function(name, cmd) {
-    require('../src/create')(name, cleanArgs(cmd))
-  })
-
-program.on('--help', () => {
-  console.log()
-  console.log(`  Run ${chalk.cyan(`teknisa <command> --help`)} for detailed usage of given command.`)
-  console.log()
-})
-
-program
-  .arguments('<command>')
-  .action((cmd) => {
-    program.outputHelp()
-    console.log(`  ` + chalk.red(`Unknown command ${chalk.yellow(cmd)}.`))
-    console.log()
-  })
-
-program.commands.forEach(c => c.on('--help', () => console.log()))
-
-const enhanceErrorMessages = require('../src/util/enhanceErrorMessages')
-
-enhanceErrorMessages('missingArgument', argName => {
-  return `Missing required argument ${chalk.yellow(`<${argName}>`)}.`
-})
-
-enhanceErrorMessages('unknownArgument', argumentName => {
-  return `Unknown argument ${chalk.yellow(argumentName)}.`
-})
-
-enhanceErrorMessages('unknownOption', optionName => {
-  return `Unknown option ${chalk.yellow(optionName)}.`
-})
-
-enhanceErrorMessages('optionMissingArgument', (option, flag) => {
-  return `Missing required argument for option ${chalk.yellow(option.flags)}` + (
-    flag ? `, got ${chalk.yellow(flag)}` : ``
-  )
-})
-
-program.parse(process.argv)
-
-if (!process.argv.slice(2).length) {
-  program.outputHelp()
-}
-
-function camelize(str) {
-  return str.replace(/-(\w)/g, (_, c) => c ? c.toUpperCase() : '')
-}
-
-function cleanArgs(cmd) {
-  const args = {}
-  cmd.options.forEach(o => {
-    const key = camelize(o.long.replace(/^--/, ''))
-    // if an option is not present and Command has a method with the same name
-    // it should not be copied
-    if (typeof cmd[key] !== 'function' && typeof cmd[key] !== 'undefined') {
-      args[key] = cmd[key]
-    }
-  })
-  return args
-}
-
-function generateAction(type, name, cmd) {
-  if (type && name) {
-    if (generateOptions.find(option => option === type)) {
-      require('../src/generate')(name, cleanArgs(cmd))
-    } else {
-      this.unknownArgument(type)
-    }
-  } else {
-    this.outputHelp()
-  }
-}
-
-function generateHelper() {
-  console.log('')
-  console.log(chalk.white.bold('  Usage:'))
-  console.log('')
-  console.log(`    ${chalk.gray('$')} ${chalk.green('teknisa g <type> <name>')}`)
-  console.log('')
-  console.log(chalk.white.bold('  Inputs:'))
-  console.log('')
-  console.log(`    ${chalk.green('type')} ${chalk.gray('..........')} The type of feature (e.g. ${chalk.green(generateOptions.join(','))})`)
-  console.log(`    ${chalk.green('name')} ${chalk.gray('..........')} The name of the feature being generated`)
-  console.log('')
-  console.log(chalk.white.bold('  Examples:'))
-  console.log('')
-  console.log(`    ${chalk.gray('$')} ${chalk.green('teknisa g component zd-clock')}`)
+#!/usr/bin/env node
+const chalk = require('chalk')
+const semver = require('semver')
+const requiredVersion = require('../package.json').engines.node
+
+function checkNodeVersion (wanted, id) {
+  if (!semver.satisfies(process.version, wanted)) {
+    console.log(chalk.red(
+      'You are using Node ' + process.version + ', but this version of ' + id +
+      ' requires Node ' + wanted + '.\nPlease upgrade your Node version.'
+    ))
+    process.exit(1)
+  }
+}
+
+checkNodeVersion(requiredVersion, 'teknisa-cli')
+
+const program = require('commander')
+const generateOptions = ['component']
+
+program
+  .version(require('../package').version)
+  .usage('<command> [options]')
+
+program
+  .command('create <app-name>')
+  .description('create a new Teknisa project using Zeedhi')
+  .option('-f, --force', 'Overwrite target directory if it exists')
+  .action(function(name, cmd) {
+    require('../src/create')(name, cleanArgs(cmd))
+  })
+
+program.on('--help', () => {
+  console.log()
+  console.log(`  Run ${chalk.cyan(`teknisa <command> --help`)} for detailed usage of given command.`)
+  console.log()
+})
+
+program
+  .arguments('<command>')
+  .action((cmd) => {
+    program.outputHelp()
+    console.log(`  ` + chalk.red(`Unknown command ${chalk.yellow(cmd)}.`))
+    console.log()
+  })
+
+program.commands.forEach(c => c.on('--help', () => console.log()))
+
+const enhanceErrorMessages = require('../src/util/enhanceErrorMessages')
+
+enhanceErrorMessages('missingArgument', argName => {
+  return `Missing required argument ${chalk.yellow(`<${argName}>`)}.`
+})
+
+enhanceErrorMessages('unknownArgument', argumentName => {
+  return `Unknown argument ${chalk.yellow(argumentName)}.`
+})
+
+enhanceErrorMessages('unknownOption', optionName => {
+  return `Unknown option ${chalk.yellow(optionName)}.`
+})
+
+enhanceErrorMessages('optionMissingArgument', (option, flag) => {
+  return `Missing required argument for option ${chalk.yellow(option.flags)}` + (
+    flag ? `, got ${chalk.yellow(flag)}` : ``
+  )
+})
+
+program.parse(process.argv)
+
+if (!process.argv.slice(2).length) {
+  program.outputHelp()
+}
+
+function camelize(str) {
+  return str.replace(/-(\w)/g, (_, c) => c ? c.toUpperCase() : '')
+}
+
+function cleanArgs(cmd) {
+  const args = {}
+  cmd.options.forEach(o => {
+    const key = camelize(o.long.replace(/^--/, ''))
+    // if an option is not present and Command has a method with the same name
+    // it should not be copied
+    if (typeof cmd[key] !== 'function' && typeof cmd[key] !== 'undefined') {
+      args[key] = cmd[key]
+    }
+  })
+  return args
+}
+
+function generateAction(type, name, cmd) {
+  if (type && name) {
+    if (generateOptions.find(option => option === type)) {
+      require('../src/generate')(name, cleanArgs(cmd))
+    } else {
+      this.unknownArgument(type)
+    }
+  } else {
+    this.outputHelp()
+  }
+}
+
+function generateHelper() {
+  console.log('')
+  console.log(chalk.white.bold('  Usage:'))
+  console.log('')
+  console.log(`    ${chalk.gray('$')} ${chalk.green('teknisa g <type> <name>')}`)
+  console.log('')
+  console.log(chalk.white.bold('  Inputs:'))
+  console.log('')
+  console.log(`    ${chalk.green('type')} ${chalk.gray('..........')} The type of feature (e.g. ${chalk.green(generateOptions.join(','))})`)
+  console.log(`    ${chalk.green('name')} ${chalk.gray('..........')} The name of the feature being generated`)
+  console.log('')
+  console.log(chalk.white.bold('  Examples:'))
+  console.log('')
+  console.log(`    ${chalk.gray('$')} ${chalk.green('teknisa g component zd-clock')}`)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeedhi/teknisa-cli",
-  "version": "1.107.1",
+  "version": "1.108.0",
   "description": "Teknisa CLI",
   "author": "Zeedhi <zeedhi@teknisa.com>",
   "license": "ISC",
@@ -34,5 +34,5 @@
     "/src",
     "/bin"
   ],
-  "gitHead": "ce6aeb7a4ebfca43f9ecb85ed411037f6032d214"
+  "gitHead": "c23fc7d327e5cd145b75229b2dca54967ec803d3"
 }

package/src/create.js

@@ -1,119 +1,119 @@
-const fs = require('fs-extra')
-const path = require('path')
-const chalk = require('chalk')
-const clear = require('clear')
-const execa = require('execa')
-const inquirer = require('inquirer')
-const validateName = require('./util/validateName')
-
-async function create(name, options) {
-
-  const cwd = options.cwd || process.cwd()
-  const targetDir = path.resolve(cwd, name || '.')
-
-  validateName(name, targetDir, options)
-
-  if (fs.existsSync(targetDir) && !options.force) {
-    console.error(chalk.red(`Target directory "${name}" already exists`))
-    process.exit(1)
-  }
-
-  const { action } = await selectProjectType()
-  if (!action) return
-
-  const config = await getConfig(name, targetDir, action)
-  await startConfig(config, options)
-
-  console.log(`\nSuccessfully created project ${chalk.yellow(name)}.`)
-  console.log(
-    `${chalk.red('To learn how to configure your project check')} ` +
-    `${chalk.yellow('http://docs.zeedhi.com/teknisa/create-product')}\n\n` +
-    `Get started with the following commands:\n` +
-    chalk.cyan(` ${chalk.gray('$')} cd ${name}\n`) +
-    chalk.cyan(` ${chalk.gray('$')} npm run serve\n`)
-  )
-}
-
-async function startConfig(config, options) {
-  if (options.force) {
-    console.log(`Removing ${chalk.cyan(config.name)}...`)
-    fs.removeSync(config.targetDir)
-  }
-  await copyFiles(config.targetDir, config.action)
-  await createProject(config)
-  await installDeps(config.targetDir)
-}
-
-async function copyFiles(targetDir, action) {
-  console.log(`Copying files...`)
-  if (action === 'product') {
-    await fs.copy(__dirname + '/util/project/product', targetDir);
-  } else {
-    await fs.copy(__dirname + '/util/project/module', targetDir);
-  }
-}
-
-async function installDeps(targetDir) {
-  console.log(`Installing dependencies...`)
-  fs.removeSync(`${targetDir}/package-lock.json`)
-  return await execa('npm', ['install', '--loglevel', 'error'], {
-    cwd: targetDir,
-    stdio: ['inherit', 'inherit', 'inherit']
-  })
-}
-
-async function selectProjectType() {
-  return await inquirer.prompt([
-    {
-      name: 'action',
-      type: 'list',
-      message: 'Select a project type:',
-      choices: [
-        { name: 'Product', value: 'product' },
-        { name: 'Module', value: 'module' },
-        { name: 'Cancel', value: false }
-      ]
-    }
-  ])
-}
-
-async function getConfig(name, targetDir, action) {
-  return await {
-    name,
-    action,
-    targetDir,
-    version: (await getVersion()).version,
-    description: (await getDescription()).description,
-    staticAppMetadata: true,
-  }
-}
-
-async function getDescription() {
-  return await inquirer.prompt([
-    {
-      name: 'description',
-      type: 'input',
-      message: `Enter a project description:`,
-      default: 'Powered by Zeedhi',
-    }
-  ])
-}
-
-async function getVersion() {
-  return await inquirer.prompt([
-    {
-      name: 'version',
-      type: 'input',
-      message: `Enter a project version:`,
-      default: '0.1.0',
-    }
-  ])
-}
-
-async function createProject(config) {
-  return await require('./util/project/run')(config)
-}
-
-module.exports = (...args) => {
-  return create(...args)
+const fs = require('fs-extra')
+const path = require('path')
+const chalk = require('chalk')
+const clear = require('clear')
+const execa = require('execa')
+const inquirer = require('inquirer')
+const validateName = require('./util/validateName')
+
+async function create(name, options) {
+
+  const cwd = options.cwd || process.cwd()
+  const targetDir = path.resolve(cwd, name || '.')
+
+  validateName(name, targetDir, options)
+
+  if (fs.existsSync(targetDir) && !options.force) {
+    console.error(chalk.red(`Target directory "${name}" already exists`))
+    process.exit(1)
+  }
+
+  const { action } = await selectProjectType()
+  if (!action) return
+
+  const config = await getConfig(name, targetDir, action)
+  await startConfig(config, options)
+
+  console.log(`\nSuccessfully created project ${chalk.yellow(name)}.`)
+  console.log(
+    `${chalk.red('To learn how to configure your project check')} ` +
+    `${chalk.yellow('http://docs.zeedhi.com/teknisa/create-product')}\n\n` +
+    `Get started with the following commands:\n` +
+    chalk.cyan(` ${chalk.gray('$')} cd ${name}\n`) +
+    chalk.cyan(` ${chalk.gray('$')} npm run serve\n`)
+  )
+}
+
+async function startConfig(config, options) {
+  if (options.force) {
+    console.log(`Removing ${chalk.cyan(config.name)}...`)
+    fs.removeSync(config.targetDir)
+  }
+  await copyFiles(config.targetDir, config.action)
+  await createProject(config)
+  await installDeps(config.targetDir)
+}
+
+async function copyFiles(targetDir, action) {
+  console.log(`Copying files...`)
+  if (action === 'product') {
+    await fs.copy(__dirname + '/util/project/product', targetDir);
+  } else {
+    await fs.copy(__dirname + '/util/project/module', targetDir);
+  }
+}
+
+async function installDeps(targetDir) {
+  console.log(`Installing dependencies...`)
+  fs.removeSync(`${targetDir}/package-lock.json`)
+  return await execa('npm', ['install', '--loglevel', 'error'], {
+    cwd: targetDir,
+    stdio: ['inherit', 'inherit', 'inherit']
+  })
+}
+
+async function selectProjectType() {
+  return await inquirer.prompt([
+    {
+      name: 'action',
+      type: 'list',
+      message: 'Select a project type:',
+      choices: [
+        { name: 'Product', value: 'product' },
+        { name: 'Module', value: 'module' },
+        { name: 'Cancel', value: false }
+      ]
+    }
+  ])
+}
+
+async function getConfig(name, targetDir, action) {
+  return await {
+    name,
+    action,
+    targetDir,
+    version: (await getVersion()).version,
+    description: (await getDescription()).description,
+    staticAppMetadata: true,
+  }
+}
+
+async function getDescription() {
+  return await inquirer.prompt([
+    {
+      name: 'description',
+      type: 'input',
+      message: `Enter a project description:`,
+      default: 'Powered by Zeedhi',
+    }
+  ])
+}
+
+async function getVersion() {
+  return await inquirer.prompt([
+    {
+      name: 'version',
+      type: 'input',
+      message: `Enter a project version:`,
+      default: '0.1.0',
+    }
+  ])
+}
+
+async function createProject(config) {
+  return await require('./util/project/run')(config)
+}
+
+module.exports = (...args) => {
+  return create(...args)
 }

package/src/generate.js

@@ -1,21 +1,21 @@
-const path = require('path')
-const chalk = require('chalk')
-const validateName = require('./util/validateName')
-
-async function generate(name, options) {
-  const cwd = options.cwd || process.cwd()
-  let targetDir = path.resolve(cwd, '.')
-
-  if (options.path) {
-    targetDir = path.resolve(targetDir, options.path)
-  }
-
-  validateName(name, targetDir, options)
-  require('./util/component/run')(name, targetDir, options)
-  console.log(`\nSuccessfully created component ${chalk.yellow(name)} at path ${chalk.yellow(targetDir)}.`)
-
-}
-
-module.exports = (...args) => {
-  return generate(...args)
+const path = require('path')
+const chalk = require('chalk')
+const validateName = require('./util/validateName')
+
+async function generate(name, options) {
+  const cwd = options.cwd || process.cwd()
+  let targetDir = path.resolve(cwd, '.')
+
+  if (options.path) {
+    targetDir = path.resolve(targetDir, options.path)
+  }
+
+  validateName(name, targetDir, options)
+  require('./util/component/run')(name, targetDir, options)
+  console.log(`\nSuccessfully created component ${chalk.yellow(name)} at path ${chalk.yellow(targetDir)}.`)
+
+}
+
+module.exports = (...args) => {
+  return generate(...args)
 }