create-quasar 1.9.3 → 1.10.1

package/templates/app-extension/ae-ts/install-script/app-extension/src/install.ts

@@ -0,0 +1,25 @@
+/**
+ * Quasar App Extension install script
+ * (runs on `quasar ext add {name}` and `quasar ext invoke {name}`)
+ *
+ * Docs: https://quasar.dev/app-extensions/development-guide/install-api
+ */
+
+import { InstallAPI } from './quasar';
+
+export default function (api: InstallAPI) {
+  // Quasar compatibility check; you may need hard dependencies,
+  // as in a minimum version of the "quasar" package or
+  // a minimum version of "@quasar/app-*" CLI
+  api.compatibleWith('quasar', '^2.0.0');
+
+  if (api.hasVite) {
+    api.compatibleWith('@quasar/app-vite', '^2.0.0-rc.1');
+  }
+
+  if (api.hasWebpack) {
+    api.compatibleWith('@quasar/app-webpack', '^4.0.0-rc.1');
+  }
+
+  api.render('./templates/base', api.prompts);
+}

package/templates/app-extension/ae-ts/install-script/app-extension/src/templates/README.md

@@ -0,0 +1,27 @@
+<% /* TODO: Consider reworking the AE docs and moving this to the docs */ %>
+# Templates
+
+Use this directory to store the templates that will be scaffolded during AE installation. You can organize the templates in subdirectories to copy them as groups as needed.
+
+Examples:
+- If there are files that are always needed, put them in a subdirectory called `base`.
+- Group them by features and have a `templates/components` directory to scaffold components, a `templates/pages` directory to scaffold pages, etc. only if the user chooses the respective options in the prompts.
+- Group templates by the TS and non-TS versions of the files, e.g. `templates/typescript` and `templates/no-typescript`.
+
+You can combine the above examples or create more directories as needed.
+
+## Rendering templates
+
+Use the Install API ([`src/install.ts`](../install.ts)) to render the templates. The API provides a `render` method that takes the path to the template and the scope object to render the template with.
+
+```ts
+api.render('./templates/base');
+// Render with scope set to the prompts object
+api.render('./templates/base', api.prompts);
+// Render with a custom scope object
+api.render('./templates/base', { someVar: 'someValue', anotherVar: api.prompts.whatever === 'foo' });
+
+// Render a different template based on the host project having TypeScript or not
+const type = await api.hasTypescript() ? 'typescript' : 'no-typescript';
+api.render(`./templates/${type}`);
+```

package/templates/app-extension/ae-ts/pnpm/_pnpm-workspace.yaml

@@ -0,0 +1,3 @@
+packages:
+  - app-extension
+  - playground/*

package/templates/app-extension/ae-ts/prompts-script/app-extension/src/prompts.ts

@@ -0,0 +1,46 @@
+/**
+ * Quasar App Extension prompts script
+ *
+ * Docs: https://quasar.dev/app-extensions/development-guide/prompts-api
+ *
+ * Inquirer prompts
+ * (answers are available as "api.prompts" in the other scripts)
+ * https://www.npmjs.com/package/inquirer#question
+ *
+ * Example:
+
+  return [
+    {
+      name: 'name',
+      type: 'input',
+      required: true,
+      message: 'Quasar CLI Extension name (without prefix)',
+    },
+    {
+      name: 'preset',
+      type: 'checkbox',
+      message: 'Check the features needed for your project:',
+      choices: [
+        {
+          name: 'Install script',
+          value: 'install'
+        },
+        {
+          name: 'Prompts script',
+          value: 'prompts'
+        },
+        {
+          name: 'Uninstall script',
+          value: 'uninstall'
+        }
+      ]
+    }
+  ]
+
+ */
+
+import { PromptsAPI } from './quasar';
+
+export default function (_api: PromptsAPI) {
+  return []
+}

package/templates/app-extension/ae-ts/uninstall-script/app-extension/src/uninstall.ts

@@ -0,0 +1,11 @@
+/**
+ * Quasar App Extension uninstall script
+ *
+ * Docs: https://quasar.dev/app-extensions/development-guide/uninstall-api
+ */
+
+import { UninstallAPI } from './quasar';
+
+export default function (_api: UninstallAPI) {
+  //
+}

package/templates/app-extension/index.js

@@ -1,4 +1,15 @@
 export async function script ({ scope, utils }) {
-  const { script } = await import('./ae-v1/index.js')
+  /**
+   * Temporarily disable scriptType prompt (TS not ready yet)
+   */
+
+  // await utils.prompts(scope, [
+  //   utils.commonPrompts.scriptType
+  // ])
+
+  // const { script } = await import(`./ae-${ scope.scriptType }/index.js`)
+  // await script({ scope, utils })
+
+  const { script } = await import('./ae-js/index.js')
   await script({ scope, utils })
 }

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

@@ -29,10 +29,10 @@ function extendConf (conf, api) {
   api.compatibleWith('quasar', '^2.0.0')
 
   if (api.hasVite) {
-    api.compatibleWith('@quasar/app-vite', '^1.5.0 || ^2.0.0-beta.1')
+    api.compatibleWith('@quasar/app-vite', '^1.5.0 || ^2.0.0-rc.1')
   }
   else if (api.hasWebpack) {
-    api.compatibleWith('@quasar/app-webpack', '^3.10.0 || ^4.0.0-beta.1')
+    api.compatibleWith('@quasar/app-webpack', '^3.10.0 || ^4.0.0-rc.1')
   }
 
 <% if (features.component) { %>

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

@@ -11,9 +11,9 @@
   api.compatibleWith('quasar', '^2.0.0')
 
   if (api.hasVite) {
-    api.compatibleWith('@quasar/app-vite', '^1.0.0 || ^2.0.0-beta.1')
+    api.compatibleWith('@quasar/app-vite', '^1.0.0 || ^2.0.0-rc.1')
   }
   else if (api.hasWebpack) {
-    api.compatibleWith('@quasar/app-webpack', '^3.10.0 || ^4.0.0-beta.1')
+    api.compatibleWith('@quasar/app-webpack', '^3.10.0 || ^4.0.0-rc.1')
   }
 }

package/utils/index.js

@@ -43,10 +43,12 @@ function convertArrayToObject (arr) {
 
 const runningPackageManager = (() => {
   const userAgent = process.env.npm_config_user_agent
-
-  if (userAgent) {
-    return userAgent.split(' ')[ 0 ].split('/')[ 0 ]
+  if (!userAgent) {
+    return
   }
+
+  const [ name, version ] = userAgent.split(' ')[ 0 ].split('/')
+  return { name, version }
 })()
 
 function getCallerPath () {
@@ -89,10 +91,15 @@ function renderTemplate (relativePath, scope) {
       const rawContent = readFileSync(sourcePath, 'utf-8')
       const template = compileTemplate(rawContent, { interpolate: /<%=([\s\S]+?)%>/g })
 
-      const newContent = extension === '.json'
-        // This prevents us to add comments into JSONC files, like tsconfig ones
-        ? JSON.stringify(JSON.parse(template(scope)), null, 2)
-        : template(scope)
+      let newContent = template(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')
     }

package/templates/app/quasar-v2/ts-vite-2/lint/_tsconfig.vue-tsc.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "skipLibCheck": true
-  }
-}

package/templates/app/quasar-v2/ts-vite-2/pinia/src/stores/store-flag.d.ts

@@ -1,13 +0,0 @@
-/*
-  WARNING: DO NOT MODIFY OR DELETE
-  This file is auto-generated by Quasar CLI
-  It's recommended to NOT .gitignore it
-  You don't have to use TypeScript in your project, don't worry
-*/
-import "quasar/dist/types/feature-flag.d.ts";
-
-declare module "quasar/dist/types/feature-flag.d.ts" {
-  interface QuasarFeatureFlags {
-    store: true;
-  }
-}

package/templates/app/quasar-v2/ts-webpack-4/pinia/src/stores/store-flag.d.ts

@@ -1,13 +0,0 @@
-/*
-  WARNING: DO NOT MODIFY OR DELETE
-  This file is auto-generated by Quasar CLI
-  It's recommended to NOT .gitignore it
-  You don't have to use TypeScript in your project, don't worry
-*/
-import "quasar/dist/types/feature-flag.d.ts";
-
-declare module "quasar/dist/types/feature-flag.d.ts" {
-  interface QuasarFeatureFlags {
-    store: true;
-  }
-}