WIP: feat: add schematics for @ngxs/store

[splincode]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/ngxs/store/blob/master/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

ngxs/store#35

What is the new behavior?

Installation

Install Angular CLI

You should be using @angular/cli@6.1.0 or newer.

npm i -g @angular/cli

Install NGXS Schematics

npm i -g @ngxs/schematics

Usage

Creating a new project

To generate new Angular project with NGXS Store, you can use ng new with @ngxs/schematics specified as the schematics collection.

ng new --collection=@ngxs/schematics my-app

Create a NGXS Store

To generate store with @ngxs/schematics:

ng generate @ngxs/schematics:store --name todo

Result:

CREATE src/todo/todo.actions.ts
CREATE src/todo/todo.state.ts

Or with spec:

ng generate @ngxs/schematics:store --name todo --spec

Result:

CREATE src/todo/todo.actions.ts
CREATE src/todo/todo.state.spec.ts
CREATE src/todo/todo.state.ts

Create a NGXS State

To generate state with @ngxs/schematics:

ng generate @ngxs/schematics:state --name todo

Result:

CREATE src/todo/todo.state.ts

Or with spec:

ng generate @ngxs/schematics:state --name todo --spec

Result:

CREATE src/todo/todo.state.spec.ts
CREATE src/todo/todo.state.ts

Create a NGXS Actions

To generate state with @ngxs/schematics:

ng generate @ngxs/schematics:actions --name todo

Result:

CREATE src/todo/todo.actions.ts

NGXS Starter Kit

Usage

To generate store with @ngxs/schematics:starter-kit:

ng generate @ngxs/schematics:starter-kit

Result:

CREATE src/store/store.config.ts
CREATE src/store/store.module.ts
CREATE src/store/auth/auth.actions.ts
CREATE src/store/auth/auth.state.spec.ts
CREATE src/store/auth/auth.state.ts
CREATE src/store/auth/model/auth.model.ts
CREATE src/store/dashboard/index.ts
CREATE src/store/dashboard/states/dictionary/dictionary.actions.ts
CREATE src/store/dashboard/states/dictionary/dictionary.state.spec.ts
CREATE src/store/dashboard/states/dictionary/dictionary.state.ts
CREATE src/store/dashboard/states/dictionary/model/dictionary-response.model.ts
CREATE src/store/dashboard/states/user/user.actions.ts
CREATE src/store/dashboard/states/user/user.state.spec.ts
CREATE src/store/dashboard/states/user/user.state.ts
CREATE src/store/dashboard/states/user/model/person.model.ts

Does this PR introduce a breaking change?

[ ] Yes
[x] No

[markwhitfeld]

Amazing! The only thing that needs to be tweaked is that the StateModel definitions should be interfaces and not classes. Strictly you should only store plain old javascript objects in your store, not any objects with prototypes or classes

[kyusupov33]

WIP

[markwhitfeld]

Almost there.
Just a few variable name updates and an old library name left around.
Also we could potentially improve the auth module in the starter kit, but it depends on how far you want to go here. I think we could tweak the auth template later though after merging.
PS Just push a new commit into your branch with the fixes as opposed to squashing or rebasing so that it makes it easier to see the changes after this review. Thanks!

[markwhitfeld]

Just a few more small tweaks

[markwhitfeld]

LGTM. Nicely done!

[ahnpnl]

Hi, I have a question regarding to this feature. Would it be possible to have a sorter command line ? Something like ng generate ngxs (inspired from nrwl ). In my opinion, @ngxs/schematics is kind of long to type.

[splincode]

Create issue please