chore: publish v1.1.6

README.md

@@ -25,18 +25,18 @@ router.push('/login');
 
 ## ✨ API
 ### vue2-helpers
-|Declaration|Description|
+|Features|Description|
 |-|-|
-|`createVuexHelpers`&lt;<br>&nbsp;&nbsp;&nbsp;&nbsp;RootState, RootGetters, RootMutations, RootActions<br>&gt;(): {<br>&nbsp;&nbsp;&nbsp;&nbsp;`useState`, `useGetters`, `useMutations`, `useActions`<br>}|The helper methods in return value are used to replace `mapState`, `mapGetters`, `mapMutations`, `mapActions`|
+|`createVuexHelpers`&lt;<br>&nbsp;&nbsp;&nbsp;&nbsp;RootState, RootGetters, RootMutations, RootActions<br>&gt;(): {<br>&nbsp;&nbsp;&nbsp;&nbsp;`useState`, `useGetters`, `useMutations`, `useActions`<br>}|The helper methods in return value are<br>used to replace `mapState`, `mapGetters`,<br>`mapMutations`, `mapActions`|
 
 ### vue2-helpers/vuex
-|Declaration|Description|
+|Features|Description|
 |-|-|
 |`createStore`&lt;S&gt;(options: StoreOptions&lt;S&gt;): Store&lt;S&gt;||
 |`useStore`&lt;S = any&gt;(): Store&lt;S&gt;|
 
 ### vue2-helpers/vue-router
-|Declaration|Description|
+|Features|Description|
 |-|-|
 |`createRouter`(options: RouterOptions): Router||
 |`onBeforeRouteLeave`(leaveGuard: NavigationGuard): void||

package.json

@@ -1,8 +1,11 @@
 {
   "name": "vue2-helpers",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "A util package to use Vue 2 with Composition API easily",
-  "author": "Ambit Tsai <[email protected]>",
+  "author": {
+    "name": "Ambit Tsai",
+    "email": "[email protected]"
+  },
   "license": "Apache-2.0",
   "main": "index.js",
   "scripts": {
@@ -21,6 +24,11 @@
     "vue-router": "^3",
     "vuex": "^3"
   },
+  "peerDependenciesMeta": {
+    "vuex": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@rollup/plugin-typescript": "^8.2.3",
     "@vue/composition-api": "^1.0.4",

scripts/banner.js

@@ -1,17 +1,10 @@
-const fs = require('fs')
-const path = require('path')
-
-
-const filePath = path.resolve(__dirname, '../package.json')
-const fileText = fs.readFileSync(filePath, 'utf8')
-const config = JSON.parse(fileText)
-
+const pkg = require('../package.json');
 
 module.exports = `
 /**
- * ${config.name}@${config.version}
- * ${config.description}
- * @author ${config.author}
- * @license ${config.license}
- * @see {@link ${config.homepage}}
- */`
+ * ${pkg.name}@${pkg.version}
+ * ${pkg.description}
+ * @author ${pkg.author.name} <${pkg.author.email}>
+ * @license ${pkg.license}
+ * @see {@link ${pkg.homepage}}
+ */`