@plasius/react-state 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +58 -0
- package/README.md +14 -1
- package/package.json +1 -1
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# Changelog
|
|
4
|
+
|
|
5
|
+
All notable changes to this project will be documented in this file.
|
|
6
|
+
|
|
7
|
+
The format is based on **[Keep a Changelog](https://keepachangelog.com/en/1.1.0/)**, and this project adheres to **[Semantic Versioning](https://semver.org/spec/v2.0.0.html)**.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## [Unreleased]
|
|
12
|
+
### Added
|
|
13
|
+
- (placeholder) Add new hooks, scoped store features, or context helpers here.
|
|
14
|
+
|
|
15
|
+
### Changed
|
|
16
|
+
- (placeholder)
|
|
17
|
+
|
|
18
|
+
### Fixed
|
|
19
|
+
- (placeholder)
|
|
20
|
+
|
|
21
|
+
### Security
|
|
22
|
+
- (placeholder)
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## [0.1.0] - 2025-09-16
|
|
27
|
+
### Added
|
|
28
|
+
- Initial public release of `@plasius/react-state`.
|
|
29
|
+
- `createStore` for basic state container functionality with `dispatch`, `getState`, and subscription API.
|
|
30
|
+
- `createScopedStoreContext` for React integration:
|
|
31
|
+
- `<Provider>` component wrapping React trees,
|
|
32
|
+
- `useStore()` to access state,
|
|
33
|
+
- `useDispatch()` to dispatch actions.
|
|
34
|
+
- Support for per-key subscriptions and selector-based subscriptions.
|
|
35
|
+
- Unit tests with Vitest and component tests with React Testing Library.
|
|
36
|
+
- Early Playwright integration tests for end-to-end validation of store-driven DOM.
|
|
37
|
+
|
|
38
|
+
### Changed
|
|
39
|
+
- N/A (initial release)
|
|
40
|
+
|
|
41
|
+
### Fixed
|
|
42
|
+
- N/A (initial release)
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Release process (maintainers)
|
|
47
|
+
1. Update `CHANGELOG.md` under **Unreleased** with user‑visible changes.
|
|
48
|
+
2. Bump version in `package.json` following SemVer (major/minor/patch).
|
|
49
|
+
3. Move entries from **Unreleased** to a new version section with the current date.
|
|
50
|
+
4. Tag the release in Git (`vX.Y.Z`) and push tags.
|
|
51
|
+
5. Publish to npm (via CI/CD or `npm publish`).
|
|
52
|
+
|
|
53
|
+
> Tip: Use Conventional Commits in PR titles/bodies to make changelog updates easier.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
[Unreleased]: https://github.com/Plasius-LTD/react-state/compare/v0.1.0...HEAD
|
|
58
|
+
[0.1.0]: https://github.com/Plasius-LTD/react-state/releases/tag/v0.1.0
|
package/README.md
CHANGED
|
@@ -7,16 +7,22 @@
|
|
|
7
7
|
[](./SECURITY.md)
|
|
8
8
|
[](./CHANGELOG.md)
|
|
9
9
|
|
|
10
|
+
---
|
|
11
|
+
|
|
10
12
|
## Overview
|
|
11
13
|
|
|
12
14
|
`@plasius/react-state` provides a scoped state management solution for React applications. It allows developers to create isolated, testable, and composable stores without introducing heavy dependencies.
|
|
13
15
|
|
|
16
|
+
---
|
|
17
|
+
|
|
14
18
|
## Installation
|
|
15
19
|
|
|
16
20
|
```bash
|
|
17
21
|
npm install @plasius/react-state
|
|
18
22
|
```
|
|
19
23
|
|
|
24
|
+
---
|
|
25
|
+
|
|
20
26
|
## Usage Example
|
|
21
27
|
|
|
22
28
|
```tsx
|
|
@@ -54,9 +60,16 @@ function doSomething() {
|
|
|
54
60
|
}
|
|
55
61
|
```
|
|
56
62
|
|
|
63
|
+
---
|
|
64
|
+
|
|
57
65
|
## Contributing
|
|
58
66
|
|
|
59
|
-
|
|
67
|
+
We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
|
|
68
|
+
|
|
69
|
+
- [Code of Conduct](./CODE_OF_CONDUCT.md)
|
|
70
|
+
- [Contributor License Agreement](./legal/CLA.md)
|
|
71
|
+
|
|
72
|
+
---
|
|
60
73
|
|
|
61
74
|
## License
|
|
62
75
|
|