@violetflux/kerros 0.3.1 → 0.3.3
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/README.md +2 -0
- package/README.zh-CN.md +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -300,6 +300,8 @@ export default [kerros.configs.recommendedTypeChecked]
|
|
|
300
300
|
|
|
301
301
|
`recommendedTypeChecked` enables all 16 rules as errors and uses TypeScript `projectService`. Very large repositories may use `kerros.configs.fastTypeChecked`, which keeps type-aware Store recognition but disables the most expensive whole-program and deep analyses. See the [measured ESLint benchmark](https://github.com/violetflux/kerros/blob/main/benchmarks/eslint/RESULTS.md); the fast profile is a tradeoff, not an untyped fallback. The plugin analyzes complete TS/TSX files, not incomplete Markdown snippets.
|
|
302
302
|
|
|
303
|
+
`no-broad-store-access` rejects enumeration, serialization, and spreading of a complete selector-free Store snapshot. Nested object fields and intentional complete adapters inside `createStore` models are allowed by default; stricter projects can enable `includeObjectFields` and `includeStoreModels` in the rule options.
|
|
304
|
+
|
|
303
305
|
For maintainers, npm Trusted Publisher entries must be configured for both `@violetflux/kerros` and `@violetflux/eslint-plugin-kerros`. That npm-side configuration is the only release step outside this repository; CI checks and publishes the runtime first, then the plugin.
|
|
304
306
|
|
|
305
307
|
## Documentation
|
package/README.zh-CN.md
CHANGED
|
@@ -292,6 +292,8 @@ export default [kerros.configs.recommendedTypeChecked]
|
|
|
292
292
|
|
|
293
293
|
`recommendedTypeChecked` 把全部 16 条规则设为 error，并启用 TypeScript `projectService`。超大型仓库可改用 `kerros.configs.fastTypeChecked`：它仍然通过类型识别真实 Kerros Hook，只关闭最昂贵的全程序与深层分析。请参考[真实 ESLint 压测](https://github.com/violetflux/kerros/blob/main/benchmarks/eslint/RESULTS.md)；fast 是性能取舍，不是不可靠的命名降级。插件首版只分析完整 TS/TSX 文件，不分析不完整 Markdown 代码块。
|
|
294
294
|
|
|
295
|
+
`no-broad-store-access` 会禁止枚举、序列化或展开完整的无 selector Store 快照，默认允许操作嵌套对象字段，也允许在 `createStore` model 内有意代理完整 Store。需要收紧的项目可以在规则选项中启用 `includeObjectFields` 和 `includeStoreModels`。
|
|
296
|
+
|
|
295
297
|
维护者还需要分别为 `@violetflux/kerros` 和 `@violetflux/eslint-plugin-kerros` 配置 npm Trusted Publisher。这是唯一的仓库外发布步骤；仓库内工作流会先检查并发布运行库，再发布插件。
|
|
296
298
|
|
|
297
299
|
## 文档
|