create-quasar 2.0.3 → 2.0.5

package/eslint.config.base.js

@@ -0,0 +1,19 @@
+import eslintJs from '@eslint/js'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  {
+    name: 'eslint/recommended',
+
+    ...eslintJs.configs.recommended
+  },
+
+  {
+    name: 'custom',
+
+    rules: {
+      'no-empty': 'off',
+      'no-unused-vars': [ 'error', { ignoreRestSiblings: true, argsIgnorePattern: '^_', caughtErrorsIgnorePattern: '^_' } ]
+    }
+  }
+)

package/eslint.config.js

@@ -0,0 +1,47 @@
+import baseConfig from './eslint.config.base.js'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+// import quasar from 'eslint-config-quasar'
+
+export default tseslint.config(
+  ...baseConfig,
+
+  // TODO: enable these configs
+  // ...quasar.configs.base,
+  // ...quasar.configs.node,
+
+  {
+    name: 'custom/ignores',
+
+    ignores: [ 'test-project' ]
+  },
+
+  {
+    name: 'custom',
+
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+
+      globals: {
+        ...globals.node
+      }
+    }
+  },
+
+  {
+    name: 'custom/scripts',
+
+    files: [ './scripts/**/*.ts' ],
+
+    extends: [
+      ...tseslint.configs.recommended
+    ],
+
+    languageOptions: {
+      parserOptions: {
+        sourceType: 'module',
+      }
+    }
+  }
+)

package/index.js

@@ -18,6 +18,7 @@ import utils from './utils/index.js'
 utils.ensureOutsideProject()
 
 import parseArgs from 'minimist'
+import prompts from 'prompts'
 
 const argv = parseArgs(process.argv.slice(2), {
   alias: {
@@ -27,8 +28,20 @@ const argv = parseArgs(process.argv.slice(2), {
   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'
-const scope = {}
 
 await utils.prompts(scope, [
   {
@@ -146,6 +159,15 @@ if (scope.skipDepsInstall !== true) {
         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.')
+      }
+    }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-quasar",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "description": "Scaffolds Quasar Apps, AppExtensions or UI kits",
   "type": "module",
   "author": {
@@ -37,15 +37,14 @@
   "devDependencies": {
     "@types/lodash": "^4.17.7",
     "@types/prompts": "^2.4.9",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "eslint": "^8.57.1",
-    "eslint-plugin-lodash-template": "^1.1.0",
+    "@yusufkandemir/eslint-plugin-lodash-template": "^2.0.0",
+    "typescript-eslint": "^8.28.0",
+    "eslint": "^9.29.0",
     "tsx": "^4.19.1",
     "typescript": "^5.6.2"
   },
   "scripts": {
-    "lint": "eslint --ext .js,.ts ./ --fix",
+    "lint": "eslint --flag unstable_config_lookup_from_file --fix",
     "create-test-project": "tsx scripts/create-test-project.ts"
   }
 }

package/scripts/create-test-project.ts

@@ -1,7 +1,7 @@
 import prompts from 'prompts';
 
 type ScriptType = 'js' | 'ts';
-type AppEngine = 'vite-1' | 'vite-2' | 'webpack-3' | 'webpack-4';
+type AppEngine = 'vite-2' | 'webpack-4';
 type PackageManager = 'yarn' | 'npm' | 'pnpm';
 
 type CreateProjectOptions = {
@@ -23,7 +23,6 @@ export async function createProject({ scriptType, appEngine, packageManager }: C
     projectFolder: 'test-project',
     overwrite: true,
 
-    quasarVersion: 'v2',
     scriptType: scriptType,
     engine: appEngine,
 
@@ -35,15 +34,9 @@ export async function createProject({ scriptType, appEngine, packageManager }: C
     // The defaults
     sfcStyle: 'composition-setup',
     css: 'scss',
-    ...(appEngine === 'vite-1' || appEngine === 'webpack-3'
-      ? {
-          preset: ['lint'],
-          lintConfig: 'prettier',
-        }
-      : {
-          preset: ['eslint'],
-          prettier: true,
-        }),
+
+    preset: ['eslint'],
+    prettier: true,
 
     packageManager,
   });

package/templates/app/eslint.config.js

@@ -0,0 +1,65 @@
+import tseslint from 'typescript-eslint'
+import baseConfig from '../eslint.config.base.js'
+
+export default tseslint.config(
+  ...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
+        'sfcStyle',
+        'css',
+        'preset',
+        'prettier'
+      ]
+    }
+  }
+)

package/templates/app/quasar-v2/js-vite-2/BASE/_package.json

@@ -30,7 +30,7 @@
     "eslint": "^9.14.0",
     "eslint-plugin-vue": "^9.30.0",
     "globals": "^15.12.0",
-    "vite-plugin-checker": "^0.8.0",
+    "vite-plugin-checker": "^0.9.0",
     <% } %>
     <% if (prettier) { %>
     "@vue/eslint-config-prettier": "^10.1.0",

package/templates/app/quasar-v2/ts-vite-2/BASE/_package.json

@@ -31,7 +31,7 @@
     "globals": "^15.12.0",
     "vue-tsc": "^2.0.29",
     "@vue/eslint-config-typescript": "^14.4.0",
-    "vite-plugin-checker": "^0.8.0",
+    "vite-plugin-checker": "^0.9.0",
     <% } %>
     <% if (prettier) { %>
     "@vue/eslint-config-prettier": "^10.1.0",

package/templates/app-extension/ae-ts/BASE/playground/quasar-cli-vite/postcss.config.cjs

@@ -1,4 +1,3 @@
-/* eslint-disable */
 // https://github.com/michael-ciniawsky/postcss-load-config
 
 module.exports = {

package/templates/app-extension/ae-ts/BASE/playground/quasar-cli-webpack/babel.config.cjs

@@ -1,5 +1,3 @@
-/* eslint-disable */
-
 module.exports = api => {
   return {
     presets: [

package/templates/app-extension/eslint.config.js

@@ -0,0 +1,65 @@
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+import baseConfig from '../eslint.config.base.js'
+
+export default tseslint.config(
+  ...baseConfig,
+
+  {
+    // Due to conditional use of mixed ESM/CJS in certain files, they can't be properly parsed and checked
+    ignores: [
+      'ae-js/BASE/src/index.js',
+      'ae-js/install-script/src/install.js',
+      'ae-js/prompts-script/src/prompts.js',
+      'ae-js/uninstall-script/src/uninstall.js'
+    ]
+  },
+
+  {
+    files: [ 'ae-js/*/**/*.js' ],
+
+    settings: {
+      'lodash-template/globals': [
+        // Base
+        'name',
+        'description',
+        'author',
+
+        'preset',
+        'orgName',
+        'license',
+
+        'codeFormat'
+      ]
+    },
+
+    languageOptions: {
+      parserOptions: {
+        sourceType: 'script'
+      },
+
+      globals: {
+        ...globals.node
+      }
+    }
+  },
+
+  {
+    files: [ 'ae-ts/*/**/*.ts', 'ae-ts/*/**/*.js' ],
+
+    settings: {
+      'lodash-template/globals': [
+        // Base
+        'name',
+        'description',
+        'author',
+
+        'preset',
+        'orgName',
+        'license',
+
+        'packageManagerField',
+      ]
+    }
+  },
+)

package/templates/eslint.config.base.js

@@ -0,0 +1,147 @@
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+import pluginLodashTemplate from '@yusufkandemir/eslint-plugin-lodash-template'
+import baseConfig from '../eslint.config.base.js'
+
+// file paths are relative to templates/*/
+export default tseslint.config(
+  ...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/ui-kit/eslint.config.js

@@ -0,0 +1,70 @@
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+import baseConfig from '../eslint.config.base.js'
+
+export default tseslint.config(
+  ...baseConfig,
+
+  {
+    // Due to conditional use of mixed ESM/CJS in certain files, they can't be properly parsed and checked
+    ignores: [
+      '*/ae-install/app-extension/src/install.js',
+      '*/ae-prompts/app-extension/src/prompts.js',
+      '*/ae-uninstall/app-extension/src/uninstall.js',
+      '*/ae/app-extension/src/index.js'
+    ]
+  },
+
+  {
+    files: [ '*/*/**/*.js' ],
+
+    settings: {
+      'lodash-template/globals': [
+        // Base
+        'name',
+        'description',
+        'author',
+
+        'features',
+        'preset',
+
+        'packageDescription',
+        'aeDescription',
+
+        'umdExportName',
+        'componentName',
+        'directiveName',
+
+        'license'
+      ]
+    }
+  },
+
+  {
+    files: [ '*/*/**/*.js' ],
+
+    languageOptions: {
+      globals: {
+        __UI_VERSION__: 'readonly'
+      },
+    }
+  },
+
+  {
+    files: [
+      '*/{ae,ae-*}/app-extension/src/*.js',
+      '*/{BASE,ui-ae}/ui/build/*.js',
+      '*/{BASE,ui-ae}/ui/build/*/!(entry)/**/*.js',
+    ],
+
+    languageOptions: {
+      parserOptions: {
+        sourceType: 'script'
+      },
+
+      globals: {
+        ...globals.node
+      }
+    }
+  }
+)

package/templates/ui-kit/quasar-v2/BASE/ui/build/script.javascript.js

@@ -194,7 +194,6 @@ function buildEntry (config) {
 }
 
 function injectVueRequirement (code) {
-  // eslint-disable-next-line
   const index = code.indexOf(`Vue = Vue && Vue.hasOwnProperty('default') ? Vue['default'] : Vue`)
 
   if (index === -1) {

package/templates/ui-kit/quasar-v2/ae-prompts/app-extension/src/prompts.js

@@ -39,6 +39,6 @@
 
  */
 
-export default function (api) {
+export default function (_api) {
   return []
 }

package/templates/ui-kit/quasar-v2/ae-uninstall/app-extension/src/uninstall.js

@@ -4,6 +4,6 @@
  * Docs: https://quasar.dev/app-extensions/development-guide/uninstall-api
  */
 
-export default function (api) {
+export default function (_api) {
   //
 }

package/templates/ui-kit/quasar-v2/ui-directive/ui/src/directives/Directive.js

@@ -1,7 +1,7 @@
 export default {
   name: '<%= directiveName %>',
 
-  mounted (el) {
+  mounted (_el) {
     //
   }
 }

package/utils/index.js

@@ -13,6 +13,11 @@ 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: () => {
@@ -136,7 +141,7 @@ function getGitUser () {
     name = exec('git config --get user.name')
     email = exec('git config --get user.email')
   }
-  catch (e) {}
+  catch (_) {}
 
   name = name && JSON.stringify(name.toString().trim()).slice(1, -1)
   email = email && (' <' + email.toString().trim() + '>')
@@ -229,6 +234,14 @@ function lintFolder (scope) {
   )
 }
 
+function formatFolder (scope) {
+  return runCommand(
+    scope.packageManager,
+    [ 'run', 'format' ],
+    { cwd: scope.projectFolder }
+  )
+}
+
 function hasGit () {
   try {
     exec('git --version')
@@ -261,7 +274,7 @@ function initializeGit (projectFolder) {
     exec('git add -A', { cwd: projectFolder })
     exec('git commit -m "Initialize the project 🚀" --no-verify', { cwd: projectFolder })
   }
-  catch (e) {
+  catch (_) {
     logger.warn('Could not initialize Git repository. Please do this manually.')
     return
   }
@@ -364,6 +377,7 @@ export default {
   printFinalMessage,
   installDeps,
   lintFolder,
+  formatFolder,
   ensureOutsideProject,
   initializeGit,
 

package/.eslintignore

@@ -1 +0,0 @@
-test-project/

package/.eslintrc.cjs

@@ -1,40 +0,0 @@
-module.exports = {
-  // TODO: improve rules, use the ones from the root config by removing `root: true`
-  root: true,
-
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module'
-  },
-
-  env: {
-    node: true
-  },
-
-  globals: {
-    Promise: 'readonly'
-  },
-
-  extends: [
-    'eslint:recommended',
-  ],
-
-  rules: {
-    'no-empty': 'off',
-  },
-
-  overrides: [
-    {
-      files: './scripts/**/*.ts',
-
-      parserOptions: {
-        sourceType: 'module',
-      },
-
-      extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/recommended',
-      ],
-    }
-  ]
-}

package/templates/.eslintrc.cjs

@@ -1,103 +0,0 @@
-module.exports = {
-  overrides: [
-    {
-      files: './*/*/*/**/*.ts',
-
-      parserOptions: {
-        parser: '@typescript-eslint/parser',
-        sourceType: 'module'
-      },
-
-      env: {
-        node: false,
-        browser: true,
-      },
-
-      globals: {
-        process: 'readonly',
-      },
-
-      extends: [
-        'eslint:recommended',
-        'plugin:@typescript-eslint/recommended',
-        'plugin:lodash-template/recommended-with-script'
-      ],
-
-      rules: {
-        '@typescript-eslint/no-empty-function': 'off',
-        '@typescript-eslint/no-unused-vars': ['warn', { args: 'none' }],
-      },
-    },
-
-    {
-      files: './*/*/*/**/*.js',
-
-      parserOptions: {
-        sourceType: 'module'
-      },
-
-      env: {
-        node: false,
-        browser: true,
-      },
-
-      globals: {
-        process: 'readonly',
-        // For require.context
-        require: 'readonly',
-      },
-
-      extends: [
-        'eslint:recommended',
-        'plugin:lodash-template/recommended-with-script'
-      ],
-
-      rules: {
-        'no-empty-function': 'off',
-        'no-unused-vars': ['warn', { args: 'none' }],
-      },
-    },
-
-    {
-      files: [
-        './*/*/*/**/_*.js',
-        './*/*/*/**/*.{conf,config}.js',
-      ],
-
-      parserOptions: {
-        sourceType: 'script'
-      },
-
-      env: {
-        browser: false,
-        node: true,
-      },
-    },
-
-    {
-      files: [
-        './*/*/*/**/_eslint.config.js',
-        './*/*/*/**/postcss.config.js'
-      ],
-
-      parserOptions: {
-        sourceType: 'module'
-      },
-
-      env: {
-        browser: false,
-        node: true,
-      },
-    },
-
-    {
-      // Template-specific manager/helper scripts (e.g. ./app/quasar-v2/index.js)
-      files: './*/*/*/*.js',
-
-      env: {
-        browser: false,
-        node: true,
-      },
-    }
-  ]
-}

package/templates/app-extension/ae-js/.eslintrc.cjs

@@ -1,41 +0,0 @@
-module.exports = {
-  settings: {
-    'lodash-template/globals': [
-      // Base
-      'name',
-      'description',
-      'author',
-
-      'preset',
-      'orgName',
-      'license',
-
-      'codeFormat'
-    ]
-  },
-
-  overrides: [
-    {
-      files: [
-        './*/**/*.js',
-      ],
-
-      parserOptions: {
-        sourceType: 'script'
-      },
-
-      env: {
-        browser: false,
-        node: true,
-      },
-    },
-  ],
-
-  // Due to conditional use of mixed ESM/CJS in certain files, they can't be properly parsed and checked
-  ignorePatterns: [
-    'BASE/src/index.js',
-    'install-script/src/install.js',
-    'prompts-script/src/prompts.js',
-    'uninstall-script/src/uninstall.js'
-  ]
-}

package/templates/app-extension/ae-ts/.eslintrc.cjs

@@ -1,17 +0,0 @@
-module.exports = {
-  settings: {
-    'lodash-template/globals': [
-      // Base
-      'name',
-      'description',
-      'author',
-
-      'preset',
-      'orgName',
-      'pkgName',
-      'license',
-
-      'packageManagerField',
-    ]
-  },
-}

package/templates/app-extension/ae-ts/BASE/eslint.d.ts

@@ -1,18 +0,0 @@
-declare module 'eslint-plugin-vue' {
-  import type { TSESLint } from '@typescript-eslint/utils';
-
-  const configs: {
-    'flat/recommended': TSESLint.FlatConfig.ConfigArray;
-  };
-  const plugin: {
-    configs: typeof configs;
-  };
-  export default plugin;
-}
-
-declare module 'eslint-config-prettier' {
-  import type { TSESLint } from '@typescript-eslint/utils';
-
-  const config: TSESLint.FlatConfig.Config;
-  export default config;
-}

package/templates/ui-kit/.eslintrc.cjs

@@ -1,41 +0,0 @@
-module.exports = {
-  settings: {
-    'lodash-template/globals': [
-      // Base
-      'name',
-      'description',
-      'author',
-
-      'features',
-      'preset',
-
-      'packageDescription',
-      'aeDescription',
-
-      'umdExportName',
-      'componentName',
-      'directiveName',
-
-      'license'
-    ]
-  },
-
-  overrides: [
-    {
-      files: [
-        './*/{ae,ae-*}/app-extension/src/*.js',
-        './*/{BASE,ui-ae}/ui/build/*.js',
-        './*/{BASE,ui-ae}/ui/build/*/!(entry)/**/*.js',
-      ],
-
-      parserOptions: {
-        sourceType: 'script'
-      },
-
-      env: {
-        browser: false,
-        node: true,
-      },
-    },
-  ]
-}

package/templates/ui-kit/quasar-v2/.eslintrc.cjs

@@ -1,19 +0,0 @@
-module.exports = {
-  overrides: [
-    {
-      files: './*/**/*.js',
-
-      globals: {
-        __UI_VERSION__: 'readonly'
-      },
-    },
-  ],
-
-  // Due to conditional use of mixed ESM/CJS in certain files, they can't be properly parsed and checked
-  ignorePatterns: [
-    'ae-install/app-extension/src/install.js',
-    'ae-prompts/app-extension/src/prompts.js',
-    'ae-uninstall/app-extension/src/uninstall.js',
-    'ae/app-extension/src/index.js'
-  ]
-}