create-quasar 0.0.1 → 1.0.2

package/utils/index.js

@@ -0,0 +1,299 @@
+
+const { readFileSync, writeFileSync, existsSync } = require('fs')
+const { sep, normalize, join, resolve, extname } = require('path')
+const { emptyDirSync, ensureDirSync, ensureFileSync, copySync } = require('fs-extra')
+const prompts = require('prompts')
+const compileTemplate = require('lodash.template')
+const fglob = require('fast-glob')
+const { yellow, green } = require('kolorist')
+const exec = require('child_process').execSync
+const spawn = require('child_process').spawn
+
+const logger = require('./logger')
+
+const TEMPLATING_FILE_EXTENSIONS = [ '', '.json', '.js', '.ts', '.vue', '.md', '.html' ]
+
+module.exports.join = join
+module.exports.logger = logger
+
+module.exports.prompts = async function (scope, questions, opts) {
+  const options = opts || {
+    onCancel: () => {
+      logger.fatal('Scaffolding cancelled')
+    }
+  }
+
+  const answers = await prompts(questions, options)
+  Object.assign(scope, answers)
+}
+
+module.exports.createTargetDir = function (scope) {
+  console.log()
+  logger.log('Generating files...')
+  console.log()
+
+  const fn = scope.overwrite ? emptyDirSync : ensureDirSync
+  fn(scope.projectFolder)
+}
+
+module.exports.convertArrayToObject = function (arr) {
+  const acc = {}
+  arr.forEach(key => {
+    acc[key] = true
+  })
+  return acc
+}
+
+module.exports.runningPackageManager = (() => {
+  const userAgent = process.env.npm_config_user_agent
+
+  if (userAgent) {
+    return userAgent.split(' ')[0].split('/')[0]
+  }
+})()
+
+module.exports.renderTemplate = function (templateDir, scope) {
+  const files = fglob.sync(['**/*'], { cwd: templateDir })
+
+  for (const rawPath of files) {
+    const targetRelativePath = rawPath.split('/').map(name => {
+      // dotfiles are ignored when published to npm, therefore in templates
+      // we need to use underscore instead (e.g. "_gitignore")
+      return name.charAt(0) === '_'
+        ? `.${name.slice(1)}`
+        : name
+    }).join('/')
+
+    const targetPath = resolve(scope.projectFolder, targetRelativePath)
+    const sourcePath = resolve(templateDir, rawPath)
+    const extension = extname(targetRelativePath)
+
+    ensureFileSync(targetPath)
+
+    console.log(` ${green('-')} ${targetRelativePath}`)
+
+    if (TEMPLATING_FILE_EXTENSIONS.includes(extension)) {
+      const rawContent = readFileSync(sourcePath, 'utf-8')
+      const template = compileTemplate(rawContent, { 'interpolate': /<%=([\s\S]+?)%>/g })
+
+      const newContent = extension === '.json'
+        ? JSON.stringify(JSON.parse(template(scope)), null, 2)
+        : template(scope)
+
+      writeFileSync(targetPath, newContent, 'utf-8')
+    }
+    else {
+      copySync(sourcePath, targetPath)
+    }
+  }
+}
+
+module.exports.isValidPackageName = function (projectName) {
+  return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
+    projectName
+  )
+}
+
+module.exports.inferPackageName = function (projectFolder) {
+  return projectFolder
+    .trim()
+    .toLowerCase()
+    .replace(/\s+/g, '-')
+    .replace(/^[._]/, '')
+    .replace(/[^a-z0-9-~]+/g, '-')
+}
+
+module.exports.escapeString = function (val) {
+  return JSON.stringify(val).slice(1, -1)
+}
+
+function getGitUser () {
+  let name
+  let email
+
+  try {
+    name = exec('git config --get user.name')
+    email = exec('git config --get user.email')
+  }
+  catch (e) {}
+
+  name = name && JSON.stringify(name.toString().trim()).slice(1, -1)
+  email = email && (' <' + email.toString().trim() + '>')
+
+  return (name || '') + (email || '')
+}
+
+/**
+ * Prints the final message with instructions of necessary next steps.
+ *
+ * @param {Object} scope Data from questionnaire.
+ */
+module.exports.printFinalMessage = function (scope) {
+  const verPrefix = scope.quasarVersion ? scope.quasarVersion + '.' : ''
+  const message = `
+To get started:
+${yellow(`
+  cd ${scope.projectFolderName}${ scope.skipDepsInstall !== true && scope.packageManager === false ? `
+  yarn #or: npm install
+  yarn lint --fix # or: npm run lint -- --fix` : '' }${ scope.skipDepsInstall !== true ? `
+  quasar dev # or: yarn quasar dev # or: npx quasar dev` : '' }
+`)}
+Documentation can be found at: https://${verPrefix}quasar.dev
+
+Quasar is relying on donations to evolve. We'd be very grateful if you can
+read our manifest on "Why donations are important": https://${verPrefix}quasar.dev/why-donate
+Donation campaign: https://${verPrefix}donate.quasar.dev
+Any amount is very welcomed.
+If invoices are required, please first contact Razvan Stoenescu.
+
+Please give us a star on Github if you appreciate our work:
+  https://github.com/quasarframework/quasar
+
+Enjoy! - Quasar Team
+`
+
+  console.log(message)
+}
+
+function runCommand (cmd, args, options) {
+  console.log()
+  return new Promise((resolve, reject) => {
+    const runner = spawn(
+      cmd,
+      args,
+      Object.assign({
+        cwd: process.cwd(),
+        stdio: 'inherit',
+        shell: true,
+      }, options)
+    )
+
+    runner.on('exit', code => {
+      console.log()
+
+      if (code) {
+        console.log(` ${cmd} FAILED...`)
+        console.log()
+        reject()
+      }
+      else {
+        resolve()
+      }
+    })
+  })
+}
+
+module.exports.installDeps = function (scope) {
+  return runCommand(
+    scope.packageManager,
+    [ 'install' ],
+    { cwd: scope.projectFolder }
+  )
+}
+
+module.exports.lintFolder = function (scope) {
+  return runCommand(
+    scope.packageManager,
+    scope.packageManager === 'npm'
+      ? ['run', 'lint', '--', '--fix']
+      : ['run', 'lint', '--fix'],
+    { cwd: scope.projectFolder }
+  )
+}
+
+module.exports.ensureOutsideProject = function () {
+  let dir = process.cwd()
+
+  while (dir.length && dir[dir.length - 1] !== sep) {
+    if (
+      existsSync(join(dir, 'quasar.conf.js')) ||
+      existsSync(join(dir, 'quasar.config.js'))
+    ) {
+      logger.fatal(`Error. This command must NOT be executed inside of a Quasar project folder.`)
+    }
+
+    dir = normalize(join(dir, '..'))
+  }
+}
+
+const QUASAR_VERSIONS = [
+  { title: 'Quasar v2 (Vue 3 | latest and greatest)', value: 'v2', description: 'recommended' },
+  { title: 'Quasar v1 (Vue 2)', value: 'v1' }
+]
+const SCRIPT_TYPES = [
+  { title: 'Javascript', value: 'js' },
+  { title: 'Typescript', value: 'ts' }
+]
+
+module.exports.commonPrompts = {
+  quasarVersion: {
+    type: 'select',
+    name: 'quasarVersion',
+    message: 'Pick Quasar version:',
+    initial: 0,
+    choices: QUASAR_VERSIONS
+  },
+
+  scriptType: {
+    type: 'select',
+    name: 'scriptType',
+    message: 'Pick script type:',
+    initial: 0,
+    choices: SCRIPT_TYPES
+  },
+
+  productName: {
+    type: 'text',
+    name: 'productName',
+    message: 'Project product name: (must start with letter if building mobile apps)',
+    initial: 'Quasar App',
+    validate: val =>
+      val && val.length > 0 || 'Invalid product name'
+  },
+
+  description: {
+    type: 'text',
+    name: 'description',
+    message: 'Project description:',
+    initial: 'A Quasar Project',
+    format: module.exports.escapeString,
+    validate: val =>
+      val.length > 0 || 'Invalid project description'
+  },
+
+  author: {
+    type: 'text',
+    name: 'author',
+    initial: () => getGitUser(),
+    message: 'Author:'
+  },
+
+  license: {
+    type: 'text',
+    name: 'license',
+    message: 'License type',
+    initial: 'MIT'
+  },
+
+  repositoryType: {
+    type: 'text',
+    name: 'repositoryType',
+    message: 'Repository type:',
+    initial: 'git'
+  },
+  repositoryURL: {
+    type: 'text',
+    name: 'repositoryURL',
+    message: 'Repository URL: (eg https://github.com/quasarframework/quasar)'
+  },
+  homepage: {
+    type: 'text',
+    name: 'homepage',
+    message: 'Homepage URL:'
+  },
+  bugs: {
+    type: 'text',
+    name: 'bugs',
+    message: 'Issue reporting URL: (eg https://github.com/quasarframework/quasar/issues)'
+  }
+}

package/utils/logger.js

@@ -0,0 +1,134 @@
+const {
+  bgGreen, green,
+  inverse,
+  bgRed, red,
+  bgYellow, yellow,
+  black, white,
+  underline
+} = require('kolorist')
+
+const readline = require('readline')
+
+/**
+ * Pills
+ */
+
+const successPill = msg => bgGreen(black(` ${msg} `))
+const infoPill = msg => inverse(` ${msg} `)
+const errorPill = msg => bgRed(white(` ${msg} `))
+const warningPill = msg => bgYellow(black(` ${msg} `))
+
+/**
+ * Main approach
+ */
+
+const dot = '•'
+const banner = 'Quasar ' + dot
+const greenBanner = green(banner)
+const redBanner = red(banner)
+const yellowBanner = yellow(banner)
+const tipBanner = `${green('App')} ${dot} ${successPill('TIP')} ${dot} 🚀 `
+
+module.exports.dot = dot
+
+module.exports.clearConsole = process.stdout.isTTY
+  ? () => {
+      // Fill screen with blank lines. Then move to 0 (beginning of visible part) and clear it
+      const blank = '\n'.repeat(process.stdout.rows)
+      console.log(blank)
+      readline.cursorTo(process.stdout, 0, 0)
+      readline.clearScreenDown(process.stdout)
+    }
+  : () => {}
+
+module.exports.tip = function (msg) {
+  console.log(msg ? ` ${tipBanner} ${msg}` : '')
+}
+
+module.exports.log = function (msg) {
+  console.log(msg ? ` ${greenBanner} ${msg}` : '')
+}
+
+module.exports.warn = function (msg, pill) {
+  if (msg !== void 0) {
+    const pillBanner = pill !== void 0
+      ? bgYellow(black('', pill, '')) + ' '
+      : ''
+
+    console.warn(` ${yellowBanner} ⚠️  ${pillBanner}${msg}`)
+  }
+  else {
+    console.warn()
+  }
+}
+
+module.exports.fatal = function (msg, pill) {
+  if (msg !== void 0) {
+    const pillBanner = pill !== void 0
+      ? errorPill(pill) + ' '
+      : ''
+
+    console.error(`\n ${redBanner} ⚠️  ${pillBanner}${msg}\n`)
+  }
+  else {
+    console.error()
+  }
+
+  process.exit(1)
+}
+
+/**
+ * Extended approach - Status & pills
+ */
+
+module.exports.successPill = successPill
+module.exports.success = function (msg, title = 'SUCCESS') {
+  console.log(` ${greenBanner} ${successPill(title)} ${green(dot + ' ' + msg)}`)
+}
+module.exports.getSuccess = function (msg, title) {
+  return ` ${greenBanner} ${successPill(title)} ${green(dot + ' ' + msg)}`
+}
+
+module.exports.infoPill = infoPill
+module.exports.info = function (msg, title = 'INFO') {
+  console.log(` ${greenBanner} ${infoPill(title)} ${green(dot)} ${msg}`)
+}
+module.exports.getInfo = function (msg, title) {
+  return ` ${greenBanner} ${infoPill(title)} ${green(dot)} ${msg}`
+}
+
+module.exports.errorPill = errorPill
+module.exports.error = function (msg, title = 'ERROR') {
+  console.log(` ${redBanner} ${errorPill(title)} ${red(dot + ' ' + msg)}`)
+}
+module.exports.getError = function (msg, title = 'ERROR') {
+  return ` ${redBanner} ${errorPill(title)} ${red(dot + ' ' + msg)}`
+}
+
+module.exports.warningPill = warningPill
+module.exports.warning = function (msg, title = 'WARNING') {
+  console.log(` ${yellowBanner} ${warningPill(title)} ${yellow(dot + ' ' + msg)}`)
+}
+module.exports.getWarning = function (msg, title = 'WARNING') {
+  return ` ${yellowBanner} ${warningPill(title)} ${yellow(dot + ' ' + msg)}`
+}
+
+/**
+ * Progress related
+ */
+
+module.exports.progress = function start (msg, token) {
+  const parseMsg = token !== void 0
+    ? text => text.replace('___', underline(green(token)))
+    : text => text
+
+  module.exports.info(parseMsg(msg), 'WAIT')
+
+  const startTime = Date.now()
+
+  return msg => {
+    const diffTime = +new Date() - startTime
+    module.exports.success(`${parseMsg(msg)} ${dot} ${diffTime}ms`, 'DONE')
+    module.exports.log()
+  }
+}