@abcnews/tiny-ducks 中文文档教程
Tiny Ducks
tiny-ducks
是 React 的小型 redux 风格状态管理模块。
Usage
有关使用示例,请参阅示例。
Development
本模块使用tsdx
进行开发和打包。
从根文件夹开始。 这将构建到 /dist
并以监视模式运行项目,因此您在 src
中保存的任何编辑都会导致重建到 /dist
。
npm i
npm start
然后在另一个终端内运行该示例:
cd example
npm i
npm start
要进行一次性构建,请使用 npm run build
。
要运行测试,请使用 npm test
。
Configuration
代码质量为您设置 prettier
, husky< /code> 和
lint-staged
。 相应地调整 package.json
中的各个字段。
Jest
Jest 测试设置为使用 npm test
运行。 这将以交互模式运行测试观察器 (Jest)。 默认情况下,运行与自上次提交以来更改的文件相关的测试。
Rollup
TSDX 使用 Rollup v1.x 作为捆绑器,并为各种模块格式和构建设置生成多个汇总配置。 有关详细信息,请参阅优化。
TypeScript
tsconfig.json
被设置为解释 dom
和 esnext
类型,以及 react
for jsx 。 根据您的需要进行调整。
Tiny Ducks
tiny-ducks
is a small redux-style state management module for React.
Usage
For usage examples see the example.
Development
This module uses tsdx
for development and packaging.
Get started in the root folder. This builds to /dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.
npm i
npm start
Then run the example inside another terminal:
cd example
npm i
npm start
To do a one-off build, use npm run build
.
To run tests, use npm test
.
Configuration
Code quality is set up for you with prettier
, husky
, and lint-staged
. Adjust the respective fields in package.json
accordingly.
Jest
Jest tests are set up to run with npm test
. This runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.
Rollup
TSDX uses Rollup v1.x as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.
TypeScript
tsconfig.json
is set up to interpret dom
and esnext
types, as well as react
for jsx
. Adjust according to your needs.