generator-spider
v0.5.59
Published
Yeoman SpiderSock component generator
Downloads
26
Maintainers
Readme
How to use
First make sure you have Yeoman running, if not get it by running this command in your terminal:
npm install -g yoTo install generator-spider from npm, run:
npm install -g generator-spiderFinally, initiate the generator:
yo spiderDependencies
In order for the whole thing to work, the project root has to contain spidersock.json file, which should look like this:
{
"name": "Project Name",
"version": "1.0.0",
"description": "Wordpress website for Client A",
"installer-path": "wp-content/themes/theme-name/_incs/components/",
"builders": {
"scss": {
"marker": "/* --spiders:{{type}}s-- */",
"controllers": [
"wp-content/themes/theme-name/_incs/scss/stylesheet.scss"
]
}
},
"devDependencies": {
},
"author": "Your Name",
"license": "BSD"
}Few things to note:
- marker value defaults to what's shown above, so it's technically optional.
- your controller SCSS should follow this or similar structure:
/* COMPONENTS: ATOMS */
@import "atoms/group/component-name/controller";
/* --spiders:atoms-- */
/* COMPONENTS: MOLECULES */
@import "molecules/group/component-name/controller";
/* --spiders:molecules-- */
/* COMPONENTS: ORGANISMS */
@import "organisms/group/component-name/controller";
/* --spiders:organisms-- */License
MIT
