create-quasar 2.2.3 → 4.0.0

package/utils/index.js

@@ -1,401 +0,0 @@
-import { readFileSync, writeFileSync, existsSync } from 'node:fs'
-import { fileURLToPath } from 'node:url'
-import { sep, dirname, normalize, join, resolve, extname } from 'node:path'
-import { execSync as exec } from 'node:child_process'
-import { sync as spawnSync } from 'cross-spawn'
-import {
-  emptyDirSync,
-  ensureDirSync,
-  ensureFileSync,
-  copySync
-} from 'fs-extra/esm'
-import promptUser from 'prompts'
-import { globSync } from 'tinyglobby'
-import { yellow, green } from 'kolorist'
-
-import { renderTemplate as renderTemplateFn } from './template.js'
-import logger from './logger.js'
-
-const TEMPLATING_FILE_EXTENSIONS = [
-  '',
-  '.json',
-  '.js',
-  '.cjs',
-  '.ts',
-  '.vue',
-  '.md',
-  '.html',
-  '.sass'
-]
-
-/**
- * @param {Record<string, any>} scope
- * @param {promptUser.PromptObject[]} questions
- * @param {promptUser.Options} opts
- */
-async function prompts(scope, questions, opts) {
-  const options = opts || {
-    onCancel: () => {
-      logger.fatal('Scaffolding cancelled')
-    }
-  }
-
-  const answers = await promptUser(questions, options)
-  Object.assign(scope, answers)
-}
-
-function createTargetDir(scope) {
-  console.log()
-  logger.log('Generating files...')
-  console.log()
-
-  const fn = scope.overwrite ? emptyDirSync : ensureDirSync
-  fn(scope.projectFolder)
-}
-
-function convertArrayToObject(arr) {
-  const acc = {}
-  arr.forEach(key => {
-    acc[key] = true
-  })
-  return acc
-}
-
-const runningPackageManager = (() => {
-  const userAgent = process.env.npm_config_user_agent
-  if (!userAgent) {
-    return
-  }
-
-  const [name, version] = userAgent.split(' ')[0].split('/')
-  return { name, version }
-})()
-
-function getCallerPath() {
-  const _prepareStackTrace = Error.prepareStackTrace
-  Error.prepareStackTrace = (_, stack) => stack
-  const stack = new Error().stack.slice(1)
-  Error.prepareStackTrace = _prepareStackTrace
-  const filename = stack[1].getFileName()
-  return dirname(
-    filename.startsWith('file://') ? fileURLToPath(filename) : filename
-  )
-}
-
-function renderTemplate(relativePath, scope) {
-  const templateDir = join(getCallerPath(), relativePath)
-  const files = globSync(['**/*'], { cwd: templateDir })
-
-  for (const rawPath of files) {
-    const targetRelativePath = rawPath
-      .split('/')
-      .map(name => (name.startsWith('_') ? 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')
-
-      let newContent = renderTemplateFn(rawContent, scope)
-      if (extension === '.json') {
-        try {
-          // try to format the JSON
-          newContent = JSON.stringify(JSON.parse(newContent), null, 2)
-        } catch {
-          // noop, the JSON might be containing comments, leave it unformatted
-        }
-      }
-
-      writeFileSync(targetPath, newContent, 'utf-8')
-    } else {
-      copySync(sourcePath, targetPath)
-    }
-  }
-}
-
-function isValidPackageName(projectName) {
-  return /^(?:@[a-z0-9-*~][a-z0-9-*._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/.test(
-    projectName
-  )
-}
-
-function inferPackageName(projectFolder) {
-  return projectFolder
-    .trim()
-    .toLowerCase()
-    .replace(/\s+/g, '-')
-    .replace(/^[._]/, '')
-    .replace(/[^a-z0-9-~]+/g, '-')
-}
-
-function escapeString(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 {}
-
-  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.
- */
-function printFinalMessage(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://donate.quasar.dev
- Any amount is very welcome.
- 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()
-
-  const runner = spawnSync(cmd, args, {
-    cwd: process.cwd(),
-    stdio: 'inherit',
-    ...options
-  })
-
-  console.log()
-
-  if (runner.status) {
-    console.log(` ${cmd} FAILED...`)
-    console.log()
-    throw new Error(`${cmd} FAILED`)
-  }
-}
-
-function installDeps(scope) {
-  const args = ['install']
-  // Related to scripts/create-test-project.ts
-  if (process.env.CREATE_TEST_PROJECT_OVERRIDE === 'true') {
-    // If we don't use this flag, then the test project will become part of the monorepo and fail to install properly
-    args.push('--ignore-workspace')
-  }
-
-  return runCommand(scope.packageManager, args, { cwd: scope.projectFolder })
-}
-
-function lintFolder(scope) {
-  return runCommand(
-    scope.packageManager,
-    scope.packageManager === 'npm'
-      ? ['run', 'lint', '--', '--fix']
-      : ['run', 'lint', '--fix'],
-    { cwd: scope.projectFolder }
-  )
-}
-
-function formatFolder(scope) {
-  return runCommand(scope.packageManager, ['run', 'format'], {
-    cwd: scope.projectFolder
-  })
-}
-
-function hasGit() {
-  try {
-    exec('git --version')
-    return true
-  } catch {}
-}
-
-function folderHasGit(cwd) {
-  try {
-    exec('git status', { stdio: 'ignore', cwd })
-    return true
-  } catch {}
-}
-
-function initializeGit(projectFolder) {
-  if (hasGit() !== true) {
-    logger.log(
-      'Git is not installed on the system, so skipping Git repo initialization.'
-    )
-    return
-  }
-
-  if (folderHasGit(projectFolder) === true) {
-    logger.log(
-      'A parent of the project folder is already a Git repository, so skipping Git initialization.'
-    )
-    return
-  }
-
-  try {
-    logger.log('Initializing Git repository...')
-    exec('git init', { cwd: projectFolder })
-    exec('git add -A', { cwd: projectFolder })
-
-    // Provide useful feedback to the user if they have GPG signing enabled to avoid feeling that the process is hanging
-    try {
-      const needsSigning = exec('git config --get commit.gpgsign', {
-        cwd: projectFolder
-      })
-        .toString()
-        .trim()
-      if (needsSigning === 'true') {
-        logger.log('Creating initial commit (waiting for GPG signing)...')
-      }
-    } catch {}
-
-    exec('git commit -m "Initialize the project 🚀" --no-verify', {
-      cwd: projectFolder
-    })
-  } catch {
-    logger.warn('Could not initialize Git repository. Please do this manually.')
-    return
-  }
-
-  logger.log('Initialized Git repository 🚀')
-}
-
-const quasarConfigFilenameList = [
-  'quasar.config.js',
-  'quasar.config.mjs',
-  'quasar.config.ts',
-  'quasar.config.cjs',
-  'quasar.conf.js' // legacy
-]
-
-function ensureOutsideProject() {
-  let dir = process.cwd()
-
-  while (dir.length && dir[dir.length - 1] !== sep) {
-    for (const name of quasarConfigFilenameList) {
-      const filename = join(dir, name)
-      if (existsSync(filename)) {
-        logger.fatal(
-          'Error. This command must NOT be executed inside of a Quasar project folder.'
-        )
-      }
-    }
-
-    dir = normalize(join(dir, '..'))
-  }
-}
-
-const SCRIPT_TYPES = [
-  { title: 'Javascript', value: 'js' },
-  { title: 'Typescript', value: 'ts' }
-]
-
-const commonPrompts = {
-  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: escapeString,
-    validate: val => val.length > 0 || 'Invalid project description'
-  },
-
-  license: {
-    type: 'text',
-    name: 'license',
-    message: 'License type',
-    initial: 'MIT'
-  }
-}
-
-export async function injectAuthor(scope) {
-  const author = getGitUser()
-
-  if (author) {
-    scope.author = author
-    return
-  }
-
-  await prompts(scope, [
-    {
-      type: 'text',
-      name: 'author',
-      message: 'Author:'
-    }
-  ])
-}
-
-export default {
-  logger,
-
-  prompts,
-  createTargetDir,
-  convertArrayToObject,
-  runningPackageManager,
-  renderTemplate,
-  isValidPackageName,
-  inferPackageName,
-
-  printFinalMessage,
-  installDeps,
-  lintFolder,
-  formatFolder,
-  ensureOutsideProject,
-  initializeGit,
-
-  commonPrompts,
-  injectAuthor
-}

package/utils/logger.js

@@ -1,159 +0,0 @@
-import {
-  bgGreen,
-  green,
-  inverse,
-  bgRed,
-  red,
-  bgYellow,
-  yellow,
-  black,
-  white,
-  underline
-} from 'kolorist'
-
-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} `))
-
-/**
- * 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} 🚀 `
-
-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)
-      console.log(blank)
-      readline.cursorTo(process.stdout, 0, 0)
-      readline.clearScreenDown(process.stdout)
-    }
-  : () => {}
-
-function tip(msg) {
-  console.log(msg ? ` ${tipBanner} ${msg}` : '')
-}
-
-function log(msg) {
-  console.log(msg ? ` ${greenBanner} ${msg}` : '')
-}
-
-function warn(msg, pill) {
-  if (msg !== void 0) {
-    const pillBanner =
-      pill !== void 0 ? bgYellow(black('', pill, '')) + ' ' : ''
-
-    console.warn(` ${yellowBanner} ⚠️  ${pillBanner}${msg}`)
-  } else {
-    console.warn()
-  }
-}
-
-function fatal(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
- */
-
-function success(msg, title = 'SUCCESS') {
-  console.log(` ${greenBanner} ${successPill(title)} ${green(dot + ' ' + msg)}`)
-}
-function getSuccess(msg, title) {
-  return ` ${greenBanner} ${successPill(title)} ${green(dot + ' ' + msg)}`
-}
-
-function info(msg, title = 'INFO') {
-  console.log(` ${greenBanner} ${infoPill(title)} ${green(dot)} ${msg}`)
-}
-function getInfo(msg, title) {
-  return ` ${greenBanner} ${infoPill(title)} ${green(dot)} ${msg}`
-}
-
-function error(msg, title = 'ERROR') {
-  console.log(` ${redBanner} ${errorPill(title)} ${red(dot + ' ' + msg)}`)
-}
-function getError(msg, title = 'ERROR') {
-  return ` ${redBanner} ${errorPill(title)} ${red(dot + ' ' + msg)}`
-}
-
-function warning(msg, title = 'WARNING') {
-  console.log(
-    ` ${yellowBanner} ${warningPill(title)} ${yellow(dot + ' ' + msg)}`
-  )
-}
-function getWarning(msg, title = 'WARNING') {
-  return ` ${yellowBanner} ${warningPill(title)} ${yellow(dot + ' ' + msg)}`
-}
-
-/**
- * Progress related
- */
-
-function progress(msg, token) {
-  const parseMsg =
-    token !== void 0
-      ? text => text.replace('___', underline(green(token)))
-      : text => text
-
-  info(parseMsg(msg), 'WAIT')
-
-  const startTime = Date.now()
-
-  return progressMessage => {
-    const diffTime = Number(new Date()) - startTime
-    success(`${parseMsg(progressMessage)} ${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
-}