@hap-toolkit/dsl-xvm 1.9.11 → 1.9.12

package/templates/app/demo/package.json

@@ -1,22 +1,59 @@
 {
-  "name": "{{ appName }}",
-  "version": "1.0.0",
-  "description": "",
-  "engines": {
-    "node": ">=8.10"
-  },
+  "name": "quickapp-sample-template",
+  "version": "2.0.0",
+  "description": "Quickapp Sample Template",
   "scripts": {
     "start": "hap server --watch",
+    "server": "hap server",
     "build": "hap build",
     "release": "hap release",
-    "server": "hap server",
     "watch": "hap watch",
-    "lint": "eslint --format codeframe --fix --ext .ux,.js src/"
+    "debug": "hap debug",
+    "gen": "node ./scripts/gen/index.js",
+    "precommit-msg": "echo '🚧 start pre-commit checks ...' && exit 0",
+    "prettier": "node ./scripts/selfCloseInputTag.js && prettier --write \"src/**/*.{js,ux,less,scss,css}\"",
+    "prettier-watcher": "onchange '**/*.md' \"src/**/**/*.{js,ux,less,scss,css}\" -- prettier --write {{changed}}"
+  },
+  "dependencies": {
+    "apex-ui": "^1.9.2"
   },
   "devDependencies": {
-    "babel-eslint": "^10.0.1",
-    "eslint": "^6.8.0",
-    "eslint-plugin-ux": "^0.0.4",
-    "hap-toolkit":"^{{ toolkitVersion }}"
-  }
+    "@babel/runtime": "^7.12.5",
+    "@types/quickapp": "git+https://github.com/vivoquickapp/quickapp-types.git",
+    "husky": "^4.3.0",
+    "lint-staged": "^10.5.1",
+    "onchange": "^5.2.0",
+    "prettier": "^1.15.3",
+    "prettier-plugin-ux": "^0.3.0",
+    "sass": "^1.32.6",
+    "sass-loader": "^10.1.1",
+    "colors": "^1.4.0",
+    "hap-toolkit": "^{{ toolkitVersion }}"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "semi": false,
+    "printWidth": 80,
+    "proseWrap": "never",
+    "tabWidth": 2
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn run precommit-msg && lint-staged"
+    }
+  },
+  "lint-staged": {
+    "**/**.{ux,js,json,pcss,md}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "keywords": [
+    "快应用",
+    "快应用示例",
+    "快应用模版"
+  ],
+  "browserslist": [
+    "chrome 65"
+  ]
 }

package/templates/app/demo/scripts/gen/index.js

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @desc: gen script command，make a new page generated by one click.
+ * @author: nicejade
+ */
+
+const fs = require('fs')
+const path = require('path')
+const colors = require('colors')
+
+const newFolderName = process.argv[2]
+
+String.prototype.firstUpperCase = function () {
+  return this.replace(/\b(\w)/g, ($1) => {
+    return $1.toLowerCase()
+  })
+}
+const resolve = (dir) => {
+  return path.join(__dirname, '../..', dir)
+}
+
+const successExecPrint = (msg) => {
+  console.log(
+    colors.green(`✓ `) +
+      colors.cyan(`${msg} `) +
+      colors.green('task has been successfully executed.')
+  )
+}
+
+function createNewPage(newFolderPath) {
+  const mReg = new RegExp('@PAGE_CLASS_NAME', 'g')
+  const pageContent = fs.readFileSync(`${__dirname}/template.ux`, 'UTF-8')
+  const rootClassName = newFolderName
+    .firstUpperCase()
+    .replace(/([A-Z])/g, '-$1')
+    .toLowerCase()
+  const newContent = pageContent.replace(mReg, rootClassName)
+
+  fs.mkdirSync(newFolderPath, 0777)
+  fs.writeFile(`${newFolderPath}/index.ux`, newContent, (error) => {
+    if (error) throw `Something went wrong: ${error}`
+  })
+  successExecPrint('Create New Page')
+}
+
+function saveRouter2Manifest() {
+  const manifestPath = resolve('/src/manifest.json')
+  let manifestConf = fs.readFileSync(manifestPath, 'UTF-8')
+  manifestConf = JSON.parse(manifestConf)
+  const routerPages = manifestConf.router.pages
+  routerPages[`pages/${newFolderName}`] = {
+    component: 'index',
+  }
+  manifestConf = JSON.stringify(manifestConf, null, 2)
+  fs.writeFile(manifestPath, manifestConf, (error) => {
+    if (error) throw `Something went wrong[@saveRouter2Manifest]: ${error}`
+  })
+  successExecPrint('Save Router Into Manifest')
+}
+
+function main() {
+  if (!newFolderName) {
+    return console.warn(
+      `⚠️  Please enter the name of the page you want to create.`.underline.red
+    )
+  }
+
+  const folderNameReg = /^[A-Z][[A-Za-z0-9]+$/
+  if (!folderNameReg.test(newFolderName)) {
+    return console.warn(
+      `⚠️  Please enter the standard Folder name. Eg: XyzAbcde.`.underline.red
+    )
+  }
+
+  const newFolderPath = path.join(__dirname, `../../src/pages/${newFolderName}`)
+  const isExist = fs.existsSync(newFolderPath)
+
+  if (isExist) {
+    return console.warn(
+      `⚠️  ${newFolderName} already exists in the /src/pages/ directory.`
+        .underline.red
+    )
+  }
+  createNewPage(newFolderPath)
+  saveRouter2Manifest()
+}
+
+main()

package/templates/app/demo/scripts/gen/template.ux

@@ -0,0 +1,32 @@
+<!-- 
+  Copyright (c) 2021-present, the hapjs-platform Project Contributors
+  SPDX-License-Identifier: Apache-2.0
+-->
+
+<template>
+  <div class="wrapper">
+    <text class="title">{{ title }}</text>
+  </div>
+</template>
+
+<script>
+export default {
+  private: {
+    title: '欢迎体验快应用开发'
+  },
+
+  onInit() {}
+}
+</script>
+
+<style lang="scss">
+@import './../../assets/styles/style.scss';
+.wrapper {
+  @include flex-box-mixins(column, center, center);
+  .title {
+    font-size: 8 * $size-factor;
+    text-align: center;
+    color: $black;
+  }
+}
+</style>

package/templates/app/demo/scripts/selfCloseInputTag.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file: selfCloseInputTag.js
+ * @desc: 遍历指定目录下 .ux 文件，将其中 input 标签由 <input **></input> 转换为 <input ** />
+ * @date: 2019-01-23
+ */
+
+const fs = require('fs')
+const path = require('path')
+
+const quickappCodePath = './src/'
+
+const main = (codePath) => {
+  const traversing = (cpath) => {
+    const files = fs.readdirSync(cpath)
+    files.forEach((fileName) => {
+      const fPath = path.join(cpath, fileName)
+      const stats = fs.statSync(fPath)
+      stats.isDirectory() && traversing(fPath)
+      stats.isFile() && fPath.endsWith('.ux') && matchAndReplace(fPath)
+    })
+  }
+  traversing(codePath)
+}
+
+const matchAndReplace = (path) => {
+  const pageContent = fs.readFileSync(path, 'UTF-8')
+  const newContent = pageContent.replace(
+    /(<)([\s]*?)(input\b[^\/]*?)>[\s\S]*?<\/input>/gm,
+    '$1$3 />'
+  )
+  fs.writeFile(path, newContent, (error) => {
+    if (error) throw `Something went wrong: ${error}`
+  })
+}
+
+main(quickappCodePath)

package/templates/app/demo/src/CardDemo/index.ux

@@ -1,8 +1,13 @@
+<!-- 
+  Copyright (c) 2021-present, the hapjs-platform Project Contributors
+  SPDX-License-Identifier: Apache-2.0
+-->
+
 <template>
   <!-- template里只能有一个根节点 -->
   <div class="demo-page">
-    <text>{{text}}</text>
-    <text>{{des}}</text>
+    <text>{{ text }}</text>
+    <text>{{ des }}</text>
   </div>
 </template>
 
@@ -10,15 +15,16 @@
 export default {
   private: {
     text: '欢迎使用快应用卡片',
-    des: '卡片是一种轻量级的快应用，快应用卡片使快应用能够在其他app和系统里提供可扩展的app功能'
+    des:
+      '卡片是一种轻量级的快应用，快应用卡片使快应用能够在其他app和系统里提供可扩展的app功能'
   }
 }
 </script>
 
 <style>
-  .demo-page {
-    flex: 1;
-    flex-direction: column;
-    align-items: center;
-  }
+.demo-page {
+  flex: 1;
+  flex-direction: column;
+  align-items: center;
+}
 </style>

package/templates/app/demo/src/Demo/index.ux

@@ -1,3 +1,10 @@
+<!-- 
+  Copyright (c) 2021-present, the hapjs-platform Project Contributors
+  SPDX-License-Identifier: Apache-2.0
+-->
+
+
+
 <template>
   <!-- template里只能有一个根节点 -->
   <div class="demo-page">

package/templates/app/demo/src/DemoDetail/index.ux

@@ -1,3 +1,10 @@
+<!-- 
+  Copyright (c) 2021-present, the hapjs-platform Project Contributors
+  SPDX-License-Identifier: Apache-2.0
+-->
+
+
+
 <template>
   <!-- template里只能有一个根节点 -->
   <div class="demo-page">

package/templates/app/demo/src/app.ux

@@ -1,14 +1,22 @@
+<!-- 
+  Copyright (c) 2021-present, the hapjs-platform Project Contributors
+  SPDX-License-Identifier: Apache-2.0
+-->
+
 <script>
 /**
- * @file 应用级别的配置，供所有页面公用
- * 可在app.ux导出公用变量
- * 其他src目录下的ux文件使用this.$app.$def.<paramName>即可调用此处导出的变量
- * 文档地址： https://doc.quickapp.cn/framework/source-file.html#appux
+ * 应用级别的配置，供所有页面公用
  */
 
-// 引入全局函数定义文件global.js
-import './global'
+const $utils = require('./helper/utils').default
+const $apis = require('./helper/apis').default
 
-export default {}
+/* @desc: 注入方法至全局 global,以便页面调用 */
+const hook2global = global.__proto__ || global
+hook2global.$utils = $utils
+hook2global.$apis = $apis
 
+export default {
+  onCreate() {}
+}
 </script>

package/templates/app/demo/src/assets/styles/mixins.scss

@@ -0,0 +1,5 @@
+@mixin flex-box-mixins($direction: row, $justify: center, $align-items: center) {
+  flex-direction: $direction;
+  justify-content: $justify;
+  align-items: $align-items;
+}

package/templates/app/demo/src/assets/styles/style.scss

@@ -0,0 +1,2 @@
+@import './variables.scss';
+@import './mixins.scss';

package/templates/app/demo/src/assets/styles/variables.scss

@@ -0,0 +1,9 @@
+$brand: #09ba07;
+
+$white: #ffffff;
+$black: #000000;
+$grey: #9393aa;
+$red: #fa0101;
+$green: #ffff00;
+
+$size-factor: 5px;

package/templates/app/demo/src/global.js

@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
 /**
  * @file 全局能力的配置与获取
  * 文档地址：https://doc.quickapp.cn/tutorial/framework/optimization-skills.html#%E4%BD%BF%E7%94%A8-globaljs

package/templates/app/demo/src/helper/ajax.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import $fetch from '@system.fetch'
+import $utils from './utils'
+
+Promise.prototype.finally = function (callback) {
+  const P = this.constructor
+  return this.then(
+    (value) => P.resolve(callback()).then(() => value),
+    (reason) =>
+      P.resolve(callback()).then(() => {
+        throw reason
+      })
+  )
+}
+
+function requestHandle(params) {
+  return new Promise((resolve, reject) => {
+    $fetch
+      .fetch({
+        url: params.url,
+        method: params.method,
+        data: params.data,
+      })
+      .then((response) => {
+        const result = response.data
+        const content = JSON.parse(result.data)
+        /* @desc: 可跟具体不同业务接口数据，返回你所需要的部分，使得使用尽可能便捷 */
+        content.success ? resolve(content.value) : resolve(content.message)
+      })
+      .catch((error, code) => {
+        console.log(`🐛 request fail, code = ${code}`)
+        reject(error)
+      })
+      .finally(() => {
+        console.log(`✔️ request @${params.url} has been completed.`)
+        resolve()
+      })
+  })
+}
+
+export default {
+  post: function (url, params) {
+    return requestHandle({
+      method: 'post',
+      url: url,
+      data: params,
+    })
+  },
+  get: function (url, params) {
+    return requestHandle({
+      method: 'get',
+      url: $utils.queryString(url, params),
+    })
+  },
+  put: function (url, params) {
+    return requestHandle({
+      method: 'put',
+      url: url,
+      data: params,
+    })
+  },
+  // 如果，method 您需要更多类型，可自行添加更多方法；
+}

package/templates/app/demo/src/helper/apis/example.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import $ajax from '../ajax'
+
+/**
+ * @desc 在实际开发中，您可以将 baseUrl 替换为您的请求地址前缀；
+ *
+ * 已将 $apis 挂载在 global，您可以通过如下方式，进行调用：
+ * $apis.example.getSomeApi().then().catch().finally()
+ *
+ * 备注：如果您不需要发起请求，删除 apis 目录，以及 app.ux 中引用即可；
+ */
+const baseUrl = 'https://api.exampel.com/'
+
+export default {
+  getSomeApi(data) {
+    return $ajax.get(`${baseUrl}your-project-api`, data)
+  },
+  postOtherApi(data) {
+    return $ajax.post(`${baseUrl}your-project-api`, data)
+  },
+}

package/templates/app/demo/src/helper/apis/index.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const files = require.context('.', true, /\.js/)
+const modules = {}
+
+files.keys().forEach((key) => {
+  if (key === './index.js') {
+    return
+  }
+  modules[key.replace(/(^\.\/|\.js$)/g, '')] = files(key).default
+})
+
+export default modules

package/templates/app/demo/src/helper/utils.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2021-present, the hapjs-platform Project Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * 您可以将常用的方法、或系统 API，统一封装，暴露全局，以便各页面、组件调用，而无需 require / import.
+ */
+const prompt = require('@system.prompt')
+
+function queryString(url, query) {
+  let str = []
+  for (let key in query) {
+    str.push(key + '=' + query[key])
+  }
+  let paramStr = str.join('&')
+  return paramStr ? `${url}?${paramStr}` : url
+}
+
+function showToast(message = '', duration = 0) {
+  if (!message) return
+  prompt.showToast({
+    message: message,
+    duration,
+  })
+}
+
+export default {
+  showToast,
+  queryString,
+}

package/templates/app/demo/src/manifest.json

@@ -1,56 +1,66 @@
 {
-  "package": "com.application.demo",
-  "name": "{{appName}}",
-  "versionName": "1.0.0",
-  "versionCode": 1,
-  "minPlatformVersion": 1070,
-  "icon": "/Common/logo.png",
-  "deviceTypeList": ["phone"],
-  "features": [
-    { "name": "system.prompt" },
-    { "name": "system.router" },
-    { "name": "system.shortcut" }
-  ],
-  "permissions": [
-    { "origin": "*" }
-  ],
-  "config": {
-    "logLevel": "log"
-  },
-  "router": {
-    "entry": "Demo",
-    "pages": {
-      "Demo": {
-        "component": "index"
-      },
-      "DemoDetail": {
-        "component": "index"
-      }
-    },
-    "widgets": {
-      "CardDemo": {
-        "name": "CardDemo",
-        "description": "快应用卡片展示",
-        "component": "index",
-        "path": "/CardDemo",
-        "features": []
-      }
-    }
-  },
-  "display": {
-    "titleBarBackgroundColor": "#f2f2f2",
-    "titleBarTextColor": "#414141",
-    "menu": false,
-    "menuBarData": {
-      "menuBar": true
-    },
-    "pages": {
-      "Demo": {
-        "titleBarText": "示例页"
-      },
-      "DemoDetail": {
-        "titleBarText": "详情页"
-      }
-    }
-  }
+	"package": "com.example.demo",
+	"name": "快应用示例模版",
+	"versionName": "1.0.0",
+	"versionCode": 1,
+	"minPlatformVersion": 1070,
+	"icon": "/assets/images/logo.png",
+	"features": [{
+			"name": "system.prompt"
+		},
+		{
+			"name": "system.router"
+		},
+		{
+			"name": "system.shortcut"
+		},
+		{
+			"name": "system.fetch"
+		}
+	],
+	"permissions": [{
+		"origin": "*"
+	}],
+	"template/official": "demo-template",
+	"config": {
+		"logLevel": "debug"
+	},
+	"router": {
+		"entry": "pages/Demo",
+		"pages": {
+			"pages/Demo": {
+				"component": "index"
+			},
+			"pages/DemoDetail": {
+				"component": "index"
+			}
+		},
+		"widgets": {
+			"CardDemo": {
+				"name": "CardDemo",
+				"description": "快应用卡片展示",
+				"component": "index",
+				"path": "/CardDemo",
+				"minPlatformVersion": 1032,
+				"targetManufactorys": [
+					"vivo"
+				],
+				"features": []
+			}
+		}
+	},
+	"display": {
+		"titleBarBackgroundColor": "#f2f2f2",
+		"titleBarTextColor": "#414141",
+		"menu": true,
+		"pages": {
+			"pages/Demo": {
+				"titleBarText": "快应用示例模版",
+				"menu": false
+			},
+			"pages/DemoDetail": {
+				"titleBarText": "详情页"
+			}
+		}
+	}
 }