effectable 0.1.0 → 1.0.0-canary.1

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.
Files changed (2) hide show
  1. package/README.md +14 -2
  2. package/package.json +12 -1
package/README.md CHANGED
@@ -145,12 +145,24 @@ export const MyService = connect(store, mapStateToProps)(MyServiceRaw);
145
145
  - `effectable/connect` — connect, MapStateToProps, ConnectOptions
146
146
  - `effectable/runtime` — EventBus, CommandBus, QueryBus, HandleRegistry, BusDecorators (`wireRuntimeBuses`, **`wireRuntimeBusesAll`** — wire several handlers to the same bus set; process code usually reuses the same `commandBus` / `queryBus` / `eventBus` as `bootstrap(...).runtime`, without a second `createRuntimeBuses` / `HandleRegistry`)
147
147
 
148
+ ## Contributing
149
+
150
+ Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (enforced by commitlint + lefthook). The same messages drive [semantic-release](https://semantic-release.app/) version bumps (`feat` → minor, `fix`/`perf` → patch, breaking → major).
151
+
152
+ ```text
153
+ feat: add HandleRegistry autoRegister example
154
+ fix: buffer setState during onMount
155
+ docs: clarify bootstrap shutdown
156
+ ```
157
+
158
+ After `npm ci`, lefthook installs a local `commit-msg` hook. CI also lint-checks PR commits. Prefer Conventional Commits for squash-merge titles too.
159
+
148
160
  ## Publishing
149
161
 
150
162
  - **Canary** (`develop`): `npm install effectable@canary`
151
- - **Stable** (`main` / tags `vX.Y.Z`): `npm install effectable`
163
+ - **Stable** (`main`): `npm install effectable`
152
164
 
153
- Details: [docs/PUBLISHING.md](docs/PUBLISHING.md).
165
+ Versions are bumped automatically by semantic-release in CI. Details: [docs/PUBLISHING.md](docs/PUBLISHING.md).
154
166
 
155
167
  ## License
156
168
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "effectable",
3
- "version": "0.1.0",
3
+ "version": "1.0.0-canary.1",
4
4
  "description": "Declarative reactive runtime for Node.js: bootstrap, Redux-style RxJS store, Component lifecycle, class-based connect, and GraphRuntime.",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -86,6 +86,10 @@
86
86
  "test:spec": "jest --config ./jest.config.js --runInBand --testPathPatterns=spec",
87
87
  "test:entity": "jest --config ./jest.config.js --runInBand --testPathPatterns=entity",
88
88
  "bench": "jest --config ./jest.bench.config.js --runInBand",
89
+ "prepare": "lefthook install",
90
+ "commitlint": "commitlint --edit",
91
+ "semantic-release": "semantic-release",
92
+ "semantic-release:dry-run": "semantic-release --dry-run",
89
93
  "prepublishOnly": "npm run typecheck && npm test && npm run build"
90
94
  },
91
95
  "publishConfig": {
@@ -100,9 +104,16 @@
100
104
  "rxjs": "^7.8.2"
101
105
  },
102
106
  "devDependencies": {
107
+ "@commitlint/cli": "^21.2.1",
108
+ "@commitlint/config-conventional": "^21.2.0",
109
+ "@semantic-release/changelog": "^7.0.0",
110
+ "@semantic-release/git": "^11.0.1",
111
+ "conventional-changelog-conventionalcommits": "^10.2.1",
103
112
  "@types/jest": "^29.5.14",
104
113
  "@types/node": "^22.16.0",
105
114
  "jest": "^30.1.3",
115
+ "lefthook": "^2.1.10",
116
+ "semantic-release": "^25.0.9",
106
117
  "ts-jest": "^29.4.9",
107
118
  "typescript": "^6.0.3"
108
119
  }