plop-generator-ngxs-store
v1.0.3
Published
plop generator for ngxs state management pattern + library for Angular
Downloads
5
Maintainers
Readme
💧 plop generator ngxs store
A plop
generator for allowing easily create slices of state for ngxs
state management pattern + library for Angular.
This package aims to follow closely the ngxs style guide
.
📦 Installation
This package is hosted on npm
.
npm install --save-dev plop-generator-ngxs-store
🥑 Usage
First, be sure you have plop
installed. Then, add the following line to your plopfile.js
.
plop.load("plop-generator-ngxs-store");
A minimal plopfile.js
can be
module.exports = (plop) => plop.load('plop-generator-ngxs-store');
Now you'll have access to the store
generator as shown below.
> plop
? store name (examples: HelloWorld, hello-world): HelloWorld
The store
generator scaffolds ngxs slice of state. Generated files include actions .actions.ts
, default state model .constant.ts
, selectors .selector.ts
, state .state.ts
, tests for the state .state.spec.ts
and state model .types.ts
.
Tests are written in jest.
All the generated files are exported via index.ts
file for easy importing.
src
└── store
├── index.ts
└── hello-world.actions.ts
└── hello-world.constant.ts
└── hello-world.selector.ts
└── hello-world.state.ts
└── hello-world.state.spec.ts
└── hello-world.types.ts
❔ Questions
🐛 report bugs by filing issues
📢 provide feedback with issues or on twitter