vuex-composition-helpers - npm Package Compare versions

Comparing version 1.0.17 to 1.0.18

package.json

 {
  "name": "vuex-composition-helpers",
- "version": "1.0.17",
+ "version": "1.0.18",
  "description": "Helpers to use Vuex store form Vue Composition API",
@@ -5,0 +5,0 @@ "author": "David Meir-Levy <[e-mail]>",

README.md

@@ -14,2 +14,10 @@ # vuex-composition-helpers
 
+This library is not transpiled by default. Your project should transpile it, which makes the final build smaller and more tree-shakeable. Take a look at [transpiling](#transpiling).
+
+Non-typescript projects may import the library from the `dist` subdirectory, where plain javascript distribution files are located.
+
+```
+import { useState, ... } from 'vuex-composition-helpers/dist';
+```
+
 ### Basic Usage Examples
@@ -123,3 +131,3 @@
 
-consider separate the store composition file from the store usage inside the component. i.g.:
+Consider separate the store composition file from the store usage inside the component. i.g.:
 
@@ -157,2 +165,74 @@ ```js
 
+### Transpiling
+
+It depends on you project's stack, but let's say it consists of webpack, babel and ts-loader.
+
+The rule processing `.ts` files should whitelist vuex-composition-helpers. If your project uses a raw webpack installation, it should resemble this.
+
+```
+// webpack.config.js
+module.exports = {
+  ...
+  module: {
+    rules: [
+      test: /\.ts$/,
+      // If node_modules is excluded from the rule, vuex-composition-helpers should be an exception
+      exclude: /node_modules(?!\/vuex-composition-helpers)/,
+      use: [
+        {
+          loader: 'babel-loader',
+          ...
+        },
+        {
+          loader: 'thread-loader',
+          options: { ... }
+        },
+        {
+          loader: 'ts-loader',
+          ...
+        }
+    ]
+  }
+}
+```
+
+When using `vue-cli`, use this instead
+
+```
+// vue.config.js
+module.exports = {
+  ...
+  chainWebpack: config => {
+    config
+      .rule('ts')
+      .include
+      .add(/vuex-composition-helpers/)
+  }
+}
+```
+
+If your webpack configuration is excluding `node_modules` from the bundle, which is common for SSR, this library should be an exception.
+
+```
+// webpack.config.js
+module.exports = {
+ ...
+  externals: [nodeExternals({
+    whitelist: [/^vuex-composition-helpers/]
+  })],
+}
+```
+
+Babel should not `exclude` or `ignore` this library. If you use `vue-cli`, you may need the following configuration.
+
+```
+// vue.config.js
+module.exports = {
+  ...
+  transpileDependencies: ['vuex-composition-helpers'],
+}
+```
+
+Although it's not strictly required, maybe ts-loader needs to have `allowTsInNodeModules` enabled in your project. Finally check that this library is not excluded in `tsconfig.json`, and if it was necessary, put it in the `include` list.
+
 Enjoy!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

35131

increased by6.37%

Number of lines in readme file

236

increased by51.28%

No dependency changes