react-storage-hooks - npm Package Compare versions

Comparing version 4.0.0 to 4.0.1

package.json

 {
   "name": "react-storage-hooks",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "React hooks for persistent state",
@@ -21,15 +21,17 @@ "keywords": [
     "types": "tsd",
-    "test": "jest --verbose",
+    "test": "jest",
     "test:watch": "npm test -- --watch",
     "test:coverage": "npm test -- --coverage",
+    "test:staged": "npm test -- --findRelatedTests --bail",
+    "prebuild": "del dist",
+    "build": "tsc",
+    "build:watch": "npm run build -- --watch",
     "size": "size-limit",
     "precheck": "npm run build",
-    "check": "npm run lint && npm run fmt && npm run types && npm run test:coverage && npm run size",
-    "prebuild": "del dist",
-    "build": "tsc",
-    "prepublishOnly": "npm run check",
-    "release": "git push --follow-tags origin master",
-    "examples:setup": "cd examples && npm install",
-    "preexamples": "npm run build && npm link",
-    "examples": "cd examples && npm link react-storage-hooks && npm start"
+    "check": "run-s lint fmt types test:coverage size",
+    "examples:setup": "cd examples && npm install && npm link ../.",
+    "examples:start": "cd examples && npm start",
+    "examples:watch": "run-p build:watch examples:start",
+    "prerelease": "npm run check",
+    "release": "git push --follow-tags origin master"
   },
@@ -48,8 +50,7 @@ "files": [
     "hooks": {
-      "pre-commit": "lint-staged && npm run test:coverage"
+      "pre-commit": "lint-staged"
     }
   },
   "prettier": {
-    "singleQuote": true,
-    "trailingComma": "es5"
+    "singleQuote": true
   },
@@ -84,3 +85,4 @@ "eslintConfig": {
       "prettier --write",
-      "eslint --fix"
+      "eslint --fix",
+      "npm run test:staged"
     ]
@@ -120,21 +122,22 @@ },
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^4.0.2",
+    "@size-limit/preset-small-lib": "^4.4.5",
     "@testing-library/react-hooks": "^3.2.1",
-    "@types/jest": "^25.1.3",
-    "@types/react": "^16.9.23",
-    "@typescript-eslint/eslint-plugin": "^2.21.0",
-    "@typescript-eslint/parser": "^2.21.0",
+    "@types/jest": "^25.2.1",
+    "@types/react": "^16.9.34",
+    "@typescript-eslint/eslint-plugin": "^2.28.0",
+    "@typescript-eslint/parser": "^2.28.0",
     "del-cli": "^3.0.0",
     "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.10.0",
-    "eslint-plugin-react-app": "^6.2.1",
-    "eslint-plugin-react-hooks": "^2.5.0",
-    "husky": "^4.2.3",
-    "jest": "^25.1.0",
-    "lint-staged": "^10.0.8",
-    "prettier": "^1.19.1",
-    "react": "^16.13.0",
-    "react-test-renderer": "^16.13.0",
-    "size-limit": "^4.0.2",
-    "ts-jest": "^25.2.1",
+    "eslint-config-prettier": "^6.10.1",
+    "eslint-plugin-react-app": "^6.2.2",
+    "eslint-plugin-react-hooks": "^3.0.0",
+    "husky": "^4.2.5",
+    "jest": "^25.3.0",
+    "lint-staged": "^10.1.5",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.0.4",
+    "react": "^16.13.1",
+    "react-test-renderer": "^16.13.1",
+    "size-limit": "^4.4.5",
+    "ts-jest": "^25.4.0",
     "tsd": "^0.11.0",
@@ -141,0 +144,0 @@ "typescript": "^3.8.3"

README.md

@@ -17,5 +17,5 @@ # react-storage-hooks
 
-:zap: **Tiny and fast**. Less than 700 B gzipped. No external dependencies. Only reads from storage when necessary and always writes to storage after rendering.
+:zap: **Tiny and fast**. Less than 700 bytes gzipped, enforced with [`size-limit`](https://github.com/ai/size-limit). No external dependencies. Only reads from storage when necessary and writes to storage after rendering.
 
-:capital_abcd: **Completely typed**. Written in TypeScript. Type definitions included.
+:capital_abcd: **Completely typed**. Written in TypeScript. Type definitions included and verified with [`tsd`](https://github.com/SamVerschueren/tsd).
 
@@ -32,11 +32,7 @@ :muscle: **Backed by tests**. Full coverage of the API.
 
-```
-npm install --save react-storage-hooks
-```
+    npm install --save react-storage-hooks
 
 Or with yarn:
 
-```
-yarn add react-storage-hooks
-```
+    yarn add react-storage-hooks
 
@@ -200,4 +196,48 @@ ## Usage
 
+## Development
+
+Install development dependencies:
+
+    npm install
+
+To set up the examples:
+
+    npm run examples:setup
+
+To start a server with the examples in watch mode (reloads whenever examples or library code change):
+
+    npm run examples:watch
+
+### Tests
+
+Run tests:
+
+    npm test
+
+Run tests in watch mode:
+
+    npm run test:watch
+
+See code coverage information:
+
+    npm run test:coverage
+
+### Publish
+
+Go to the `master` branch:
+
+    git checkout master
+
+Bump the version number:
+
+    npm version [major | minor | patch]
+
+Run the release script:
+
+    npm run release
+
+All code quality checks will run, the tagged commit generated by `npm version` will be pushed and [Travis CI](https://travis-ci.com/github/soyguijarro/react-storage-hooks) will publish the new package version to the npm registry.
+
 ## License
 
 This library is [MIT licensed](LICENSE).

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

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

Improved metrics

Total package byte prevSize

23755

increased by4.29%

Number of lines in readme file

241

increased by19.9%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

22

increased by4.76%

No dependency changes