general-basic-form 1.1.4 → 1.2.0

package/README.md

@@ -60,7 +60,7 @@ import 'general-basic-form/style'
         :formData.sync: {
           // 外部传入的表单数据，用于回填
         }
-        noUrlParameters
+        parametersType="data"
         :afterReset="afterReset"
         v-model:loading="loading"
       />
@@ -135,22 +135,29 @@ this.$refs['GeneralBasicFormRef'].resetQuery()
             const params = VGeneralBasicFormRef.value['queryParams']
             resolve(params)
           } else {
-            resolve(false)
+            reject()
           }
         }
       )
     })
 
-
 ![image-20211014191532067](https://raw.githubusercontent.com/Alan1034/PicturesServer/main/PicGo_imgs/202110141915657.png)
 
+parametersType类型介绍
+
+| parametersType形式 | 支持页面刷新 | 参数改变引起路由跳转 | 组件间共享数据 | 存储上限 | 浏览器兼容性 |
+| ------------------ | ------------ | -------------------- | -------------- | -------- | ------------ |
+| url                | 是           | 是                   | 是             | 中       | 高           |
+| data               | 否           | 否                   | 否             | 高       | 高           |
+| indexDB            | 是           | 否                   | 是             | 高       | 中           |
+
 数据示例:
 
     showSearch: true, // 显示搜索条件
     getList(); // 请求数据的函数
     afterReset(); // 在重置按钮点击完后但还没重新请求时触发的的函数
     formOnly:true // 只展示表单不展示按钮
-    noUrlParameters:true // 不接受和不改变url的参数
+    parametersType:"url" // 见parametersType类型介绍
     loading:false // 加载动画
     formData:{} // 注意，因为可能出现的性能问题在组件watch formData的变化时没有使用deep，所以有时候深度的修改会不生效，导致表单数据不完整
     noInputBlank: true //校验input框不能仅输入空格
@@ -159,6 +166,7 @@ this.$refs['GeneralBasicFormRef'].resetQuery()
     pageSizeKey:"limit", //每页显示个数选择器的选项设置
     defCurrentPage:1, //默认的页数
     defPageSize：10, //默认的每页显示个数
+    queryWhenReady:false,//初始化完成后自动触发查找数据函数，建议用这个this.$refs["VGeneralBasicFormRef"].handleQuery({ defaultPageFirst: false })
     formItem: [
     	{
           label: '',
@@ -621,7 +629,7 @@ import {  VTabs } from "general-basic-form";
 
 ```
 tabPanes:[],// 定义标签页的数据
-noUrlParameters:false,// 不接受和不改变url的参数
+parametersType:"url" // 见parametersType类型介绍
 activeNameKey:"activeName",//保存标签页的字段KEY
 defActiveName:null,//标签页的选中值
 getList:()=>{},// 查找数据调用的函数

package/package.json

@@ -1,70 +1,60 @@
-{
-  "name": "general-basic-form",
-  "version": "1.1.4",
-  "description": "",
-  "main": "./dist/index.umd.cjs",
-  "type": "module",
-  "scripts": {
-    "build": "cross-env CURRENT_ENV=prod run-p type-check && run-p build-only",
-    "test:e2e": "playwright test",
-    "build-only": "vite build",
-    "type-check": "tsc --noEmit -p tsconfig.json --composite false",
-    "link": "tsx script/link.ts && yarn link",
-    "unlink": "tsx script/unlinkModule.ts && yarn unlink && run-p build",
-    "linkNode": "tsx script/linkNode.ts && yarn link && run-p dev",
-    "unlinkNode": "tsx script/unlinkNode.ts && yarn unlink && run-p buildts",
-    "dev": "tsc -w -p .",
-    "buildts": "rimraf dist && tsc -p ."
-  },
-  "keywords": [
-    "general-basic-form",
-    "form",
-    "vue",
-    "vue2",
-    "vue3",
-    "element-plus",
-    "element",
-    "typescript"
-  ],
-  "author": "chendeli419287484@qq.com",
-  "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Alan1034/GeneralBasicForm.git"
-  },
-  "devDependencies": {
-    "@playwright/test": "^1.36.1",
-    "@types/node": "^20.8.10",
-    "@vitejs/plugin-legacy": "^4.1.1",
-    "@vitejs/plugin-vue2": "^2.3.1",
-    "@vitejs/plugin-vue2-jsx": "^1.1.1",
-    "chalk": "^2.4.2",
-    "cross-env": "^7.0.3",
-    "less": "^4.2.0",
-    "npm-run-all": "^4.1.5",
-    "rimraf": "^5.0.5",
-    "sass": "^1.77.8",
-    "tsx": "^4.0.0",
-    "typescript": "^5.2.2",
-    "vite-plugin-image-optimizer": "^1.1.6"
-  },
-  "peerDependencies": {
-    "vue": "^2.7.0-0"
-  },
-  "typings": "./dist/index.d.ts",
-  "dependencies": {
-    "network-spanner": "^1.2.8"
-  },
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.umd.cjs",
-      "types": "./dist/index.d.ts"
-    },
-    "./style": "./dist/style.css"
-  },
-  "files": [
-    "/dist"
-  ]
-}
+{
+  "name": "general-basic-form",
+  "version": "1.2.0",
+  "description": "",
+  "main": "./src/index.ts",
+  "type": "module",
+  "scripts": {
+    "build": "cross-env CURRENT_ENV=prod run-p type-check && run-p build-only",
+    "test:e2e": "playwright test",
+    "build-only": "vite build",
+    "type-check": "tsc --noEmit -p tsconfig.json --composite false",
+    "link": "tsx script/link.ts && yarn link",
+    "unlink": "tsx script/unlinkModule.ts && yarn unlink && run-p build",
+    "linkNode": "tsx script/linkNode.ts && yarn link && run-p dev",
+    "unlinkNode": "tsx script/unlinkNode.ts && yarn unlink && run-p buildts",
+    "dev": "tsc -w -p .",
+    "buildts": "rimraf dist && tsc -p ."
+  },
+  "keywords": [
+    "general-basic-form",
+    "form",
+    "vue",
+    "vue2",
+    "vue3",
+    "vue-router",
+    "element-plus",
+    "element",
+    "typescript"
+  ],
+  "author": "chendeli419287484@qq.com",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Alan1034/GeneralBasicForm.git"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.36.1",
+    "@types/node": "^20.8.10",
+    "@vitejs/plugin-legacy": "^4.1.1",
+    "@vitejs/plugin-vue2": "^2.3.1",
+    "@vitejs/plugin-vue2-jsx": "^1.1.1",
+    "chalk": "^2.4.2",
+    "cross-env": "^7.0.3",
+    "less": "^4.2.0",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^5.0.5",
+    "sass": "^1.77.8",
+    "tsx": "^4.0.0",
+    "typescript": "^5.2.2",
+    "vite-plugin-image-optimizer": "^1.1.6"
+  },
+  "peerDependencies": {
+    "vue": "^2.7.0-0"
+  },
+  "typings": "./publish/index.d.ts",
+  "dependencies": {
+    "general-basic-indexdb": "^1.0.1",
+    "network-spanner": "^1.2.8"
+  }
+}

package/public/index.d.ts

@@ -0,0 +1,17 @@
+/*
+ * @Author: 陈德立*******419287484@qq.com
+ * @Date: 2023-11-07 17:55:59
+ * @LastEditTime: 2023-11-08 10:24:14
+ * @LastEditors: 陈德立*******419287484@qq.com
+ * @Github: https://github.com/Alan1034
+ * @Description: 
+ * @FilePath: \GeneralBasicForm\public\index.d.ts
+ * 
+ */
+/// <reference types="vite/client" />
+declare module "*.vue" {
+  import { DefineComponent } from "vue"
+  const component: DefineComponent<{}, {}, any>
+  export default component
+}
+declare module "general-basic-form";

package/script/initialization.ts

@@ -0,0 +1,24 @@
+import path from "path";
+import fs from 'fs'
+import chalk from 'chalk'
+import { fileURLToPath } from 'url'
+const __filenameNew = fileURLToPath(import.meta.url)
+const __dirnameNew = path.dirname(__filenameNew)
+export const updateMain = (mainDir:string) => {
+  try {
+    const packageTxt = fs.readFileSync(path.join(__dirnameNew, '../package.json'), 'utf8');
+    const packageJson = JSON.parse(packageTxt);
+
+    delete packageJson.files
+    delete packageJson.module
+    delete packageJson.exports
+    packageJson.typings = "./publish/index.d.ts"
+    packageJson.main = mainDir
+    const versionData = JSON.stringify(packageJson, null, 2);
+    fs.writeFileSync(path.join(__dirnameNew, '../package.json'), versionData, 'utf8');
+    console.log(chalk.green.bold('修改入口配置成功！当前入口路径为为：' + mainDir));
+  } catch (error) {
+    console.log(chalk.red.bold('修改入口配置出错:', error.toString()));
+  }
+
+}

package/script/link.ts

@@ -0,0 +1,14 @@
+/*
+ * @Author: 陈德立*******419287484@qq.com
+ * @Date: 2023-11-10 09:39:59
+ * @LastEditTime: 2023-11-15 18:38:43
+ * @LastEditors: 陈德立*******419287484@qq.com
+ * @Github: https://github.com/Alan1034
+ * @Description: link处理流程
+ * @FilePath: \VueNpmFrame\script\link.ts
+ * 
+ */
+import { updateMain } from "./initialization";
+
+
+updateMain("./src/index.ts")

package/script/linkNode.ts

@@ -0,0 +1,14 @@
+/*
+ * @Author: 陈德立*******419287484@qq.com
+ * @Date: 2023-11-10 09:39:59
+ * @LastEditTime: 2024-03-01 11:27:02
+ * @LastEditors: 陈德立*******419287484@qq.com
+ * @Github: https://github.com/Alan1034
+ * @Description: link处理流程
+ * @FilePath: \VueNpmFrame\script\linkNode.ts
+ * 
+ */
+import { updateMain } from "./initialization";
+
+
+updateMain("./dist/src/index.js")

package/script/unlinkModule.ts

@@ -0,0 +1,48 @@
+/*
+ * @Author: 陈德立*******419287484@qq.com
+ * @Date: 2023-11-10 09:39:59
+ * @LastEditTime: 2023-11-25 23:52:27
+ * @LastEditors: 陈德立*******419287484@qq.com
+ * @Github: https://github.com/Alan1034
+ * @Description: unlink处理流程
+ * @FilePath: \vite-plugin-update-version\script\unlinkModule.ts
+ * 
+ */
+import path from "path";
+import fs from 'fs'
+import chalk from 'chalk'
+import { fileURLToPath } from 'url'
+const __filenameNew = fileURLToPath(import.meta.url)
+const __dirnameNew = path.dirname(__filenameNew)
+const updateMain = () => {
+  try {
+    const packageTxt = fs.readFileSync(path.join(__dirnameNew, '../package.json'), 'utf8');
+    const packageJson = JSON.parse(packageTxt);
+    const umdDir = "./dist/index.umd.cjs"
+    const esDir = "./dist/index.js"
+    const types = "./dist/index.d.ts"
+    packageJson.type = "module"
+    packageJson.main = umdDir
+    packageJson.module = esDir
+    packageJson.exports = {
+      ".": {
+        "import": esDir,
+        "require": umdDir,
+        "types": types
+      },
+      "./style": "./dist/style.css"
+    }
+    packageJson.typings = types
+    packageJson.files = [
+      "/dist"
+    ]
+    const versionData = JSON.stringify(packageJson, null, 2);
+    fs.writeFileSync(path.join(__dirnameNew, '../package.json'), versionData, 'utf8');
+    console.log(chalk.green.bold('修改入口配置成功！当前入口路径为为：' + umdDir));
+  } catch (error) {
+    console.log(chalk.red.bold('修改入口配置出错:', error.toString()));
+  }
+
+}
+
+updateMain()

package/script/unlinkNode.ts

@@ -0,0 +1,38 @@
+/*
+ * @Author: 陈德立*******419287484@qq.com
+ * @Date: 2023-11-10 09:39:59
+ * @LastEditTime: 2024-03-01 11:33:05
+ * @LastEditors: 陈德立*******419287484@qq.com
+ * @Github: https://github.com/Alan1034
+ * @Description: unlink处理流程
+ * @FilePath: \VueNpmFrame\script\unlinkNode.ts
+ * 
+ */
+import path from "path";
+import fs from 'fs'
+import chalk from 'chalk'
+import { fileURLToPath } from 'url'
+const __filenameNew = fileURLToPath(import.meta.url)
+const __dirnameNew = path.dirname(__filenameNew)
+const updateMain = () => {
+  try {
+    const packageTxt = fs.readFileSync(path.join(__dirnameNew, '../package.json'), 'utf8');
+    const packageJson = JSON.parse(packageTxt);
+    const cjsDir = "./dist/src/index.js"
+    const types = "./dist/src/index.d.ts"
+    delete packageJson.type
+    packageJson.main = cjsDir
+    packageJson.typings = types
+    packageJson.files = [
+      "/dist"
+    ]
+    const versionData = JSON.stringify(packageJson, null, 2);
+    fs.writeFileSync(path.join(__dirnameNew, '../package.json'), versionData, 'utf8');
+    console.log(chalk.green.bold('修改入口配置成功！当前入口路径为为：' + cjsDir));
+  } catch (error) {
+    console.log(chalk.red.bold('修改入口配置出错:', error.toString()));
+  }
+
+}
+
+updateMain()

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "include": [
+    "public/index.d.tsex.d.ts",
+    "src/**/*",
+    "src/**/*.vue",
+    "public/*",
+  ],
+  "exclude": [],
+  "compilerOptions": {
+    "declaration": true,
+    "allowJs": true,
+    "composite": true
+  }
+}

package/vite.config.js

@@ -0,0 +1,121 @@
+import legacy from '@vitejs/plugin-legacy'
+import { fileURLToPath } from 'url'
+import { defineConfig, loadEnv, splitVendorChunkPlugin } from 'vite'
+import vue from '@vitejs/plugin-vue2'
+import vueJsx from '@vitejs/plugin-vue2-jsx'
+import { ViteImageOptimizer } from 'vite-plugin-image-optimizer';
+import path from 'path';
+const __filenameNew = fileURLToPath(import.meta.url)
+const __dirnameNew = path.dirname(__filenameNew)
+const resolve = (dir) => path.resolve(__dirnameNew, dir);
+// https://vitejs.dev/config/
+export default defineConfig(({ command, mode }) => {
+  // 根据当前工作目录中的 `mode` 加载 .env 文件
+  // 设置第三个参数为 '' 来加载所有环境变量，而不管是否有 `VITE_` 前缀。
+  const env = loadEnv(mode, process.cwd(), '')
+  // console.log(command)
+  // console.log(env)
+  // console.log(env.CURRENT_ENV)
+  // console.log(env.APP_ENV)
+  // console.log(env.VUE_APP_BASE_API)
+  return {
+    // vite环境变量配置
+    define: {
+      "CURRENT_ENV": JSON.stringify(env.CURRENT_ENV),
+    },
+    server: {
+      open: true,
+    },
+    resolve: {
+      alias: {
+        '@': resolve('src'),//路径化名
+      },
+
+      extensions: ['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json', '.vue'],
+    },
+
+    plugins: [
+      /**
+       * @description: vite自带的文件分割配置
+       * @return {*}
+       */
+      {
+        ...splitVendorChunkPlugin(),
+        apply: 'build',
+      },
+      /**
+       * @description: 图片压缩插件
+       * @return {*}
+       */
+      {
+        ...ViteImageOptimizer({
+          /* pass your config */
+        }),
+        // enforce: 'pre',
+        apply: 'build',
+      },
+      /**
+       * @description: 兼容旧版本浏览器
+       * @return {*}
+       */
+      {
+        ...legacy({
+          targets: ['defaults'],
+        }),
+        apply: 'build',
+      },
+      vue(),
+      vueJsx(),
+    ],
+    css: {
+      preprocessorOptions: {
+        less: {
+          // 支持内联 JavaScript
+          javascriptEnabled: true,
+        },
+      },
+    },
+    /**
+     * @description: 打包时才调用
+     * @return {*}
+     */
+    build: {
+      lib: {
+        // Could also be a dictionary or array of multiple entry points
+        // 添加打包入口文件夹
+        entry: resolve(`${__dirnameNew}/src`, 'index.ts'),
+        // formats: ['es', 'cjs', 'umd', 'iife'],
+        name: 'Index',
+        // the proper extensions will be added
+        // fileName: (format) => `index.${format}.js`,
+        fileName: "index",
+      },
+      rollupOptions: {
+        // 确保外部化处理那些你不想打包进库的依赖
+        external: ['vue'],
+        output: {
+          // 在 UMD 构建模式下为这些外部化的依赖提供一个全局变量
+          globals: {
+            vue: 'Vue',
+          },
+        },
+      },
+      // minify: 'terser',
+      //打包环境移除console.log，debugger
+      // terserOptions: {
+      //   compress: {
+      //     drop_console: true,
+      //     drop_debugger: true,
+      //   },
+      // },
+      //打包文件按照类型分文件夹显示（貌似会导致性能下降）
+      // rollupOptions: {
+      //   output: {
+      //     chunkFileNames: 'js/[name]-chunk-[hash:7].js',
+      //     entryFileNames: 'js/[name]-app-[hash:7].js',
+      //     assetFileNames: '[ext]/[name]-chunk-[hash:7].[ext]',
+      //   },
+      // },
+    },
+  }
+})