@airfleet/generator-init 0.1.0 → 0.2.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,8 +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 |
 
+## Documentation
+
+- [Documentation](https://www.notion.so/codersclan/Airfleet-Generator-cb340bfda8354ec9a2d1ddebfac58795).
+
 ## License
 
 © [Airfleet](https://www.airfleet.co/)

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,115 @@
+"use strict";
+import Generator from "yeoman-generator";
+
+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: "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.acf = acfData({ prefix: "group_" });
+    this.data = {
+      answers: this.answers,
+      name: this.name,
+      acf: this.acf,
+    };
+  }
+
+  writing() {
+    const templates = [
+      {
+        template: "block.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/group.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/group.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/block.blade.php.ejs

@@ -0,0 +1,8 @@
+<%_ if (answers.blockDescription) { _%>
+{{--
+  Description: <%= answers.blockDescription %>
+--}}
+<% } _%>
+@block([ 'block' => $block ])
+
+@endblock

package/generators/block/templates/composer.php.ejs

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Blocks;
+
+class <%= name.pascal %>Block implements \App\Core\BlockComposer {
+	public function __construct( $context ) {
+		$this->context = $context;
+	}
+
+	public function get_context( $context ) {
+		return af_defaults(
+			[],
+			$context
+		);
+	}
+}

package/generators/block/templates/scripts/block.js.ejs

@@ -0,0 +1,9 @@
+export default class <%= name.pascal %> {
+  constructor() {
+    this.selector = '.b-<%= name.slug %>';
+  }
+
+  bootstrap() {
+    
+  }
+}

package/generators/block/templates/styles/_block.scss.ejs

@@ -0,0 +1,3 @@
+.b-<%= name.slug %> {
+  
+}

package/generators/block/templates/styles/index.scss.ejs

@@ -0,0 +1 @@
+@import '<%= name.slug %>';

package/generators/component/index.js

@@ -16,34 +16,34 @@ export default class extends Generator {
     const prompts = [
       {
         type: "input",
-        name: "name",
+        name: "componentName",
         message: "What is the name of the component?",
         validate: requiredText("Please enter a name"),
       },
       {
         type: "confirm",
-        name: "createComposer",
+        name: "createComponentComposer",
         message: "Create composer (controller)?",
         default: true,
         store: true,
       },
       {
         type: "confirm",
-        name: "createStyles",
+        name: "createComponentStyles",
         message: "Create SCSS stylesheet?",
         default: true,
         store: true,
       },
       {
         type: "confirm",
-        name: "createScript",
+        name: "createComponentScript",
         message: "Create JavaScript file?",
         default: false,
         store: true,
       },
       {
         type: "confirm",
-        name: "createAcf",
+        name: "createComponentAcf",
         message: "Create custom fields?",
         default: false,
         store: true,
@@ -51,8 +51,8 @@ export default class extends Generator {
     ];
 
     this.answers = await this.prompt(prompts);
-    this.name = nameCases(this.answers.name);
-    this.acf = acfData({ prefix: "group_" }),
+    this.name = nameCases(this.answers.componentName);
+    this.acf = acfData({ prefix: "group_" });
     this.data = {
       answers: this.answers,
       name: this.name,
@@ -68,38 +68,38 @@ export default class extends Generator {
         isEnabled: true,
       },
       {
-        template: "controller.php.ejs",
+        template: "composer.php.ejs",
         destination: `app/src/Components/${this.name.pascal}Component.php`,
-        isEnabled: this.answers.createComposer,
+        isEnabled: this.answers.createComponentComposer,
       },
       {
         template: "styles/_component.scss.ejs",
         destination: `resources/styles/theme/components/_${this.name.slug}.scss`,
-        isEnabled: this.answers.createStyles,
+        isEnabled: this.answers.createComponentStyles,
       },
       {
         template: "scripts/component.js.ejs",
         destination: `resources/scripts/theme/components/${this.name.camel}.js`,
-        isEnabled: this.answers.createScript,
+        isEnabled: this.answers.createComponentScript,
       },
       {
         template: "acf/group.json.ejs",
         destination: `theme/acf-json/${this.acf.key}.json`,
-        isEnabled: this.answers.createAcf,
+        isEnabled: this.answers.createComponentAcf,
       },
     ];
     const appends = [
       {
         template: "styles/index.scss.ejs",
         destination: "resources/styles/theme/components/index.scss",
-        isEnabled: this.answers.createStyles,
+        isEnabled: this.answers.createComponentStyles,
       },
     ];
 
     copyTemplates(this, templates, this.data);
     appendTemplates(this, appends, this.data);
 
-    if (this.answers.createScript) {
+    if (this.answers.createComponentScript) {
       addThemeScript(this, {
         indexPath: "resources/scripts/theme/index.js",
         importName: this.name.pascal,

package/generators/component/templates/component.blade.php.ejs

@@ -1,9 +1,9 @@
-<%_ if (answers.createAcf) { _%>
+<%_ if (answers.createComponentAcf) { _%>
 {{--
   Key: <%= acf.key %>
 --}}
 <% } _%>
-<%_ if (!answers.createComposer) { _%>
+<%_ if (!answers.createComponentComposer) { _%>
 @php
 	$class = af_value_or_default( $class, '' );
 @endphp

package/generators/component/templates/scripts/component.js.ejs

@@ -4,6 +4,6 @@ export default class <%= name.pascal %> {
   }
 
   bootstrap() {
-
+    
   }
 }

package/generators/component/templates/styles/_component.scss.ejs

@@ -1,3 +1,3 @@
 .c-<%= name.slug %> {
-
+  
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@airfleet/generator-init",
   "description": "A Yeoman generator to scaffold common Airfleet features",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "scripts": {},
   "publishConfig": {
     "access": "public"
@@ -10,7 +10,7 @@
     "airfleet",
     "yeoman-generator"
   ],
-  "homepage": "https://www.airfleet.co/",
+  "homepage": "https://www.airfleet.co",
   "author": {
     "name": "Airfleet",
     "email": "dev@airfleet.co",
@@ -27,7 +27,7 @@
     "utils"
   ],
   "engines": {
-    "node": ">=14"
+    "node": ">=12"
   },
   "dependencies": {
     "boxen": "^6.2.1",

package/utils/log/boxes/infoBox.js

@@ -0,0 +1,9 @@
+import box from "./box.js";
+
+export default function infoBox(message, options) {
+  return box(message, {
+    borderColor: "cyan",
+    title: "Info",
+    ...options,
+  });
+}

package/utils/log/themeFeature.js

@@ -1,10 +1,8 @@
 import title from "./title.js";
 import brandText from "./text/brandText.js";
-import dangerText from "./text/dangerText.js";
 import highlightText from "./text/highlightText.js";
 import lines from "./text/lines.js";
 import dangerBox from "./boxes/dangerBox.js";
-import box from "./boxes/box.js";
 
 export default function themeFeature(feature) {
   return lines([