Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valantic/spartacus-blueprint
Custom ng schematics to generate Spartacus components & features based on blueprint files
https://github.com/valantic/spartacus-blueprint
Last synced: 8 days ago
JSON representation
Custom ng schematics to generate Spartacus components & features based on blueprint files
- Host: GitHub
- URL: https://github.com/valantic/spartacus-blueprint
- Owner: valantic
- License: mit
- Created: 2022-09-22T09:19:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-25T11:34:50.000Z (7 months ago)
- Last Synced: 2024-04-26T00:10:20.434Z (7 months ago)
- Language: TypeScript
- Size: 146 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Getting Started With Composable Storefront Schematics
This repository is a Custom Schematics implementation for Component Blueprints for Composable Storefront (formerly Spartacus)
from Valantic. It can be used to create new components / features for SAP Composable Storefront Projects.
Following blueprints are implemented as for now:
- Feature
- CMS Component
- Simple Component
### Angular / Composable Storefront Version
This Repository is based on Angular Version 14. It is therefore only compatible with Composable Storefront Versions > 5.0.0.
### How to use
Install @valantic/spartacus-blueprints in your project
```bash
npm i -D @valantic/spartacus-blueprints
```
Schematics can be executed from root directory with `ng genereate @valantic/spartacus-blueprints:BLUEPRINT your/path/Name` where `BLUEPRINT` is one of the following:
#### Feature
The Feature Blueprint schematic can be run either with only the feature name only or additionally with a specific path
(if running with a specific path check all imports in generated files). If run without a path it will be added to your
projects features folder.
```bash
ng generate @valantic/spartacus-blueprints:feature src/app/[PROJECT_NAME]/features/MyFeatureName
or
ng generate @valantic/spartacus-blueprints:feature MyFeatureName
or
# enter the feature path and name in the prompt
ng generate @valantic/spartacus-blueprints:feature
```
#### CMS Component
The CMS Component Blueprint schematic can be run either with only the feature name only or additionally with a specific
path (if running with a specific path check all imports in generated files). If run without a path it will be added to
your projects cms components folder.
```bash
ng generate @valantic/spartacus-blueprints:cms-component src/app/[PROJECT_NAME]/features/cms/components/MyCmsComponentName
or
ng generate @valantic/spartacus-blueprints:cms-component MyCmsComponentName
or
# enter the component path and name in the prompt
ng generate @valantic/spartacus-blueprints:cms-component MyCmsComponentName
```
#### Simple Component
The Simple Component Blueprint schematic should be run with a path, and you have to check all imports in all generated
files afterwards.
```bash
ng generate @valantic/spartacus-blueprints:simple-component src/app/[PROJECT_NAME]/your/path/MySimpleComponentName
or
# enter the component path and name in the prompt
ng generate @valantic/spartacus-blueprints:simple-component
```
#### General
In general, you have to import the created module in the corresponding parent module to make it work for now. Consider
whether to lazy load or static load it accordingly.
### Todo
- Automated import in modules
- Flag for lazy loading modules
- Flag for creating redux store boilerplate code
### Local dev
For developing, simply run:
```bash
npm run build:watch
```
### Testing
To test locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool. That tool
acts the same as the `generate` command of the Angular CLI, but also has a debug mode.
Check the documentation with
```bash
schematics --help
```
### Unit Testing
`npm run test` will run the unit tests, using Jasmine as a runner and test framework.
### Publishing
To publish, simply do:
```bash
npm run build
npm publish
```
That's it!