create-quasar 1.5.6 → 1.6.0

package/utils/index.js

@@ -1,33 +1,34 @@
+import { readFileSync, writeFileSync, existsSync } from 'node:fs'
+import { fileURLToPath } from 'node:url'
+import { sep, normalize, join as pathJoin, resolve, extname } from 'node:path'
+import { spawn, execSync as exec } from 'node:child_process'
 
-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
+import { emptyDirSync, ensureDirSync, ensureFileSync, copySync } from 'fs-extra/esm'
+import promptUser from 'prompts'
+import compileTemplate from 'lodash/template.js'
+import fglob from 'fast-glob'
+import { yellow, green } from 'kolorist'
 
-const logger = require('./logger')
+import logger from './logger.js'
 
 const TEMPLATING_FILE_EXTENSIONS = [ '', '.json', '.js', '.cjs', '.ts', '.vue', '.md', '.html', '.sass' ]
 
-module.exports.join = join
-module.exports.logger = logger
+function join (importMetaUrl, targetPath) {
+  return fileURLToPath(new URL('./' + targetPath, importMetaUrl))
+}
 
-module.exports.prompts = async function (scope, questions, opts) {
+async function prompts (scope, questions, opts) {
   const options = opts || {
     onCancel: () => {
       logger.fatal('Scaffolding cancelled')
     }
   }
 
-  const answers = await prompts(questions, options)
+  const answers = await promptUser(questions, options)
   Object.assign(scope, answers)
 }
 
-module.exports.createTargetDir = function (scope) {
+function createTargetDir (scope) {
   console.log()
   logger.log('Generating files...')
   console.log()
@@ -36,24 +37,24 @@ module.exports.createTargetDir = function (scope) {
   fn(scope.projectFolder)
 }
 
-module.exports.convertArrayToObject = function (arr) {
+function convertArrayToObject (arr) {
   const acc = {}
   arr.forEach(key => {
-    acc[key] = true
+    acc[ key ] = true
   })
   return acc
 }
 
-module.exports.runningPackageManager = (() => {
+const runningPackageManager = (() => {
   const userAgent = process.env.npm_config_user_agent
 
   if (userAgent) {
-    return userAgent.split(' ')[0].split('/')[0]
+    return userAgent.split(' ')[ 0 ].split('/')[ 0 ]
   }
 })()
 
-module.exports.renderTemplate = function (templateDir, scope) {
-  const files = fglob.sync(['**/*'], { cwd: templateDir })
+function renderTemplate (templateDir, scope) {
+  const files = fglob.sync([ '**/*' ], { cwd: templateDir })
 
   for (const rawPath of files) {
     const targetRelativePath = rawPath.split('/').map(name => {
@@ -72,11 +73,11 @@ module.exports.renderTemplate = function (templateDir, scope) {
 
     ensureFileSync(targetPath)
 
-    console.log(` ${green('-')} ${targetRelativePath}`)
+    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 template = compileTemplate(rawContent, { interpolate: /<%=([\s\S]+?)%>/g })
 
       const newContent = extension === '.json'
         ? JSON.stringify(JSON.parse(template(scope)), null, 2)
@@ -90,13 +91,13 @@ module.exports.renderTemplate = function (templateDir, scope) {
   }
 }
 
-module.exports.isValidPackageName = function (projectName) {
+function isValidPackageName (projectName) {
   return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
     projectName
   )
 }
 
-module.exports.inferPackageName = function (projectFolder) {
+function inferPackageName (projectFolder) {
   return projectFolder
     .trim()
     .toLowerCase()
@@ -105,7 +106,7 @@ module.exports.inferPackageName = function (projectFolder) {
     .replace(/[^a-z0-9-~]+/g, '-')
 }
 
-module.exports.escapeString = function (val) {
+function escapeString (val) {
   return JSON.stringify(val).slice(1, -1)
 }
 
@@ -130,20 +131,20 @@ function getGitUser () {
  *
  * @param {Object} scope Data from questionnaire.
  */
-module.exports.printFinalMessage = function (scope) {
+function printFinalMessage (scope) {
   const verPrefix = scope.quasarVersion ? scope.quasarVersion + '.' : ''
   const message = `
 To get started:
-${yellow(`
-  cd ${scope.projectFolderName}${ scope.skipDepsInstall !== true && scope.packageManager === false ? `
+${ 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
+`) }
+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
+read our manifest on "Why donations are important": https://${ verPrefix }quasar.dev/why-donate
 Donation campaign: https://donate.quasar.dev
 Any amount is very welcome.
 If invoices are required, please first contact Razvan Stoenescu.
@@ -166,7 +167,7 @@ function runCommand (cmd, args, options) {
       Object.assign({
         cwd: process.cwd(),
         stdio: 'inherit',
-        shell: true,
+        shell: true
       }, options)
     )
 
@@ -174,7 +175,7 @@ function runCommand (cmd, args, options) {
       console.log()
 
       if (code) {
-        console.log(` ${cmd} FAILED...`)
+        console.log(` ${ cmd } FAILED...`)
         console.log()
         reject()
       }
@@ -185,7 +186,7 @@ function runCommand (cmd, args, options) {
   })
 }
 
-module.exports.installDeps = function (scope) {
+function installDeps (scope) {
   return runCommand(
     scope.packageManager,
     [ 'install' ],
@@ -193,12 +194,12 @@ module.exports.installDeps = function (scope) {
   )
 }
 
-module.exports.lintFolder = function (scope) {
+function lintFolder (scope) {
   return runCommand(
     scope.packageManager,
     scope.packageManager === 'npm'
-      ? ['run', 'lint', '--', '--fix']
-      : ['run', 'lint', '--fix'],
+      ? [ 'run', 'lint', '--', '--fix' ]
+      : [ 'run', 'lint', '--fix' ],
     { cwd: scope.projectFolder }
   )
 }
@@ -211,18 +212,18 @@ const quasarConfigFilenameList = [
   'quasar.conf.js' // legacy
 ]
 
-module.exports.ensureOutsideProject = function () {
+function ensureOutsideProject () {
   let dir = process.cwd()
 
-  while (dir.length && dir[dir.length - 1] !== sep) {
+  while (dir.length && dir[ dir.length - 1 ] !== sep) {
     for (const name of quasarConfigFilenameList) {
-      const filename = join(dir, name)
+      const filename = pathJoin(dir, name)
       if (existsSync(filename)) {
-        logger.fatal(`Error. This command must NOT be executed inside of a Quasar project folder.`)
+        logger.fatal('Error. This command must NOT be executed inside of a Quasar project folder.')
       }
     }
 
-    dir = normalize(join(dir, '..'))
+    dir = normalize(pathJoin(dir, '..'))
   }
 }
 
@@ -235,7 +236,7 @@ const SCRIPT_TYPES = [
   { title: 'Typescript', value: 'ts' }
 ]
 
-module.exports.commonPrompts = {
+const commonPrompts = {
   quasarVersion: {
     type: 'select',
     name: 'quasarVersion',
@@ -258,7 +259,7 @@ module.exports.commonPrompts = {
     message: 'Project product name: (must start with letter if building mobile apps)',
     initial: 'Quasar App',
     validate: val =>
-      val && val.length > 0 || 'Invalid product name'
+      (val && val.length > 0) || 'Invalid product name'
   },
 
   description: {
@@ -266,7 +267,7 @@ module.exports.commonPrompts = {
     name: 'description',
     message: 'Project description:',
     initial: 'A Quasar Project',
-    format: module.exports.escapeString,
+    format: escapeString,
     validate: val =>
       val.length > 0 || 'Invalid project description'
   },
@@ -307,3 +308,23 @@ module.exports.commonPrompts = {
     message: 'Issue reporting URL: (eg https://github.com/quasarframework/quasar/issues)'
   }
 }
+
+export default {
+  logger,
+
+  join,
+  prompts,
+  createTargetDir,
+  convertArrayToObject,
+  runningPackageManager,
+  renderTemplate,
+  isValidPackageName,
+  inferPackageName,
+
+  printFinalMessage,
+  installDeps,
+  lintFolder,
+  ensureOutsideProject,
+
+  commonPrompts
+}

package/utils/logger.js

@@ -1,22 +1,22 @@
-const {
+import {
   bgGreen, green,
   inverse,
   bgRed, red,
   bgYellow, yellow,
   black, white,
   underline
-} = require('kolorist')
+} from 'kolorist'
 
-const readline = require('readline')
+import readline from 'node: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} `))
+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
@@ -27,11 +27,9 @@ const banner = 'Quasar ' + dot
 const greenBanner = green(banner)
 const redBanner = red(banner)
 const yellowBanner = yellow(banner)
-const tipBanner = `${green('App')} ${dot} ${successPill('TIP')} ${dot} 🚀 `
+const tipBanner = `${ green('App') } ${ dot } ${ successPill('TIP') } ${ dot } 🚀 `
 
-module.exports.dot = dot
-
-module.exports.clearConsole = process.stdout.isTTY
+const 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)
@@ -41,34 +39,34 @@ module.exports.clearConsole = process.stdout.isTTY
     }
   : () => {}
 
-module.exports.tip = function (msg) {
-  console.log(msg ? ` ${tipBanner} ${msg}` : '')
+function tip (msg) {
+  console.log(msg ? ` ${ tipBanner } ${ msg }` : '')
 }
 
-module.exports.log = function (msg) {
-  console.log(msg ? ` ${greenBanner} ${msg}` : '')
+function log (msg) {
+  console.log(msg ? ` ${ greenBanner } ${ msg }` : '')
 }
 
-module.exports.warn = function (msg, pill) {
+function warn (msg, pill) {
   if (msg !== void 0) {
     const pillBanner = pill !== void 0
       ? bgYellow(black('', pill, '')) + ' '
       : ''
 
-    console.warn(` ${yellowBanner} ⚠️  ${pillBanner}${msg}`)
+    console.warn(` ${ yellowBanner } ⚠️  ${ pillBanner }${ msg }`)
   }
   else {
     console.warn()
   }
 }
 
-module.exports.fatal = function (msg, pill) {
+function fatal (msg, pill) {
   if (msg !== void 0) {
     const pillBanner = pill !== void 0
       ? errorPill(pill) + ' '
       : ''
 
-    console.error(`\n ${redBanner} ⚠️  ${pillBanner}${msg}\n`)
+    console.error(`\n ${ redBanner } ⚠️  ${ pillBanner }${ msg }\n`)
   }
   else {
     console.error()
@@ -81,54 +79,79 @@ module.exports.fatal = function (msg, pill) {
  * Extended approach - Status & pills
  */
 
-module.exports.successPill = successPill
-module.exports.success = function (msg, title = 'SUCCESS') {
-  console.log(` ${greenBanner} ${successPill(title)} ${green(dot + ' ' + msg)}`)
+function success (msg, title = 'SUCCESS') {
+  console.log(` ${ greenBanner } ${ successPill(title) } ${ green(dot + ' ' + msg) }`)
 }
-module.exports.getSuccess = function (msg, title) {
-  return ` ${greenBanner} ${successPill(title)} ${green(dot + ' ' + msg)}`
+function getSuccess (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}`)
+function info (msg, title = 'INFO') {
+  console.log(` ${ greenBanner } ${ infoPill(title) } ${ green(dot) } ${ msg }`)
 }
-module.exports.getInfo = function (msg, title) {
-  return ` ${greenBanner} ${infoPill(title)} ${green(dot)} ${msg}`
+function getInfo (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)}`)
+function error (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)}`
+function getError (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)}`)
+function warning (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)}`
+function getWarning (msg, title = 'WARNING') {
+  return ` ${ yellowBanner } ${ warningPill(title) } ${ yellow(dot + ' ' + msg) }`
 }
 
 /**
  * Progress related
  */
 
-module.exports.progress = function start (msg, token) {
+function progress (msg, token) {
   const parseMsg = token !== void 0
     ? text => text.replace('___', underline(green(token)))
     : text => text
 
-  module.exports.info(parseMsg(msg), 'WAIT')
+  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()
+    success(`${ parseMsg(msg) } ${ dot } ${ diffTime }ms`, 'DONE')
+    log()
   }
 }
+
+export default {
+  successPill,
+  infoPill,
+  errorPill,
+  warningPill,
+
+  dot,
+
+  clearConsole,
+  tip,
+  log,
+  warn,
+  fatal,
+
+  success,
+  getSuccess,
+
+  info,
+  getInfo,
+
+  error,
+  getError,
+
+  warning,
+  getWarning,
+
+  progress
+}