create-quasar 2.2.2 → 4.0.0

package/index.js

@@ -1,192 +0,0 @@
-#!/usr/bin/env node
-
-import { readFileSync, readdirSync, existsSync } from 'node:fs'
-import { join } from 'node:path'
-
-// display banner
-console.log()
-console.log(readFileSync(new URL('./assets/logo.art', import.meta.url), 'utf8'))
-
-import utils from './utils/index.js'
-
-// should error out if already inside of a Quasar project
-utils.ensureOutsideProject()
-
-import parseArgs from 'minimist'
-import prompts from 'prompts'
-
-const argv = parseArgs(process.argv.slice(2), {
-  alias: {
-    n: 'nogit'
-  },
-
-  boolean: ['n']
-})
-
-/** @type {Record<string, any>} */
-const scope = {
-  // Usage: `pnpm create quasar <project-folder>`
-  // If provided it will skip the projectFolder prompt, but still apply the `format` function after the utils.prompts call
-  projectFolder: argv._[0]?.trim()
-}
-prompts.override(scope)
-
-if (scope.projectFolder) {
-  utils.logger.log(
-    `Using the project folder provided via arguments: ${scope.projectFolder}`
-  )
-  utils.logger.log()
-}
-
-const defaultProjectFolder = 'quasar-project'
-
-await utils.prompts(scope, [
-  {
-    type: 'select',
-    name: 'projectType',
-    initial: 0,
-    message: 'What would you like to build?',
-    choices: [
-      {
-        title: "App with Quasar CLI, let's go!",
-        value: 'app',
-        description: 'spa/pwa/ssr/bex/electron/capacitor/cordova'
-      },
-      {
-        title: 'AppExtension (AE) for Quasar CLI',
-        value: 'app-extension',
-        description: 'Quasar CLI AE'
-      },
-      {
-        title: 'Quasar UI kit',
-        value: 'ui-kit',
-        description: 'Vue component and/or directive'
-      }
-    ]
-  },
-  {
-    type: 'text',
-    name: 'projectFolder',
-    message: 'Project folder:',
-    initial: defaultProjectFolder,
-    format: val => {
-      const name = (val && val.trim()) || defaultProjectFolder
-      // inject the "short" name
-      scope.projectFolderName = name
-      return join(process.cwd(), name)
-    }
-  },
-  {
-    type: (_, { projectFolder }) =>
-      !existsSync(projectFolder) || readdirSync(projectFolder).length === 0
-        ? null
-        : 'confirm',
-    name: 'overwrite',
-    message: () =>
-      (scope.projectFolderName === '.'
-        ? 'Current directory'
-        : `Target directory "${scope.projectFolderName}"`) +
-      ' is not empty. Remove existing files and continue?'
-  },
-  {
-    type: (_, { overwrite } = {}) => {
-      if (overwrite === false) {
-        utils.logger.fatal('Scaffolding cancelled')
-      }
-      return null
-    },
-    name: 'overwriteConfirmation'
-  }
-])
-
-const { createQuasarScript } = await import(
-  `./templates/${scope.projectType}/create-quasar-script.js`
-)
-await createQuasarScript({ scope, utils })
-
-console.log()
-utils.logger.success('The project has been scaffolded')
-console.log()
-
-function finalize() {
-  if (scope.projectFolder) {
-    console.log()
-
-    if (argv.nogit) {
-      utils.logger.log(
-        'Skipping git initialization as --nogit flag was provided'
-      )
-    } else {
-      utils.initializeGit(scope.projectFolder)
-    }
-  }
-
-  utils.printFinalMessage(scope)
-}
-
-if (scope.skipDepsInstall !== true) {
-  await utils.prompts(
-    scope,
-    [
-      {
-        type: 'select',
-        name: 'packageManager',
-        message: 'Install project dependencies? (recommended)',
-        choices: () =>
-          utils.runningPackageManager
-            ? [
-                {
-                  title: `Yes, use ${utils.runningPackageManager.name}`,
-                  value: utils.runningPackageManager.name
-                },
-                { title: 'No, I will handle that myself', value: false }
-              ]
-            : [
-                { title: 'Yes, use Yarn (recommended)', value: 'yarn' },
-                { title: 'Yes, use PNPM (recommended)', value: 'pnpm' },
-                { title: 'Yes, use NPM', value: 'npm' },
-                { title: 'Yes, use Bun', value: 'bun' },
-                { title: 'No, I will handle that myself', value: false }
-              ]
-      }
-    ],
-    {
-      onCancel: () => {
-        scope.packageManager = false
-        finalize()
-        process.exit(0)
-      }
-    }
-  )
-
-  if (scope.packageManager !== false) {
-    try {
-      await utils.installDeps(scope)
-    } catch {
-      utils.logger.warn(
-        'Could not auto install dependencies. Probably a temporary npm registry issue?'
-      )
-      scope.packageManager = false
-      finalize()
-      process.exit(0)
-    }
-
-    if (scope.preset.lint) {
-      try {
-        await utils.lintFolder(scope)
-      } catch {
-        utils.logger.warn('Could not auto lint fix the project folder.')
-      }
-    }
-
-    if (scope.prettier) {
-      try {
-        await utils.formatFolder(scope)
-      } catch {
-        utils.logger.warn('Could not auto format the project folder.')
-      }
-    }
-  }
-}
-
-finalize()

package/scripts/create-test-project.ts

@@ -1,64 +0,0 @@
-import prompts from "prompts";
-
-type ScriptType = "js" | "ts";
-type AppEngine = "vite-2" | "webpack-4";
-type PackageManager = "yarn" | "npm" | "pnpm";
-
-type CreateProjectOptions = {
-  scriptType: ScriptType;
-  appEngine: AppEngine;
-  packageManager: PackageManager;
-};
-
-export async function createProject({
-  scriptType,
-  appEngine,
-  packageManager
-}: CreateProjectOptions) {
-  // To bypass Corepack enforcing what's specified in the closest package.json file that has the 'packageManager' field
-  process.env.COREPACK_ENABLE_STRICT = "0";
-  // See https://github.com/yarnpkg/yarn/issues/9015
-  process.env.SKIP_YARN_COREPACK_CHECK = "1";
-  // To alter the behavior to run correctly within this script
-  process.env.CREATE_TEST_PROJECT_OVERRIDE = "true";
-
-  prompts.override({
-    projectType: "app",
-    projectFolder: "test-project",
-    overwrite: true,
-
-    scriptType: scriptType,
-    engine: appEngine,
-
-    name: "test-project",
-    productName: "Test Project",
-    description: "A test project",
-    author: "Quasar Team (info@quasar.dev)",
-
-    // The defaults
-
-    preset: ["sass", "eslint"],
-    prettier: true,
-
-    packageManager
-  });
-
-  // We are overriding .override() as every call overrides the previous overrides (too many overrides :D)
-  // This way, we guarantee that even if we call prompts.override() in create-quasar code, our values remain
-  prompts.override = () => {};
-  // Remove all extra arguments to avoid interfering with the index.js script
-  process.argv = process.argv.slice(0, 2);
-
-  await import("../index.js");
-}
-
-const args = process.argv.slice(2) as [ScriptType, AppEngine, PackageManager];
-
-void createProject({
-  scriptType: args[0],
-  appEngine: args[1],
-  packageManager: args[2]
-}).catch(error => {
-  console.error(error);
-  process.exit(1);
-});

package/scripts/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": ["ES2021"],
-    "module": "CommonJS",
-    "target": "ES2021",
-    "moduleResolution": "node",
-
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-
-    // Scripts are meant to be consumed by tsx, not to be compiled
-    "noEmit": true,
-
-    "allowJs": true
-  }
-}

package/templates/__eslint.config.base.js

@@ -1,148 +0,0 @@
-import pluginLodashTemplate from '@yusufkandemir/eslint-plugin-lodash-template'
-import { defineConfig } from 'eslint/config'
-import globals from 'globals'
-import tseslint from 'typescript-eslint'
-import baseConfig from '../eslint.config.base.js'
-
-// file paths are relative to templates/*/
-export default defineConfig(
-  ...baseConfig,
-
-  {
-    name: 'custom/templates/ts',
-    files: [ '*/*/**/*.ts' ],
-
-    extends: [
-      ...tseslint.configs.recommended,
-      pluginLodashTemplate.configs.recommendedWithScript,
-    ],
-
-    languageOptions: {
-      parserOptions: {
-        parser: tseslint.parser,
-        sourceType: 'module',
-      },
-
-      globals: {
-        ...globals.browser,
-        process: 'readonly'
-      }
-    },
-
-    rules: {
-      '@typescript-eslint/no-empty-function': 'off',
-      '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
-    },
-
-    linterOptions: {
-      // TS templates use recommendedTypeChecked which have extra rules
-      // We can't enable it here due to the complicated nature of the templates
-      // So, we simply disable unused disable directives to avoid false positives
-      reportUnusedDisableDirectives: 'off'
-    }
-  },
-
-  {
-    name: 'custom/templates/js',
-    files: [ '*/*/**/*.js' ],
-
-    extends: [
-      {
-        ...pluginLodashTemplate.configs.recommendedWithScript,
-        settings: {
-          'lodash-template/globals': [
-            // Base
-            'name',
-            'description',
-            'author',
-
-            'features',
-            'preset',
-
-            'packageDescription',
-            'aeDescription',
-
-            'umdExportName',
-            'componentName',
-            'directiveName',
-
-            'license'
-          ]
-        }
-      }
-    ],
-
-    languageOptions: {
-      parserOptions: {
-        sourceType: 'module',
-      },
-
-      globals: {
-        ...globals.browser,
-        process: 'readonly',
-        // For require.context
-        require: 'readonly',
-      }
-    },
-
-    rules: {
-      'no-empty-function': 'off',
-      'no-unused-vars': [ 'warn', { args: 'none' } ],
-    },
-  },
-
-  {
-    name: 'custom/templates/config-files',
-    files: [
-      '*/*/**/_*.js',
-      '*/*/**/*.{conf,config}.js',
-    ],
-
-    languageOptions: {
-      parserOptions: {
-        // TODO: re-evaluate this
-        sourceType: 'script'
-      },
-
-      globals: {
-        ...globals.node
-      }
-    }
-  },
-
-  {
-    name: 'custom/templates/config-files/esm',
-    files: [
-      '*/*/**/quasar.config.js',
-      '*/*/**/_eslint.config.js',
-      '*/*/**/babel.config.js',
-      '*/*/**/postcss.config.js'
-    ],
-
-    languageOptions: {
-      parserOptions: {
-        sourceType: 'module'
-      },
-
-      globals: {
-        ...globals.node
-      }
-    }
-  },
-
-  {
-    // example: ./app/quasar-v2/index.js
-    name: 'custom/templates/helpers',
-    files: [ '*/*/*.js' ],
-
-    languageOptions: {
-      parserOptions: {
-        sourceType: 'module'
-      },
-
-      globals: {
-        ...globals.node
-      }
-    }
-  }
-)

package/templates/app/__eslint.config.js

@@ -1,64 +0,0 @@
-import { defineConfig } from 'eslint/config'
-import baseConfig from '../eslint.config.base.js'
-
-export default defineConfig(
-  ...baseConfig,
-
-  {
-    files: [
-      'quasar-v2/js-vite-2/*/**/*.ts',
-      'quasar-v2/js-vite-2/*/**/*.js',
-
-      'quasar-v2/js-webpack-4/*/**/*.ts',
-      'quasar-v2/js-webpack-4/*/**/*.js'
-    ],
-
-    settings: {
-      'lodash-template/globals': [
-        // Base
-        'name',
-        'description',
-        'author',
-
-        // Quasar v2
-        'quasarVersion',
-        'scriptType',
-        'productName',
-
-        // Quasar v2 - JS
-        'css',
-        'preset',
-        'prettier'
-      ]
-    }
-  },
-
-  {
-    files: [
-      'quasar-v2/ts-vite-2/*/**/*.ts',
-      'quasar-v2/ts-vite-2/*/**/*.js',
-
-      'quasar-v2/ts-webpack-4/*/**/*.ts',
-      'quasar-v2/ts-webpack-4/*/**/*.js'
-    ],
-
-    settings: {
-      'lodash-template/globals': [
-        // Base
-        'name',
-        'description',
-        'author',
-
-        // Quasar v2
-        'quasarVersion',
-        'scriptType',
-        'productName',
-
-        // Quasar v2 - TS
-        'css',
-        'preset',
-        'prettier'
-      ]
-    }
-  }
-)

package/templates/app/quasar-v2/create-quasar-script.js

@@ -1,39 +0,0 @@
-export async function createQuasarScript({ scope, utils }) {
-  await utils.prompts(scope, [
-    {
-      type: 'select',
-      name: 'engine',
-      message: 'Pick Quasar App CLI variant:',
-      initial: 0,
-      choices: [
-        {
-          title: 'Quasar App CLI with Vite',
-          value: 'vite-2',
-          description: 'recommended'
-        },
-        {
-          title: 'Quasar App CLI with Webpack',
-          value: 'webpack-4'
-        }
-      ]
-    },
-    {
-      type: 'text',
-      name: 'name',
-      message: 'Package name:',
-      initial: () => utils.inferPackageName(scope.projectFolderName),
-      validate: val =>
-        utils.isValidPackageName(val) || 'Invalid package.json name'
-    },
-
-    utils.commonPrompts.productName,
-    utils.commonPrompts.description
-  ])
-
-  await utils.injectAuthor(scope)
-
-  const { createQuasarScript: create } = await import(
-    `./${scope.scriptType}-${scope.engine}/create-quasar-script.js`
-  )
-  await create({ scope, utils })
-}

package/templates/app/quasar-v2/js-vite-2/BASE/README.md

@@ -1,40 +0,0 @@
-# <%= scope.productName %> (<%= scope.name %>)
-
-<%= scope.description %>
-
-## Install the dependencies
-```bash
-yarn
-# or
-npm install
-```
-
-### Start the app in development mode (hot-code reloading, error reporting, etc.)
-```bash
-quasar dev
-```
-<% if (scope.preset.eslint) { %>
-
-### Lint the files
-```bash
-yarn lint
-# or
-npm run lint
-```
-<% if (scope.prettier) { %>
-
-### Format the files
-```bash
-yarn format
-# or
-npm run format
-```
-<% } } %>
-
-### Build the app for production
-```bash
-quasar build
-```
-
-### Customize the configuration
-See [Configuring quasar.config.js](https://v2.quasar.dev/quasar-cli-vite/quasar-config-js).

package/templates/app/quasar-v2/js-vite-2/BASE/_.vscode/settings.json

@@ -1,10 +0,0 @@
-{
-  "editor.bracketPairColorization.enabled": true,
-  "editor.guides.bracketPairs": true<% if (scope.preset.eslint) { %>,
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": <% if (scope.prettier) { %>"esbenp.prettier-vscode"<% } else { %>"dbaeumer.vscode-eslint"<% } %>,
-  "editor.codeActionsOnSave": [
-    "source.fixAll.eslint"
-  ],
-  "eslint.validate": ["javascript", "javascriptreact", "typescript", "vue"]<% } %>
-}

package/templates/app/quasar-v2/js-vite-2/BASE/_pnpm-workspace.yaml

@@ -1,6 +0,0 @@
-# https://pnpm.io/settings
-shamefullyHoist: true
-
-onlyBuiltDependencies:
-  - '@parcel/watcher'
-  - esbuild

package/templates/app/quasar-v2/js-vite-2/__.eslintrc.cjs

@@ -1,24 +0,0 @@
-module.exports = {
-  parserOptions: {
-    sourceType: 'module'
-  },
-
-  settings: {
-    'lodash-template/globals': [
-      // Base
-      'name',
-      'description',
-      'author',
-
-      // Quasar v2
-      'quasarVersion',
-      'scriptType',
-      'productName',
-
-      // Quasar v2 - JS
-      'css',
-      'preset',
-      'prettier'
-    ]
-  }
-}

package/templates/app/quasar-v2/js-vite-2/create-quasar-script.js

@@ -1,53 +0,0 @@
-export async function createQuasarScript({ scope, utils }) {
-  await utils.prompts(scope, [
-    {
-      type: 'multiselect',
-      name: 'preset',
-      message: 'Check the features needed for your project:',
-      choices: [
-        {
-          title: 'Sass CSS preprocessor',
-          value: 'sass',
-          selected: true
-        },
-        {
-          title: 'Linting (vite-plugin-checker + ESLint)',
-          value: 'eslint',
-          description: 'recommended',
-          selected: true
-        },
-        {
-          title: 'State Management (Pinia)',
-          value: 'pinia',
-          description: 'https://pinia.vuejs.org'
-        },
-        {
-          title: 'Internationalization (vue-i18n)',
-          value: 'i18n'
-        }
-      ],
-      format: utils.convertArrayToObject
-    },
-    {
-      type: (_, { preset }) => (preset.eslint ? 'confirm' : null),
-      name: 'prettier',
-      initial: true,
-      message: 'Add Prettier for code formatting?'
-    }
-  ])
-
-  // ensure it's defined since if not selecting ESLint,
-  // user won't be asked about it hence it won't be defined
-  scope.prettier = scope.prettier || false
-
-  utils.createTargetDir(scope)
-  utils.renderTemplate('BASE', scope)
-
-  const css = scope.preset.sass ? 'sass' : 'css'
-  utils.renderTemplate(css, scope)
-
-  if (scope.preset.i18n) utils.renderTemplate('i18n', scope)
-  if (scope.preset.eslint) utils.renderTemplate('eslint', scope)
-  if (scope.prettier) utils.renderTemplate('prettier', scope)
-  if (scope.preset.pinia) utils.renderTemplate('pinia', scope)
-}

package/templates/app/quasar-v2/js-webpack-4/BASE/README.md

@@ -1,40 +0,0 @@
-# <%= scope.productName %> (<%= scope.name %>)
-
-<%= scope.description %>
-
-## Install the dependencies
-```bash
-yarn
-# or
-npm install
-```
-
-### Start the app in development mode (hot-code reloading, error reporting, etc.)
-```bash
-quasar dev
-```
-<% if (scope.preset.eslint) { %>
-
-### Lint the files
-```bash
-yarn lint
-# or
-npm run lint
-```
-<% if (scope.prettier) { %>
-
-### Format the files
-```bash
-yarn format
-# or
-npm run format
-```
-<% } } %>
-
-### Build the app for production
-```bash
-quasar build
-```
-
-### Customize the configuration
-See [Configuring quasar.config.js](https://v2.quasar.dev/quasar-cli-webpack/quasar-config-js).