create-quasar 0.0.1 → 1.0.2

package/templates/app/quasar-v2/ts-webpack/lint/_eslintrc.js

@@ -0,0 +1,130 @@
+
+module.exports = {
+  // https://eslint.org/docs/user-guide/configuring#configuration-cascading-and-hierarchy
+  // This option interrupts the configuration hierarchy at this file
+  // Remove this if you have an higher level ESLint config file (it usually happens into a monorepos)
+  root: true,
+
+  // https://eslint.vuejs.org/user-guide/#how-to-use-a-custom-parser
+  // Must use parserOptions instead of "parser" to allow vue-eslint-parser to keep working
+  // `parser: 'vue-eslint-parser'` is already included with any 'plugin:vue/**' config and should be omitted
+  parserOptions: {
+    parser: require.resolve('@typescript-eslint/parser'),
+    extraFileExtensions: [ '.vue' ]
+  },
+
+  env: {
+    browser: true,
+    es2021: true,
+    node: true
+  },
+
+  // Rules order is important, please avoid shuffling them
+  extends: [
+    // Base ESLint recommended rules
+    // 'eslint:recommended',
+
+    // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage
+    // ESLint typescript rules
+    'plugin:@typescript-eslint/recommended',
+
+    // Uncomment any of the lines below to choose desired strictness,
+    // but leave only one uncommented!
+    // See https://eslint.vuejs.org/rules/#available-rules
+    'plugin:vue/vue3-essential', // Priority A: Essential (Error Prevention)
+    // 'plugin:vue/vue3-strongly-recommended', // Priority B: Strongly Recommended (Improving Readability)
+    // 'plugin:vue/vue3-recommended', // Priority C: Recommended (Minimizing Arbitrary Choices and Cognitive Overhead)
+
+    <% if (lintConfig === 'standard') { %>'standard'
+    <% } else if (lintConfig === 'airbnb') { %>'airbnb-base'
+    <% } else if (lintConfig === 'prettier') { %>// https://github.com/prettier/eslint-config-prettier#installation
+    // usage with Prettier, provided by 'eslint-config-prettier'.
+    'prettier'<% } %>
+  ],
+
+  plugins: [
+    // required to apply rules which need type information
+    '@typescript-eslint',
+
+    // https://eslint.vuejs.org/user-guide/#why-doesn-t-it-work-on-vue-files
+    // required to lint *.vue files
+    'vue'
+    <% if (lintConfig === 'prettier') { %>
+    // https://github.com/typescript-eslint/typescript-eslint/issues/389#issuecomment-509292674
+    // Prettier has not been included as plugin to avoid performance impact
+    // add it as an extension for your IDE
+    <% } %>
+  ],
+
+  globals: {
+    ga: 'readonly', // Google Analytics
+    cordova: 'readonly',
+    __statics: 'readonly',
+    __QUASAR_SSR__: 'readonly',
+    __QUASAR_SSR_SERVER__: 'readonly',
+    __QUASAR_SSR_CLIENT__: 'readonly',
+    __QUASAR_SSR_PWA__: 'readonly',
+    process: 'readonly',
+    Capacitor: 'readonly',
+    chrome: 'readonly'
+  },
+
+  // add your custom rules here
+  rules: {
+    <% if (lintConfig === 'standard') { %>
+    // allow async-await
+    'generator-star-spacing': 'off',
+    // allow paren-less arrow functions
+    'arrow-parens': 'off',
+    'one-var': 'off',
+    'no-void': 'off',
+    'multiline-ternary': 'off',
+
+    'import/first': 'off',
+    'import/namespace': 'error',
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    'import/no-extraneous-dependencies': 'off',
+
+    // The core 'import/named' rules
+    // does not work with type definitions
+    'import/named': 'off',
+    <% } else if (lintConfig === 'airbnb') { %>
+    'no-param-reassign': 'off',
+    'no-void': 'off',
+    'no-nested-ternary': 'off',
+    'max-classes-per-file': 'off',
+
+    'import/first': 'off'
+    'import/namespace': 'error',
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    'import/no-extraneous-dependencies': 'off',
+    'import/prefer-default-export': 'off',
+
+    // The core 'import/named' rules
+    // does not work with type definitions
+    'import/named': 'off',
+    <% } %>
+    'prefer-promise-reject-errors': 'off',
+
+    quotes: ['warn', 'single', { avoidEscape: true }],
+
+    // this rule, if on, would require explicit return type on the `render` function
+    '@typescript-eslint/explicit-function-return-type': 'off',
+
+    // in plain CommonJS modules, you can't use `import foo = require('foo')` to pass this rule, so it has to be disabled
+    '@typescript-eslint/no-var-requires': 'off',
+
+    // The core 'no-unused-vars' rules (in the eslint:recommeded ruleset)
+    // does not work with type definitions
+    'no-unused-vars': 'off',
+
+    // allow debugger during development only
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
+  }
+}

package/templates/app/quasar-v2/ts-webpack/pinia/src/stores/example-store.ts

@@ -0,0 +1,15 @@
+import { defineStore } from 'pinia';
+
+export const useCounterStore = defineStore('counter', {
+  state: () => ({
+    counter: 0,
+  }),
+  getters: {
+    doubleCount: (state) => state.counter * 2,
+  },
+  actions: {
+    increment() {
+      this.counter++;
+    },
+  },
+});

package/templates/app/quasar-v2/ts-webpack/pinia/src/stores/index.ts

@@ -0,0 +1,20 @@
+import { store } from 'quasar/wrappers'
+import { createPinia } from 'pinia'
+
+/*
+ * If not building with SSR mode, you can
+ * directly export the Store instantiation;
+ *
+ * The function below can be async too; either use
+ * async/await or return a Promise which resolves
+ * with the Store instance.
+ */
+
+export default store((/* { ssrContext } */) => {
+  const pinia = createPinia()
+
+  // You can add Pinia plugins here
+  // pinia.use(SomePiniaPlugin)
+
+  return pinia
+})

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

@@ -0,0 +1,10 @@
+/* eslint-disable */
+// THIS FEATURE-FLAG FILE IS AUTOGENERATED,
+//  REMOVAL OR CHANGES WILL CAUSE RELATED TYPES TO STOP WORKING
+import "quasar/dist/types/feature-flag";
+
+declare module "quasar/dist/types/feature-flag" {
+  interface QuasarFeatureFlags {
+    store: true;
+  }
+}

package/templates/app/quasar-v2/ts-webpack/prettier/_prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "semi": true
+}

package/templates/app/quasar-v2/ts-webpack/sass/src/css/app.sass

@@ -0,0 +1 @@
+// app global css in Sass form

package/templates/app/quasar-v2/ts-webpack/sass/src/css/quasar.variables.sass

@@ -0,0 +1,24 @@
+// Quasar Sass (& SCSS) Variables
+// --------------------------------------------------
+// To customize the look and feel of this app, you can override
+// the Sass/SCSS variables found in Quasar's source Sass/SCSS files.
+
+// Check documentation for full list of Quasar variables
+
+// Your own variables (that are declared here) and Quasar's own
+// ones will be available out of the box in your .vue/.scss/.sass files
+
+// It's highly recommended to change the default colors
+// to match your app's branding.
+// Tip: Use the "Theme Builder" on Quasar's documentation website.
+
+$primary   : #1976D2
+$secondary : #26A69A
+$accent    : #9C27B0
+
+$dark      : #1D1D1D
+
+$positive  : #21BA45
+$negative  : #C10015
+$info      : #31CCEC
+$warning   : #F2C037

package/templates/app/quasar-v2/ts-webpack/scss/src/css/app.scss

@@ -0,0 +1 @@
+// app global css in SCSS form

package/templates/app/quasar-v2/ts-webpack/scss/src/css/quasar.variables.scss

@@ -0,0 +1,24 @@
+// Quasar SCSS (& Sass) Variables
+// --------------------------------------------------
+// To customize the look and feel of this app, you can override
+// the Sass/SCSS variables found in Quasar's source Sass/SCSS files.
+
+// Check documentation for full list of Quasar variables
+
+// Your own variables (that are declared here) and Quasar's own
+// ones will be available out of the box in your .vue/.scss/.sass files
+
+// It's highly recommended to change the default colors
+// to match your app's branding.
+// Tip: Use the "Theme Builder" on Quasar's documentation website.
+
+$primary   : #1976D2;
+$secondary : #26A69A;
+$accent    : #9C27B0;
+
+$dark      : #1D1D1D;
+
+$positive  : #21BA45;
+$negative  : #C10015;
+$info      : #31CCEC;
+$warning   : #F2C037;

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/index.ts

@@ -0,0 +1,54 @@
+import { store } from 'quasar/wrappers'
+import { InjectionKey } from 'vue'
+import {
+  createStore,
+  Store as VuexStore,
+  useStore as vuexUseStore,
+} from 'vuex'
+
+// import example from './module-example'
+// import { ExampleStateInterface } from './module-example/state';
+
+/*
+ * If not building with SSR mode, you can
+ * directly export the Store instantiation;
+ *
+ * The function below can be async too; either use
+ * async/await or return a Promise which resolves
+ * with the Store instance.
+ */
+
+export interface StateInterface {
+  // Define your own store structure, using submodules if needed
+  // example: ExampleStateInterface;
+  // Declared as unknown to avoid linting issue. Best to strongly type as per the line above.
+  example: unknown
+}
+
+// provide typings for `this.$store`
+declare module '@vue/runtime-core' {
+  interface ComponentCustomProperties {
+    $store: VuexStore<StateInterface>
+  }
+}
+
+// provide typings for `useStore` helper
+export const storeKey: InjectionKey<VuexStore<StateInterface>> = Symbol('vuex-key')
+
+export default store(function (/* { ssrContext } */) {
+  const Store = createStore<StateInterface>({
+    modules: {
+      // example
+    },
+
+    // enable strict mode (adds overhead!)
+    // for dev mode and --debug builds only
+    strict: !!process.env.DEBUGGING
+  })
+
+  return Store;
+})
+
+export function useStore() {
+  return vuexUseStore(storeKey)
+}

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/module-example/actions.ts

@@ -0,0 +1,11 @@
+import { ActionTree } from 'vuex';
+import { StateInterface } from '../index';
+import { ExampleStateInterface } from './state';
+
+const actions: ActionTree<ExampleStateInterface, StateInterface> = {
+  someAction (/* context */) {
+    // your code
+  }
+};
+
+export default actions;

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/module-example/getters.ts

@@ -0,0 +1,11 @@
+import { GetterTree } from 'vuex';
+import { StateInterface } from '../index';
+import { ExampleStateInterface } from './state';
+
+const getters: GetterTree<ExampleStateInterface, StateInterface> = {
+  someAction (/* context */) {
+    // your code
+  }
+};
+
+export default getters;

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/module-example/index.ts

@@ -0,0 +1,16 @@
+import { Module } from 'vuex';
+import { StateInterface } from '../index';
+import state, { ExampleStateInterface } from './state';
+import actions from './actions';
+import getters from './getters';
+import mutations from './mutations';
+
+const exampleModule: Module<ExampleStateInterface, StateInterface> = {
+  namespaced: true,
+  actions,
+  getters,
+  mutations,
+  state
+};
+
+export default exampleModule;

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/module-example/mutations.ts

@@ -0,0 +1,10 @@
+import { MutationTree } from 'vuex';
+import { ExampleStateInterface } from './state';
+
+const mutation: MutationTree<ExampleStateInterface> = {
+  someMutation (/* state: ExampleStateInterface */) {
+    // your code
+  }
+};
+
+export default mutation;

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/module-example/state.ts

@@ -0,0 +1,11 @@
+export interface ExampleStateInterface {
+  prop: boolean;
+}
+
+function state(): ExampleStateInterface {
+  return {
+    prop: false
+  }
+};
+
+export default state;

package/templates/app/quasar-v2/ts-webpack/vuex/src/store/store-flag.d.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+// THIS FEATURE-FLAG FILE IS AUTOGENERATED,
+//  REMOVAL OR CHANGES WILL CAUSE RELATED TYPES TO STOP WORKING
+import "quasar/dist/types/feature-flag";
+
+declare module "quasar/dist/types/feature-flag" {
+  interface QuasarFeatureFlags {
+    store: true;
+  }
+}

package/templates/app-extension/ae-v1/BASE/README.md

@@ -0,0 +1,36 @@
+Quasar App Extension <%= name %>
+===
+
+_Be sure to change this readme as appropriate for your app extension._
+
+_Think about the organization of this file and how the information will be beneficial to the user._
+
+> Add a short description of your App Extension. What does it do? How is it beneficial? Why would someone want to use it?
+
+<%= description %>
+
+# Install
+```bash
+quasar ext add <%= name %>
+```
+Quasar CLI will retrieve it from the NPM registry and install the extension to your project.
+
+<% if (preset.prompts) { %>
+## Prompts
+
+> Explain the prompts here
+
+<% } %>
+# Uninstall
+```bash
+quasar ext remove <%= name %>
+```
+
+# Info
+> Add longer information here that will help the user of your app extension.
+
+# Other Info
+> Add other information that's not as important to know
+
+# Donate
+If you appreciate the work that went into this App Extension, please consider [donating to Quasar](https://donate.quasar.dev).

package/templates/app-extension/ae-v1/BASE/_gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+.thumbs.db
+node_modules
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln

package/templates/app-extension/ae-v1/BASE/package.json

@@ -0,0 +1,23 @@
+{
+  <% if (needOrgName) { %>"name": "@<%= orgName %>/quasar-app-extension-<%= name %>",
+  <% } else { %>"name": "quasar-app-extension-<%= name %>",<% } %>
+  "version": "0.0.1",
+  "description": "<%= description %>",
+  "author": "<%= author %>",
+  "license": "<%= license %>",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "echo \"No test specified\" && exit 0"
+  },
+  "repository": {
+    "type": "<%= repositoryType %>",
+    "url": "<%= repositoryURL %>"
+  },
+  "bugs": "<%= bugs %>",
+  "homepage": "<%= homepage %>",
+  "engines": {
+    "node": ">= 12.2.0",
+    "npm": ">= 5.6.0",
+    "yarn": ">= 1.6.0"
+  }
+}

package/templates/app-extension/ae-v1/BASE/src/index.js

@@ -0,0 +1,11 @@
+/**
+ * Quasar App Extension index/runner script
+ * (runs on each dev/build)
+ *
+ * Docs: https://quasar.dev/app-extensions/development-guide/index-api
+ * API: https://github.com/quasarframework/quasar/blob/master/app/lib/app-extension/IndexAPI.js
+ */
+
+module.exports = function (api) {
+  //
+}

package/templates/app-extension/ae-v1/index.js

@@ -0,0 +1,85 @@
+
+module.exports = async function ({ scope, utils }) {
+  await utils.prompts(scope, [
+    {
+      type: 'confirm',
+      name: 'needOrgName',
+      initial: false,
+      message: 'Will you use an organization to publish it? Eg. "@my-org/..."'
+    },
+    {
+      type: (_, { needOrgName } = {}) => needOrgName ? 'text' : null,
+      name: 'orgName',
+      message: 'Organization name, eg. "my-org":',
+      validate: val =>
+        val && val.length > 0 || 'Please type the organization name'
+    },
+    {
+      type: 'text',
+      name: 'name',
+      message: 'Quasar App Extension ext-id (without "quasar-app-extension" prefix), eg. "my-ext"',
+      validate: (val) =>
+        utils.isValidPackageName(val) || 'Invalid App Extension name'
+    },
+
+    utils.commonPrompts.description,
+    utils.commonPrompts.author,
+    {
+      type: 'text',
+      name: 'license',
+      initial: 'MIT',
+      message: 'License type:'
+    },
+    {
+      type: 'multiselect',
+      name: 'preset',
+      message: 'Pick the needed scripts:',
+      choices: [
+        {
+          title: 'Prompts script',
+          value: 'prompts'
+        },
+        {
+          title: 'Install script',
+          value: 'install'
+        },
+        {
+          title: 'Uninstall script',
+          value: 'uninstall'
+        }
+      ],
+      format: utils.convertArrayToObject
+    },
+    {
+      type: 'text',
+      name: 'repositoryType',
+      initial: 'git',
+      message: 'Repository type:'
+    },
+    {
+      type: 'text',
+      name: 'repositoryURL',
+      message: 'Repository URL (eg https://github.com/quasarframework/quasar):'
+    },
+    {
+      type: 'text',
+      name: 'homepage',
+      message: 'Homepage URL:'
+    },
+    {
+      type: 'text',
+      name: 'bugs',
+      message: 'Issue reporting URL (eg https://github.com/quasarframework/quasar/issues):'
+    }
+  ])
+
+  utils.createTargetDir(scope)
+  utils.renderTemplate(utils.join(__dirname, 'BASE'), scope)
+
+  if (scope.preset.prompts) utils.renderTemplate(utils.join(__dirname, 'prompts-script'), scope)
+  if (scope.preset.install) utils.renderTemplate(utils.join(__dirname, 'install-script'), scope)
+  if (scope.preset.uninstall) utils.renderTemplate(utils.join(__dirname, 'uninstall-script'), scope)
+
+  // nothing to install, so we'll skip it
+  scope.skipDepsInstall = true
+}

package/templates/app-extension/ae-v1/install-script/install.js

@@ -0,0 +1,10 @@
+/**
+ * Quasar App Extension install script
+ *
+ * Docs: https://quasar.dev/app-extensions/development-guide/install-api
+ * API: https://github.com/quasarframework/quasar/blob/master/app/lib/app-extension/InstallAPI.js
+ */
+
+module.exports = function (api) {
+  //
+}

package/templates/app-extension/ae-v1/prompts-script/prompts.js

@@ -0,0 +1,44 @@
+/**
+ * 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'
+        }
+      ]
+    }
+  ]
+
+ */
+
+module.exports = function () {
+  return []
+}

package/templates/app-extension/ae-v1/uninstall-script/uninstall.js

@@ -0,0 +1,10 @@
+/**
+ * Quasar App Extension uninstall script
+ *
+ * Docs: https://quasar.dev/app-extensions/development-guide/uninstall-api
+ * API: https://github.com/quasarframework/quasar/blob/master/app/lib/app-extension/UninstallAPI.js
+ */
+
+module.exports = function (api) {
+  //
+}

package/templates/app-extension/index.js

@@ -0,0 +1,4 @@
+module.exports = async function ({ scope, utils }) {
+  const script = require('./ae-v1')
+  await script({ scope, utils })
+}