babel-plugin-react-query-string-key-gen - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

package.json

 {
   "name": "babel-plugin-react-query-string-key-gen",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "main": "dist/index.js",
@@ -8,3 +8,4 @@ "author": "Dominic Lee",
     "test": "jest",
-    "build": "esbuild src/index.ts --bundle --platform=node --target=node10 --outfile=dist/index.js"
+    "build": "esbuild src/index.ts --bundle --platform=node --target=node10 --outfile=dist/index.js",
+    "build:watch": "esbuild src/index.ts --bundle --platform=node --target=node10 --watch --outfile=dist/index.js"
   },
@@ -11,0 +12,0 @@ "license": "MIT",

README.md

@@ -1,1 +0,40 @@
-# babel-plugin-react-query-string-key-gen
+# babel-plugin-react-query-string-key-gen
+
+### Problem
+
+Naming things well is difficult in programming. A poorly named thing could cause further confusion for the next person reading your code.
+However, there is a fairly strong convention to include a string key as an identifier in the react-query query key.
+
+### Solution
+
+We could generate this key at build-time, inferring from the name of it's associated query function. Why name things twice when you can just
+reuse what's already there? This babel plugin will statically analyze your code and extract the query function from your `useQuery` hooks.
+
+### Installation
+
+yarn:
+`yarn add babel-plugin-react-query-string-key-gen --dev`
+
+npm:
+`npm install babel-plugin-react-query-string-key-gen --dev`
+
+Then, add plugin to your `.babelrc`
+
+```json
+{
+  "plugins": ["babel-plugin-react-query-string-key-gen"]
+}
+```
+
+### Usage
+
+You now have the option to exclude the string identifier from your query key if you want.
+However, if you do choose to include a string key manually, then nothing will change.
+This is to provide flexibility and ease of migration if you do decide to use this plugin.
+
+This plugin makes a few assumptions about your query key order:
+
+1. It expects your unique string key to always be the first element in your array key.
+2. If you are using inline, anonymous query functions, it will try to infer the query function name from your function scope.
+3. If the name cannot be inferred and your unique string key is missing, a uuid will be generated for that query.
+4. If all you need is a simple string key, you can pass an empty string or empty array to the queryKey param and a key will be generated for you.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Number of lines in readme file

41

increased by4000%

Worsened metrics

Total package byte prevSize

8308

decreased by-98.44%

Lines of code

119

decreased by-99.24%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes