storybook-screenshot-schematics

The storybook-screenshot-schematics schematics are an extension to the Angular schematics with Storybook templates for storybook-chrome-screenshot. It allows you to both generate a .stories.ts file together with your new components and standalone stories files.

Getting Started

Add storybook-screenshot-schematics to your Angular app with Storybook and storybook-chrome-screenshot.

$ npm install --save-dev storybook-screenshot-schematics

Configure

The storybook-screenshot-schematics replicate the default @schematics/angular collection, so if you want to reuse any custom configuration such as non CSS styles, you should replicate such configuration in angular.json. You can check out your project's @schematic/angular settings with:

$ ng config projects.webapp.schematics

For example, to generate SCSS style templates with your components instead of CSS:

$ ng config projects.webapp.schematics.storybook-screenshot-schematics:component.styleext sass

(Optional) You can set storybook-screenshot-schematics as the default collection in your Angular CLI project:

$ ng config cli.defaultCollection storybook-screenshot-schematics

This way you avoid having to specify the storybook-screenshot-schematics collection every time you generate a component.

Usage

# if you use storybook-screenshot-schematics as the default collection
$ ng generate component foo
CREATE src/app/foo/foo.component.scss (0 bytes)
CREATE src/app/foo/foo.component.html (22 bytes)
CREATE src/app/foo/foo.component.spec.ts (607 bytes)
CREATE src/app/foo/foo.component.ts (258 bytes)
CREATE src/app/foo/foo.component.stories.ts (376 bytes)
UPDATE src/app/app.module.ts (481 bytes)

# if you do not use storybook-screenshot-schematics as the default collection
$ ng generate storybook-screenshot-schematics:component bar
CREATE src/app/bar/bar.component.scss (0 bytes)
CREATE src/app/bar/bar.component.html (22 bytes)
CREATE src/app/bar/bar.component.spec.ts (607 bytes)
CREATE src/app/bar/bar.component.ts (258 bytes)
CREATE src/app/bar/bar.component.stories.ts (376 bytes)
UPDATE src/app/app.module.ts (481 bytes)

# if you have a component without story...
$ ng generate @schematics/angular:component pie
CREATE src/app/pie/pie.component.scss (0 bytes)
CREATE src/app/pie/pie.component.html (22 bytes)
CREATE src/app/pie/pie.component.spec.ts (607 bytes)
CREATE src/app/pie/pie.component.ts (258 bytes)
UPDATE src/app/app.module.ts (481 bytes)

# ...then you can simply create a stories file using the same syntax
$ ng generate storybook-screenshot-schematics:stories pie
CREATE src/app/pie/pie.component.stories.ts (376 bytes)

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org