@airfleet/generator-init 0.1.0 → 0.4.0

package/README.md

@@ -1,5 +1,8 @@
 # Airfleet Generator
 
+![npm](https://img.shields.io/npm/v/@airfleet/generator-init)
+[![pipeline status](https://gitlab.com/codersclan/tools/airfleet-generator/badges/main/pipeline.svg)](https://gitlab.com/codersclan/tools/airfleet-generator/-/commits/main)
+
 A Yeoman generator to scaffold common Airfleet features.
 
 ## Requirements
@@ -17,7 +20,13 @@ npm install -g @airfleet/generator-init
 
 | Generator |                Command                |                Description                |
 | --------- | ------------------------------------- | ----------------------------------------- |
+| Block     | `yo @airfleet/init:block --force`     | Create a block for the Airfleet Theme     |
 | Component | `yo @airfleet/init:component --force` | Create a component for the Airfleet Theme |
+| npm       | `yo @airfleet/init:npm --force`       | Generate an npm package for publishing    |
+
+## Documentation
+
+- [Documentation](https://www.notion.so/codersclan/Airfleet-Generator-cb340bfda8354ec9a2d1ddebfac58795).
 
 ## License
 

package/generators/app/index.js

@@ -1,10 +1,15 @@
 "use strict";
 import Generator from "yeoman-generator";
+import chalk from "chalk";
 
 import title from "../../utils/log/title.js";
+import infoBox from "../../utils/log/boxes/infoBox.js";
 
 export default class extends Generator {
   async prompting() {
     this.log(title("Hi! Please run one of the available sub-generators."));
+    this.log(
+      infoBox(`Read the documentation at ${chalk.blue("https://bit.ly/3DyMMC5")}`)
+    );
   }
 }

package/generators/block/index.js

@@ -0,0 +1,184 @@
+"use strict";
+import Generator from "yeoman-generator";
+import { paramCase } from "change-case";
+
+import themeFeature from "../../utils/log/themeFeature.js";
+import nameCases from "../../utils/nameCases.js";
+import copyTemplates from "../../utils/copyTemplates.js";
+import appendTemplates from "../../utils/appendTemplates.js";
+import addThemeScript from "../../utils/codemod/addThemeScript.js";
+import requiredText from "../../utils/validation/requiredText.js";
+import acfData from "../../utils/acfData.js";
+
+export default class extends Generator {
+  async prompting() {
+    this.log(themeFeature("Block"));
+
+    const prompts = [
+      {
+        type: "input",
+        name: "blockName",
+        message: "What is the name of the block?",
+        validate: requiredText("Please enter a name"),
+      },
+      {
+        type: "input",
+        name: "blockDescription",
+        message: "How would you describe the block?",
+      },
+      {
+        type: "list",
+        name: "blockKind",
+        message: "What kind of block do you want to start with?",
+        choices: ["Barebones", "Building block", "Building repeater block"],
+        default: "Barebones",
+      },
+      {
+        type: "confirm",
+        name: "createBlockComposer",
+        message: "Create composer (controller)?",
+        default: true,
+        store: true,
+      },
+      {
+        type: "confirm",
+        name: "createBlockStyles",
+        message: "Create SCSS stylesheet?",
+        default: true,
+        store: true,
+      },
+      {
+        type: "confirm",
+        name: "createBlockScript",
+        message: "Create JavaScript file?",
+        default: false,
+        store: true,
+      },
+      {
+        type: "confirm",
+        name: "createBlockAcf",
+        message: "Create custom fields?",
+        default: false,
+        store: true,
+      },
+    ];
+
+    this.answers = await this.prompt(prompts);
+    this.name = nameCases(this.answers.blockName);
+    this.kind = paramCase(this.answers.blockKind);
+    this.acf = acfData({ fields: this._acfFields(this.kind) });
+    this.data = {
+      answers: this.answers,
+      name: this.name,
+      acf: this.acf,
+    };
+  }
+
+  _acfFields(kind) {
+    if (kind === "building-block") {
+      return [
+        "headerTab",
+        "sectionHeaderGroup",
+        "sectionHeaderClone",
+        "textTab",
+        "textGroup",
+        "textClone",
+        "mediaTab",
+        "mediaGroup",
+        "mediaClone",
+        "buttonsTab",
+        "buttonsGroup",
+        "buttonsClone",
+        "formTab",
+        "formGroup",
+        "formClone",
+        "settingsTab",
+        "backgroundGroup",
+        "backgroundClone",
+      ];
+    }
+
+    if (kind === "building-repeater-block") {
+      return [
+        "headerTab",
+        "headerGroup",
+        "headerClone",
+        "textTab",
+        "showText",
+        "textGroup",
+        "textClone",
+        "columnsTab",
+        "columnsRepeater",
+        "columnsMediaTab",
+        "columnsMediaGroup",
+        "columnsMediaClone",
+        "columnsTitleTab",
+        "columnsTitleGroup",
+        "columnsTitleClone",
+        "columnsTextTab",
+        "columnsTextGroup",
+        "columnsTextClone",
+        "columnsCtaTab",
+        "columnsCtaGroup",
+        "columnsCtaClone",
+        "buttonsTab",
+        "showButtons",
+        "buttonsGroup",
+        "buttonsClone",
+        "settingsTab",
+        "backgroundGroup",
+        "backgroundClone",
+      ];
+    }
+
+    return [];
+  }
+
+  writing() {
+    const templates = [
+      {
+        template: `${this.kind}.blade.php.ejs`,
+        destination: `theme/blocks/${this.name.slug}.blade.php`,
+        isEnabled: true,
+      },
+      {
+        template: "composer.php.ejs",
+        destination: `app/src/Blocks/${this.name.pascal}Block.php`,
+        isEnabled: this.answers.createBlockComposer,
+      },
+      {
+        template: "styles/_block.scss.ejs",
+        destination: `resources/styles/theme/blocks/_${this.name.slug}.scss`,
+        isEnabled: this.answers.createBlockStyles,
+      },
+      {
+        template: "scripts/block.js.ejs",
+        destination: `resources/scripts/theme/blocks/${this.name.camel}.js`,
+        isEnabled: this.answers.createBlockScript,
+      },
+      {
+        template: `acf/${this.kind}.json.ejs`,
+        destination: `theme/acf-json/${this.acf.key}.json`,
+        isEnabled: this.answers.createBlockAcf,
+      },
+    ];
+    const appends = [
+      {
+        template: "styles/index.scss.ejs",
+        destination: "resources/styles/theme/blocks/index.scss",
+        isEnabled: this.answers.createBlockStyles,
+      },
+    ];
+
+    copyTemplates(this, templates, this.data);
+    appendTemplates(this, appends, this.data);
+
+    if (this.answers.createBlockScript) {
+      addThemeScript(this, {
+        indexPath: "resources/scripts/theme/index.js",
+        importName: this.name.pascal,
+        importPath: `./blocks/${this.name.camel}`,
+      });
+    }
+  }
+}

package/generators/block/templates/acf/barebones.json.ejs

@@ -0,0 +1,23 @@
+{
+  "key": "<%= acf.key %>",
+  "title": "Block: <%= name.title %>",
+  "fields": [],
+  "location": [
+      [
+          {
+              "param": "block",
+              "operator": "==",
+              "value": "acf\/<%= name.slug %>"
+          }
+      ]
+  ],
+  "menu_order": 0,
+  "position": "normal",
+  "style": "default",
+  "label_placement": "top",
+  "instruction_placement": "label",
+  "hide_on_screen": "",
+  "active": 1,
+  "description": "",
+  "modified": <%= acf.timestamp %>
+}

package/generators/block/templates/acf/building-block.json.ejs

@@ -0,0 +1,348 @@
+{
+    "key": "<%= acf.key %>",
+    "title": "Block: <%= name.title %>",
+    "fields": [
+        {
+            "key": "<%= acf.fields.headerTab %>",
+            "label": "Header",
+            "name": "",
+            "type": "tab",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "placement": "left",
+            "endpoint": 0
+        },
+        {
+            "key": "<%= acf.fields.sectionHeaderGroup %>",
+            "label": "Section Header",
+            "name": "section_header",
+            "type": "group",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "layout": "block",
+            "sub_fields": [
+                {
+                    "key": "<%= acf.fields.sectionHeaderClone %>",
+                    "label": "Section Header",
+                    "name": "section_header",
+                    "type": "clone",
+                    "instructions": "",
+                    "required": 0,
+                    "conditional_logic": 0,
+                    "wrapper": {
+                        "width": "",
+                        "class": "",
+                        "id": ""
+                    },
+                    "clone": [
+                        "group_5d10c6c72aa88"
+                    ],
+                    "display": "seamless",
+                    "layout": "block",
+                    "prefix_label": 0,
+                    "prefix_name": 0
+                }
+            ]
+        },
+        {
+            "key": "<%= acf.fields.textTab %>",
+            "label": "Text",
+            "name": "",
+            "type": "tab",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "placement": "top",
+            "endpoint": 0
+        },
+        {
+            "key": "<%= acf.fields.textGroup %>",
+            "label": "Text",
+            "name": "text",
+            "type": "group",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "layout": "block",
+            "sub_fields": [
+                {
+                    "key": "<%= acf.fields.textClone %>",
+                    "label": "Text",
+                    "name": "text",
+                    "type": "clone",
+                    "instructions": "",
+                    "required": 0,
+                    "conditional_logic": 0,
+                    "wrapper": {
+                        "width": "",
+                        "class": "",
+                        "id": ""
+                    },
+                    "clone": [
+                        "group_5d10c3212d211"
+                    ],
+                    "display": "seamless",
+                    "layout": "block",
+                    "prefix_label": 0,
+                    "prefix_name": 0
+                }
+            ]
+        },
+        {
+            "key": "<%= acf.fields.mediaTab %>",
+            "label": "Media",
+            "name": "",
+            "type": "tab",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "placement": "top",
+            "endpoint": 0
+        },
+        {
+            "key": "<%= acf.fields.mediaGroup %>",
+            "label": "Media",
+            "name": "media",
+            "type": "group",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "layout": "block",
+            "sub_fields": [
+                {
+                    "key": "<%= acf.fields.mediaClone %>",
+                    "label": "Media",
+                    "name": "media",
+                    "type": "clone",
+                    "instructions": "",
+                    "required": 0,
+                    "conditional_logic": 0,
+                    "wrapper": {
+                        "width": "",
+                        "class": "",
+                        "id": ""
+                    },
+                    "clone": [
+                        "group_5dd2ebd632e0c"
+                    ],
+                    "display": "seamless",
+                    "layout": "block",
+                    "prefix_label": 0,
+                    "prefix_name": 0
+                }
+            ]
+        },
+        {
+            "key": "<%= acf.fields.buttonsTab %>",
+            "label": "Buttons",
+            "name": "",
+            "type": "tab",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "placement": "top",
+            "endpoint": 0
+        },
+        {
+            "key": "<%= acf.fields.buttonsGroup %>",
+            "label": "Buttons",
+            "name": "buttons",
+            "type": "group",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "layout": "block",
+            "sub_fields": [
+                {
+                    "key": "<%= acf.fields.buttonsClone %>",
+                    "label": "Buttons",
+                    "name": "buttons",
+                    "type": "clone",
+                    "instructions": "",
+                    "required": 0,
+                    "conditional_logic": 0,
+                    "wrapper": {
+                        "width": "",
+                        "class": "",
+                        "id": ""
+                    },
+                    "clone": [
+                        "group_5d10a747c1ff5"
+                    ],
+                    "display": "seamless",
+                    "layout": "block",
+                    "prefix_label": 0,
+                    "prefix_name": 0
+                }
+            ]
+        },
+        {
+            "key": "<%= acf.fields.formTab %>",
+            "label": "Form",
+            "name": "",
+            "type": "tab",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "placement": "top",
+            "endpoint": 0
+        },
+        {
+            "key": "<%= acf.fields.formGroup %>",
+            "label": "Form",
+            "name": "form",
+            "type": "group",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "layout": "block",
+            "sub_fields": [
+                {
+                    "key": "<%= acf.fields.formClone %>",
+                    "label": "Form",
+                    "name": "form",
+                    "type": "clone",
+                    "instructions": "",
+                    "required": 0,
+                    "conditional_logic": 0,
+                    "wrapper": {
+                        "width": "",
+                        "class": "",
+                        "id": ""
+                    },
+                    "clone": [
+                        "group_5d1489f3b62ec"
+                    ],
+                    "display": "seamless",
+                    "layout": "block",
+                    "prefix_label": 0,
+                    "prefix_name": 0
+                }
+            ]
+        },
+        {
+            "key": "<%= acf.fields.settingsTab %>",
+            "label": "Settings",
+            "name": "",
+            "type": "tab",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "placement": "top",
+            "endpoint": 0
+        },
+        {
+            "key": "<%= acf.fields.backgroundGroup %>",
+            "label": "Background",
+            "name": "background",
+            "type": "group",
+            "instructions": "",
+            "required": 0,
+            "conditional_logic": 0,
+            "wrapper": {
+                "width": "",
+                "class": "",
+                "id": ""
+            },
+            "layout": "block",
+            "sub_fields": [
+                {
+                    "key": "<%= acf.fields.backgroundClone %>",
+                    "label": "Background",
+                    "name": "background",
+                    "type": "clone",
+                    "instructions": "",
+                    "required": 0,
+                    "conditional_logic": 0,
+                    "wrapper": {
+                        "width": "",
+                        "class": "",
+                        "id": ""
+                    },
+                    "clone": [
+                        "group_5d10cb5bb41ca"
+                    ],
+                    "display": "seamless",
+                    "layout": "block",
+                    "prefix_label": 0,
+                    "prefix_name": 0
+                }
+            ]
+        }
+    ],
+    "location": [
+        [
+            {
+                "param": "block",
+                "operator": "==",
+                "value": "acf\/<%= name.slug %>"
+            }
+        ]
+    ],
+    "menu_order": 0,
+    "position": "normal",
+    "style": "default",
+    "label_placement": "top",
+    "instruction_placement": "label",
+    "hide_on_screen": "",
+    "active": 1,
+    "description": "",
+    "modified": <%= acf.timestamp %>
+}