react-reactive-val 1.0.4 → 1.0.5

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024 Jatin Parate
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 

package/README.md

@@ -0,0 +1,139 @@
+# React Reactive Val
+
+A lightweight, type-safe reactive value management library for React applications. This library provides a simple way to manage reactive values in React components with minimal boilerplate.
+
+## Features
+
+- 🎯 **Type-safe**: Built with TypeScript for excellent type inference
+- 🪶 **Lightweight**: Tiny footprint with zero dependencies
+- ⚡ **Fast**: Built on React's `useSyncExternalStore` for optimal performance
+- 🔄 **Reactive**: Values update automatically across components
+- 📦 **Tree-shakeable**: Only import what you need
+- 🌳 **Multiple formats**: Supports ESM, CommonJS, and UMD
+
+## Installation
+
+```bash
+npm install react-reactive-val
+# or
+yarn add react-reactive-val
+# or
+pnpm add react-reactive-val
+```
+
+## Usage
+
+### Basic Example
+
+```tsx
+import useReactiveValue from 'react-reactive-val';
+
+function Counter() {
+  const count = useReactiveValue(0);
+
+  return (
+    <div>
+      <p>Count: {count()}</p>
+      <button onClick={() => count(prev => prev + 1)}>
+        Increment
+      </button>
+    </div>
+  );
+}
+```
+
+### Sharing State Between Components
+
+```tsx
+import { reallyReactiveVal } from 'react-reactive-val';
+
+// Create a shared reactive value
+const sharedCount = reallyReactiveVal(0);
+
+function CounterDisplay() {
+  return <div>Count: {sharedCount()}</div>;
+}
+
+function CounterButtons() {
+  return (
+    <div>
+      <button onClick={() => sharedCount(prev => prev + 1)}>
+        Increment
+      </button>
+      <button onClick={() => sharedCount(prev => prev - 1)}>
+        Decrement
+      </button>
+    </div>
+  );
+}
+```
+
+## API Reference
+
+### `useReactiveValue<T>(initialValue: T)`
+
+A React hook that creates a reactive value within a component.
+
+```tsx
+const value = useReactiveValue(initialValue);
+```
+
+- `initialValue`: The initial value of the reactive state
+- Returns: A function that can both read and update the value
+
+### `reallyReactiveVal<T>(initialValue: T)`
+
+Creates a standalone reactive value that can be used across components.
+
+```tsx
+const value = reallyReactiveVal(initialValue);
+```
+
+- `initialValue`: The initial value of the reactive state
+- Returns: A function that can both read and update the value
+
+### Usage with Value Getter/Setter
+
+```tsx
+// Get the current value
+const currentValue = value();
+
+// Set a new value
+value(newValue);
+
+// Update based on previous value
+value(prev => computeNewValue(prev));
+```
+
+## TypeScript Support
+
+The library is written in TypeScript and provides full type inference:
+
+```tsx
+// Type is inferred from initial value
+const count = useReactiveValue(0); // type: number
+
+// Explicit type annotation
+const user = useReactiveValue<User | null>(null);
+
+// Type checking for updates
+user(prev => ({ ...prev, name: "John" })); // Type safe!
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+1. Fork the repository
+2. Create your feature branch (\`git checkout -b feature/amazing-feature\`)
+3. Commit your changes (\`git commit -m 'Add some amazing feature'\`)
+4. Push to the branch (\`git push origin feature/amazing-feature\`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.
+
+## Author
+
+Jatin Parate ([@jatin4228](https://github.com/jatin4228)) 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-reactive-val",
-  "version": "1.0.4",
-  "description": "",
+  "version": "1.0.5",
+  "description": "A lightweight, type-safe reactive value management library for React applications",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -21,25 +21,58 @@
     "build:webpack": "webpack --config webpack.config.js",
     "build": "rm -rf dist && npm run build:types && npm run build:webpack",
     "prepublishOnly": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint . --ext .ts,.tsx",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+    "prepare": "husky install"
   },
-  "peerDependencies": {
-    "react": "^19.0.0"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jatin-parate/react-reactive-val.git"
   },
-  "keywords": [],
+  "keywords": [
+    "react",
+    "reactive",
+    "state",
+    "management",
+    "typescript",
+    "hooks"
+  ],
   "author": "Jatin Parate <jatin4228@gmail.com>",
   "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/jatin-parate/react-reactive-val/issues"
+  },
+  "homepage": "https://github.com/jatin-parate/react-reactive-val#readme",
+  "peerDependencies": {
+    "react": "^19.0.0"
+  },
   "devDependencies": {
     "@babel/core": "^7.24.0",
     "@babel/preset-env": "^7.24.0",
     "@babel/preset-react": "^7.23.3",
     "@babel/preset-typescript": "^7.23.3",
     "@types/react": "^19.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "babel-loader": "^9.1.3",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.5.2",
+    "prettier": "^3.5.3",
     "react": "^19.1.0",
     "terser-webpack-plugin": "^5.3.10",
     "typescript": "^5.8.3",
     "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ]
   }
 }