npm - create-quasar - Versions diffs - 0.0.1 → 1.0.2 - Mend

create-quasar 0.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (429) hide show

package/templates/ui-kit/quasar-v1/BASE/ui/package.json ADDED Viewed

@@ -0,0 +1,47 @@
+{
+  "name": "quasar-ui-<%= name %>",
+  "version": "0.0.1",
+  "author": "<%= author %>",
+  "description": "<%= packageDescription %>",
+  "license": "<%= license %>",
+  "module": "dist/index.esm.js",
+  "main": "dist/index.common.js",
+  "scripts": {
+    "dev": "cd dev && yarn dev && cd ..",
+    "dev:umd": "yarn build && node build/script.open-umd.js",
+    "dev:ssr": "cd dev && yarn 'dev:ssr' && cd ..",
+    "dev:ios": "cd dev && yarn 'dev:ios' && cd ..",
+    "dev:android": "cd dev && yarn 'dev:android' && cd ..",
+    "dev:electron": "cd dev && yarn 'dev:electron' && cd ..",
+    "build": "node build/index.js",
+    "build:js": "node build/script.javascript.js",
+    "build:css": "node build/script.css.js"
+  },
+  "repository": {
+    "type": "<%= repositoryType %>",
+    "url": "<%= repositoryURL %>"
+  },
+  "bugs": "<%= bugs %>",
+  "homepage": "<%= homepage %>",
+  "devDependencies": {
+    "autoprefixer": "^10.0.2",
+    "cssnano": "^4.1.10",
+    "postcss": "^8.1.9",
+    "rtlcss": "^2.6.1",
+    "sass": "1.32.0",
+    "quasar": "^1.0.0",
+    "open": "^7.3.0",
+    "fs-extra": "^8.1.0",
+    "chalk": "^4.1.0",
+    "rimraf": "^3.0.0",
+    "rollup": "^2.33.3",
+    "@rollup/plugin-buble": "^0.20.0",
+    "@rollup/plugin-json": "^4.0.0",
+    "@rollup/plugin-node-resolve": "^10.0.0",
+    "uglify-es": "^3.3.9",
+    "zlib": "^1.0.5"
+  },
+  "browserslist": [
+    "last 1 version, not dead, ie >= 11"
+  ]
+}

package/templates/ui-kit/quasar-v1/BASE/ui/src/index.js ADDED Viewed

@@ -0,0 +1,23 @@
+import { version } from '../package.json'
+<% if (features.component) { %>import Component from './components/Component'<% } %>
+<% if (features.directive) { %>import Directive from './directives/Directive'<% } %>
+export {
+  version,
+  <% if (features.component) { %>Component<% if (features.directive) { %>,<% } } %>
+  <% if (features.directive) { %>Directive<% } %>
+}
+export default {
+  version,
+  <% if (features.component) { %>Component,<% } %>
+  <% if (features.directive) { %>Directive,<% } %>
+  install (Vue) {
+    <% if (features.component) { %>Vue.component(Component.name, Component)<% } %>
+    <% if (features.directive) { %>Vue.directive(Directive.name, Directive)<% } %>
+  }
+}

package/templates/ui-kit/quasar-v1/BASE/ui/src/index.sass ADDED Viewed

@@ -0,0 +1,3 @@
+@import 'quasar/src/css/variables.sass'
+@import './components/Component.sass'
+@import './directives/Directive.sass'

package/templates/ui-kit/quasar-v1/BASE/ui/src/mixins/_gitkeep ADDED Viewed

File without changes

package/templates/ui-kit/quasar-v1/BASE/ui/umd-test.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="format-detection" content="telephone=no">
+    <meta name="msapplication-tap-highlight" content="no">
+    <meta name="viewport" content="user-scalable=no,initial-scale=1,maximum-scale=1,minimum-scale=1,width=device-width">
+    <title>UMD test</title>
+    <link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700|Material+Icons" rel="stylesheet" type="text/css">
+    <link href="https://cdn.jsdelivr.net/npm/quasar@^1.0.0/dist/quasar.min.css" rel="stylesheet" type="text/css">
+    <link href="dist/index.css" rel="stylesheet" type="text/css">
+  </head>
+  <body>
+    <div id="q-app">
+      <q-layout view="lHh Lpr fff">
+        <q-header class="glossy bg-primary">
+          <q-toolbar>
+            <q-toolbar-title>
+              quasar-ui-<%= name %> v{{ version }}
+            </q-toolbar-title>
+            <div>Quasar v{{ $q.version }}</div>
+          </q-toolbar>
+        </q-header>
+        <q-page-container>
+          <q-page padding>
+            <ul class="q-mb-lg">
+              <li>In /ui, run: "yarn build"</li>
+              <li class="text-red">You need to build & refresh page on each change manually.</li>
+              <li>Use self-closing tags only!</li>
+              <li>Example: &lt;my-component&gt;&lt;/my-component&gt;</li>
+            </ul>
+          </q-page>
+        </q-page-container>
+      </q-layout>
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/quasar@^1.0.0/dist/quasar.ie.polyfills.umd.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/vue@^2.0.0/dist/vue.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/quasar@^1.0.0/dist/quasar.umd.min.js"></script>
+    <script src="dist/index.umd.js"></script>
+    <script>
+      new Vue({
+        el: '#q-app',
+        data: function () {
+          return {
+            version: <%= umdExportName %>.version
+          }
+        }
+      })
+    </script>
+  </body>
+</html>

package/templates/ui-kit/quasar-v1/ae/app-extension/README.md ADDED Viewed

@@ -0,0 +1,33 @@
+# Quasar App Extension <%= name %>
+> Add a short description of your App Extension. What does it do? How is it beneficial? Why would someone want to use it?
+[![npm](https://img.shields.io/npm/v/quasar-app-extension-<%= name %>.svg?label=quasar-app-extension-<%= name %>)](https://www.npmjs.com/package/quasar-app-extension-<%= name %>)
+[![npm](https://img.shields.io/npm/dt/quasar-app-extension-<%= name %>.svg)](https://www.npmjs.com/package/quasar-app-extension-<%= name %>)
+# Install
+```bash
+quasar ext add <%= name %>
+```
+Quasar CLI will retrieve it from NPM and install the extension.
+## Prompts
+> If your app extension uses prompts, explain them here, otherwise remove this section and remove prompts.js file.
+# 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).
+# License
+<%= license %> (c) <%= author %>

package/templates/ui-kit/quasar-v1/ae/app-extension/_npmignore ADDED Viewed

@@ -0,0 +1,17 @@
+.DS_Store
+.thumbs.db
+yarn.lock
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+.editorconfig
+.eslintignore
+.eslintrc.js

package/templates/ui-kit/quasar-v1/ae/app-extension/package.json ADDED Viewed

@@ -0,0 +1,22 @@
+{
+  "name": "quasar-app-extension-<%= name %>",
+  "version": "0.0.1",
+  "description": "<%= aeDescription %>",
+  "author": "<%= author %>",
+  "license": "<%= license %>",
+  "main": "src/index.js",
+  "repository": {
+    "type": "<%= repositoryType %>",
+    "url": "<%= repositoryURL %>"
+  },
+  "bugs": "<%= bugs %>",
+  "homepage": "<%= homepage %>",
+  "dependencies": {
+    "quasar-ui-<%= name %>": "latest"
+  },
+  "engines": {
+    "node": ">= 8.9.0",
+    "npm": ">= 5.6.0",
+    "yarn": ">= 1.6.0"
+  }
+}

package/templates/ui-kit/quasar-v1/ae/app-extension/src/boot/register.js ADDED Viewed

@@ -0,0 +1,4 @@
+import Vue from 'vue'
+import VuePlugin from 'quasar-ui-<%= name %>'
+Vue.use(VuePlugin)

package/templates/ui-kit/quasar-v1/ae/app-extension/src/index.js ADDED Viewed

@@ -0,0 +1,37 @@
+/**
+ * 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
+ */
+function extendConf (conf) {
+  // register our boot file
+  conf.boot.push('~quasar-app-extension-<%= name %>/src/boot/register.js')
+  // make sure app extension files & ui package gets transpiled
+  conf.build.transpileDependencies.push(/quasar-app-extension-<%= name %>[\\/]src/)
+  // make sure the stylesheet goes through webpack to avoid SSR issues
+  conf.css.push('~quasar-ui-<%= name %>/src/index.sass')
+}
+module.exports = function (api) {
+  // 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', '^1.1.1')
+  api.compatibleWith('@quasar/app', '^2.0.0')
+<% if (features.component) { %>
+  // Uncomment the line below if you provide a JSON API for your component
+  // api.registerDescribeApi('<%= componentName %>', '~quasar-ui-<%= name %>/src/components/<%= componentName %>.json')
+<% } %><% if (features.directive) { %>
+  // Uncomment the line below if you provide a JSON API for your directive
+  // api.registerDescribeApi('<%= directiveName %>', '~quasar-ui-<%= name %>/src/directives/<%= directiveName %>.json')
+<% } %>
+  // We extend /quasar.conf.js
+  api.extendQuasarConf(extendConf)
+}

package/templates/ui-kit/quasar-v1/ae/app-extension/src/templates/_gitkeep ADDED Viewed

File without changes

package/templates/ui-kit/quasar-v1/ae-install/app-extension/src/install.js ADDED Viewed

@@ -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/ui-kit/quasar-v1/ae-prompts/app-extension/src/prompts.js ADDED Viewed

@@ -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: 'string',
+      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/ui-kit/quasar-v1/ae-uninstall/app-extension/src/uninstall.js ADDED Viewed

@@ -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/ui-kit/quasar-v1/index.js ADDED Viewed

@@ -0,0 +1,19 @@
+module.exports = async function ({ scope, utils }) {
+  utils.createTargetDir(scope)
+  utils.renderTemplate(utils.join(__dirname, 'BASE'), scope)
+  if (scope.features.ae) {
+    utils.renderTemplate(utils.join(__dirname, 'ae'), scope)
+    if (scope.preset.install) utils.renderTemplate(utils.join(__dirname, 'ae-install'), scope)
+    if (scope.preset.prompts) utils.renderTemplate(utils.join(__dirname, 'ae-prompts'), scope)
+    if (scope.preset.uninstall) utils.renderTemplate(utils.join(__dirname, 'ae-uninstall'), scope)
+  }
+  if (scope.features.component) utils.renderTemplate(utils.join(__dirname, 'ui-component'), scope)
+  if (scope.features.directive) utils.renderTemplate(utils.join(__dirname, 'ui-directive'), scope)
+  if (scope.features.ae && (scope.features.component || scope.features.directive)) {
+    utils.renderTemplate(utils.join(__dirname, 'ui-ae'), scope)
+  }
+}

package/templates/ui-kit/quasar-v1/ui-ae/ui/build/script.app-ext.js ADDED Viewed

@@ -0,0 +1,60 @@
+const
+  fs = require('fs'),
+  path = require('path'),
+  root = path.resolve(__dirname, '../..'),
+  resolvePath = file => path.resolve(root, file),
+  { blue } = require('chalk')
+const writeJson = function (file, json) {
+  return fs.writeFileSync(file, JSON.stringify(json, null, 2) + '\n', 'utf-8')
+}
+module.exports.syncAppExt = function (both = true) {
+  // make sure this project has an app-extension project
+  const appExtDir = resolvePath('app-extension')
+  if (!fs.existsSync(appExtDir)) {
+    return
+  }
+  // make sure this project has an ui project
+  const uiDir = resolvePath('ui')
+  if (!fs.existsSync(uiDir)) {
+    return
+  }
+  // get version and name from ui package.json
+  const { name, version } = require(resolvePath(resolvePath('ui/package.json')))
+  // read app-ext package.json
+  const appExtFile = resolvePath('app-extension/package.json')
+  let appExtJson = require(appExtFile),
+    finished = false
+  // sync version numbers
+  if (both === true) {
+    appExtJson.version = version
+  }
+  // check dependencies
+  if (appExtJson.dependencies !== void 0) {
+    if (appExtJson.dependencies[name] !== void 0) {
+      appExtJson.dependencies[name] = '^' + version
+      finished = true
+    }
+  }
+  // check devDependencies, if not finished
+  if (finished === false && appExtJson.devDependencies !== void 0) {
+    if (appExtJson.devDependencies[name] !== void 0) {
+      appExtJson.devDependencies[name] = '^' + version
+      finished = true
+    }
+  }
+  if (finished === true) {
+    writeJson(appExtFile, appExtJson)
+    console.log(` ⭐️ App Extension version ${blue(appExtJson.name)} synced with UI version.\n`)
+    return
+  }
+  console.error(`   App Extension version and dependency NOT synced.\n`)
+}

package/templates/ui-kit/quasar-v1/ui-component/ui/src/components/Component.js ADDED Viewed

@@ -0,0 +1,14 @@
+import { QBadge } from 'quasar'
+export default {
+  name: '<%= componentName %>',
+  render (h) {
+    return h(QBadge, {
+      staticClass: '<%= componentName %>',
+      props: {
+        label: '<%= componentName %>'
+      }
+    })
+  }
+}

package/templates/ui-kit/quasar-v1/ui-component/ui/src/components/Component.sass ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ .<%= componentName %>
2	+ font-weight: bold

package/templates/ui-kit/quasar-v1/ui-directive/ui/src/directives/Directive.js ADDED Viewed

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

package/templates/ui-kit/quasar-v1/ui-directive/ui/src/directives/Directive.sass ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ .<%= directiveName %>
2	+ font-size: 14px

package/templates/ui-kit/quasar-v2/BASE/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) <%= author %>
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/templates/ui-kit/quasar-v2/BASE/README.md ADDED Viewed

@@ -0,0 +1,16 @@
+<img src="https://img.shields.io/npm/v/quasar-ui-<%= name %>.svg?label=quasar-ui-<%= name %>">
+<% if (features.ae) { %><img src="https://img.shields.io/npm/v/quasar-app-extension-<%= name %>.svg?label=quasar-app-extension-<%= name %>"><% } %>
+Compatible with Quasar UI v2 and Vue 3.
+# Structure
+* [/ui](ui) - standalone npm package
+<% if (features.ae) { %>
+* [/app-extension](app-extension) - Quasar app extension
+<% } %>
+# Donate
+If you appreciate the work that went into this project, please consider [donating to Quasar](https://donate.quasar.dev).
+# License
+<%= license %> (c) <%= author %>

package/templates/ui-kit/quasar-v2/BASE/_gitignore ADDED Viewed

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

package/templates/ui-kit/quasar-v2/BASE/jsconfig.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "ui/*": ["src/*"]
+    }
+  }
+}

package/templates/ui-kit/quasar-v2/BASE/ui/README.md ADDED Viewed

@@ -0,0 +1,156 @@
+# <% if (features.component) { %>Component <%= componentName %><% if (features.directive) { %> and <% } } %><% if (features.directive) { %>Directive v-<%= directiveName %><% } %>
+[![npm](https://img.shields.io/npm/v/quasar-ui-<%= name %>.svg?label=quasar-ui-<%= name %>)](https://www.npmjs.com/package/quasar-ui-<%= name %>)
+[![npm](https://img.shields.io/npm/dt/quasar-ui-<%= name %>.svg)](https://www.npmjs.com/package/quasar-ui-<%= name %>)
+**Compatible with Quasar UI v2 and Vue 3**.
+<% if (features.component) { %>
+# Component <%= componentName %>
+> Short description of the component
+<% } %>
+<% if (features.directive) { %>
+# Directive v-<%= directiveName %>
+> Short description of the directive
+<% } %>
+# Usage
+## Quasar CLI project
+<% if (features.ae) { %>
+Install the [App Extension](../app-extension).
+**OR**:
+<% } %>
+Create and register a boot file:
+```js
+import Vue from 'vue'
+import Plugin from 'quasar-ui-<%= name %>'
+import 'quasar-ui-<%= name %>/dist/index.css'
+Vue.use(Plugin)
+```
+**OR**:
+```html
+<style src="quasar-ui-<%= name %>/dist/index.css"></style>
+<script>
+import { <% if (features.component) { %>Component as <%= componentName %><% if (features.directive) { %>, <% } %><% } %><% if (features.directive) { %>Directive<% } %> } from 'quasar-ui-<%= name %>'
+export default {
+  <% if (features.component) { %>
+  components: {
+    <%= componentName %>
+  }<% if (features.directive) { %>,<% } %>
+  <% } %>
+  <% if (features.directive) { %>
+  directives: {
+    Directive
+  }
+  <% } %>
+}
+</script>
+```
+## Vue CLI project
+```js
+import Vue from 'vue'
+import Plugin from 'quasar-ui-<%= name %>'
+import 'quasar-ui-<%= name %>/dist/index.css'
+Vue.use(Plugin)
+```
+**OR**:
+```html
+<style src="quasar-ui-<%= name %>/dist/index.css"></style>
+<script>
+import { <% if (features.component) { %>Component as <%= componentName %><% if (features.directive) { %>, <% } %><% } %><% if (features.directive) { %>Directive<% } %> } from 'quasar-ui-<%= name %>'
+export default {
+  <% if (features.component) { %>
+  components: {
+    <%= componentName %>
+  }<% if (features.directive) { %>,<% } %>
+  <% } %>
+  <% if (features.directive) { %>
+  directives: {
+    Directive
+  }
+  <% } %>
+}
+</script>
+```
+## UMD variant
+Exports `window.<%= umdExportName %>`.
+Add the following tag(s) after the Quasar ones:
+```html
+<head>
+  <!-- AFTER the Quasar stylesheet tags: -->
+  <link href="https://cdn.jsdelivr.net/npm/quasar-ui-<%= name %>/dist/index.min.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+  <!-- at end of body, AFTER Quasar script(s): -->
+  <script src="https://cdn.jsdelivr.net/npm/quasar-ui-<%= name %>/dist/index.umd.min.js"></script>
+</body>
+```
+If you need the RTL variant of the CSS, then go for the following (instead of the above stylesheet link):
+```html
+<link href="https://cdn.jsdelivr.net/npm/quasar-ui-<%= name %>/dist/index.rtl.min.css" rel="stylesheet" type="text/css">
+```
+# Setup
+```bash
+$ yarn
+```
+# Developing
+```bash
+# start dev in SPA mode
+$ yarn dev
+# start dev in UMD mode
+$ yarn dev:umd
+# start dev in SSR mode
+$ yarn dev:ssr
+# start dev in Cordova iOS mode
+$ yarn dev:ios
+# start dev in Cordova Android mode
+$ yarn dev:android
+# start dev in Electron mode
+$ yarn dev:electron
+```
+# Building package
+```bash
+$ yarn build
+```
+# Adding Testing Components
+in the `ui/dev/src/pages` you can add Vue files to test your component/directive. When using `yarn dev` to build the UI, any pages in that location will automatically be picked up by dynamic routing and added to the test page.
+# Adding Assets
+If you have a component that has assets, like language or icon-sets, you will need to provide these for UMD. In the `ui/build/script.javascript.js` file, you will find a couple of commented out commands that call `addAssets`. Uncomment what you need and add your assets to have them be built and put into the `ui/dist` folder.
+# Donate
+If you appreciate the work that went into this, please consider [donating to Quasar](https://donate.quasar.dev).
+# License
+<%= license %> (c) <%= author %>