@airfleet/generator-init 0.30.0 → 0.31.0

package/generators/plugin/templates/composer-scoped.json.ejs

@@ -1,6 +1,6 @@
 {
   "require": {
-    "airfleet/wordpress-framework": "^1.3.0"
+    "airfleet/wordpress-framework": "^1.5.0"
   },
   "config": {
     "autoloader-suffix": "<%= name.pascal %>"

package/generators/plugin/templates/composer-scoped.lock.ejs

@@ -1,124 +1,124 @@
 {
-  "_readme": [
-      "This file locks the dependencies of your project to a known state",
-      "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
-      "This file is @generated automatically"
-  ],
-  "content-hash": "0bc133803c8119982f80c3cdd959905e",
-  "packages": [
-      {
-          "name": "airfleet/wordpress-framework",
-          "version": "1.3.0",
-          "source": {
-              "type": "git",
-              "url": "https://github.com/airfleet/airfleet-wordpress-framework-php.git",
-              "reference": "4b50080dea677541b5df35dc17812b8cc93f5f9c"
-          },
-          "dist": {
-              "type": "zip",
-              "url": "https://api.github.com/repos/airfleet/airfleet-wordpress-framework-php/zipball/4b50080dea677541b5df35dc17812b8cc93f5f9c",
-              "reference": "4b50080dea677541b5df35dc17812b8cc93f5f9c",
-              "shasum": ""
-          },
-          "require": {
-              "jawira/case-converter": "^3.5",
-              "php": ">=8.0"
-          },
-          "type": "library",
-          "autoload": {
-              "psr-4": {
-                  "Airfleet\\Framework\\": "inc/"
-              }
-          },
-          "notification-url": "https://packagist.org/downloads/",
-          "authors": [
-              {
-                  "name": "Airfleet",
-                  "email": "dev@airfleet.co"
-              }
-          ],
-          "description": "Airfleet framework for WordPress",
-          "support": {
-              "issues": "https://github.com/airfleet/airfleet-wordpress-framework-php/issues",
-              "source": "https://github.com/airfleet/airfleet-wordpress-framework-php/tree/1.3.0"
-          },
-          "time": "2024-04-18T11:18:51+00:00"
-      },
-      {
-          "name": "jawira/case-converter",
-          "version": "v3.5.1",
-          "source": {
-              "type": "git",
-              "url": "https://github.com/jawira/case-converter.git",
-              "reference": "2be05b98dcb743bef60ab6f849145bd3434ed003"
-          },
-          "dist": {
-              "type": "zip",
-              "url": "https://api.github.com/repos/jawira/case-converter/zipball/2be05b98dcb743bef60ab6f849145bd3434ed003",
-              "reference": "2be05b98dcb743bef60ab6f849145bd3434ed003",
-              "shasum": ""
-          },
-          "require": {
-              "ext-mbstring": "*",
-              "php": ">=7.4"
-          },
-          "require-dev": {
-              "behat/behat": "^3.0",
-              "phpstan/phpstan": "^1.0",
-              "phpunit/phpunit": "^9.0",
-              "vimeo/psalm": "^4.0"
-          },
-          "suggest": {
-              "pds/skeleton": "PHP Package Development Standards",
-              "phing/phing": "PHP Build Tool"
-          },
-          "type": "library",
-          "autoload": {
-              "psr-4": {
-                  "Jawira\\CaseConverter\\": "src/"
-              }
-          },
-          "notification-url": "https://packagist.org/downloads/",
-          "license": [
-              "MIT"
-          ],
-          "authors": [
-              {
-                  "name": "Jawira Portugal",
-                  "email": "dev@tugal.be"
-              }
-          ],
-          "description": "Convert strings between 13 naming conventions: Snake case, Camel case, Pascal case, Kebab case, Ada case, Train case, Cobol case, Macro case, Upper case, Lower case, Sentence case, Title case and Dot notation.",
-          "homepage": "https://jawira.github.io/case-converter/",
-          "keywords": [
-              "Ada case",
-              "Cobol case",
-              "Macro case",
-              "Train case",
-              "camel case",
-              "dot notation",
-              "kebab case",
-              "lower case",
-              "pascal case",
-              "sentence case",
-              "snake case",
-              "title case",
-              "upper case"
-          ],
-          "support": {
-              "issues": "https://github.com/jawira/case-converter/issues",
-              "source": "https://github.com/jawira/case-converter/tree/v3.5.1"
-          },
-          "time": "2022-08-14T11:40:18+00:00"
-      }
-  ],
-  "packages-dev": [],
-  "aliases": [],
-  "minimum-stability": "stable",
-  "stability-flags": [],
-  "prefer-stable": false,
-  "prefer-lowest": false,
-  "platform": [],
-  "platform-dev": [],
-  "plugin-api-version": "2.6.0"
+    "_readme": [
+        "This file locks the dependencies of your project to a known state",
+        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
+        "This file is @generated automatically"
+    ],
+    "content-hash": "9c5f20589b695e0465c3e3f17445638a",
+    "packages": [
+        {
+            "name": "airfleet/wordpress-framework",
+            "version": "1.5.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/airfleet/airfleet-wordpress-framework-php.git",
+                "reference": "5847995d05980b5215458b8cacd74d223a5e0d8b"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/airfleet/airfleet-wordpress-framework-php/zipball/5847995d05980b5215458b8cacd74d223a5e0d8b",
+                "reference": "5847995d05980b5215458b8cacd74d223a5e0d8b",
+                "shasum": ""
+            },
+            "require": {
+                "jawira/case-converter": "^3.5",
+                "php": ">=8.0"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Airfleet\\Framework\\": "inc/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "authors": [
+                {
+                    "name": "Airfleet",
+                    "email": "dev@airfleet.co"
+                }
+            ],
+            "description": "Airfleet framework for WordPress",
+            "support": {
+                "issues": "https://github.com/airfleet/airfleet-wordpress-framework-php/issues",
+                "source": "https://github.com/airfleet/airfleet-wordpress-framework-php/tree/1.5.0"
+            },
+            "time": "2024-05-28T17:03:25+00:00"
+        },
+        {
+            "name": "jawira/case-converter",
+            "version": "v3.5.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/jawira/case-converter.git",
+                "reference": "2be05b98dcb743bef60ab6f849145bd3434ed003"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/jawira/case-converter/zipball/2be05b98dcb743bef60ab6f849145bd3434ed003",
+                "reference": "2be05b98dcb743bef60ab6f849145bd3434ed003",
+                "shasum": ""
+            },
+            "require": {
+                "ext-mbstring": "*",
+                "php": ">=7.4"
+            },
+            "require-dev": {
+                "behat/behat": "^3.0",
+                "phpstan/phpstan": "^1.0",
+                "phpunit/phpunit": "^9.0",
+                "vimeo/psalm": "^4.0"
+            },
+            "suggest": {
+                "pds/skeleton": "PHP Package Development Standards",
+                "phing/phing": "PHP Build Tool"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Jawira\\CaseConverter\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Jawira Portugal",
+                    "email": "dev@tugal.be"
+                }
+            ],
+            "description": "Convert strings between 13 naming conventions: Snake case, Camel case, Pascal case, Kebab case, Ada case, Train case, Cobol case, Macro case, Upper case, Lower case, Sentence case, Title case and Dot notation.",
+            "homepage": "https://jawira.github.io/case-converter/",
+            "keywords": [
+                "Ada case",
+                "Cobol case",
+                "Macro case",
+                "Train case",
+                "camel case",
+                "dot notation",
+                "kebab case",
+                "lower case",
+                "pascal case",
+                "sentence case",
+                "snake case",
+                "title case",
+                "upper case"
+            ],
+            "support": {
+                "issues": "https://github.com/jawira/case-converter/issues",
+                "source": "https://github.com/jawira/case-converter/tree/v3.5.1"
+            },
+            "time": "2022-08-14T11:40:18+00:00"
+        }
+    ],
+    "packages-dev": [],
+    "aliases": [],
+    "minimum-stability": "stable",
+    "stability-flags": [],
+    "prefer-stable": false,
+    "prefer-lowest": false,
+    "platform": [],
+    "platform-dev": [],
+    "plugin-api-version": "2.6.0"
 }

package/generators/plugin/templates/gitignore

@@ -12,3 +12,4 @@ dist
 vendor-scoped
 wp-content
 .DS_Store
+.idea

package/generators/plugin/templates/package.json.ejs

@@ -42,7 +42,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@airfleet/wordpress-dev": "^3.1.0"
+    "@airfleet/wordpress-dev": "^3.2.0"
   },
   "browserslist": [
   "defaults",

package/generators/project-plugin/index.js

@@ -0,0 +1,229 @@
+"use strict";
+import Generator from "yeoman-generator";
+import { paramCase } from "change-case";
+
+import nameCases from "../../utils/nameCases.js";
+import copyTemplates from "../../utils/copyTemplates.js";
+import mapFilesToTemplates from "../../utils/mapFilesToTemplates.js";
+import requiredText from "../../utils/validation/requiredText.js";
+import title from "../../utils/log/title.js";
+import highlightText from "../../utils/log/text/highlightText.js";
+import lines from "../../utils/log/text/lines.js";
+import infoBox from "../../utils/log/boxes/infoBox.js";
+import objectPropertyFromValue from '../../utils/objectPropertyFromValue.js';
+
+export default class extends Generator {
+  async prompting() {
+    this.log(
+      lines([
+        title(`Let's generate a ${highlightText("WordPress client plugin")}!`),
+        infoBox(
+          lines([
+            "This will create the files for a WP plugin.",
+            "",
+            "Before starting you should have:",
+            " - Created a repository",
+            "",
+            "All the files will be created in the current",
+            "folder. Make sure to navigate to repo folder",
+            "first.",
+          ])
+        ),
+        "",
+      ])
+    );
+
+    const prompts = [
+      {
+        type: "input",
+        name: "pluginName",
+        message: 'What is the name of the plugin? (e.g. "Airfleet Cyberproof")',
+        validate: requiredText("Please enter a name"),
+      },
+      {
+        type: "input",
+        name: "pluginDescription",
+        message: "How would you describe the plugin?",
+        validate: requiredText("Please enter a description"),
+      },
+      {
+        type: "input",
+        name: "pluginRepository",
+        message:
+          "What's the repository URL? (start with https and end with .git)",
+        validate: requiredText("Please enter the repository URL"),
+      },
+      {
+        type: "input",
+        name: "pluginPhpVersion",
+        message: "What's the required PHP version?",
+        validate: requiredText("Please enter the PHP version"),
+        default: ">=8.2",
+      },
+      {
+        type: "input",
+        name: "pluginNodeVersion",
+        message: "What's the required Node version?",
+        validate: requiredText("Please enter the Node version"),
+        default: ">=16",
+      },
+      {
+        type: "confirm",
+        name: "pluginUseBlade",
+        message: "Use Blade?",
+        default: false,
+      },
+    ];
+
+    this.answers = await this.prompt(prompts);
+    this.name = nameCases(this.answers.pluginName);
+
+    const nameNoAirfleet = this.answers.pluginName
+      .replace(/^airfleet/i, "")
+      .trim();
+    this.nameNoAirfleet = nameCases(nameNoAirfleet);
+    this.data = {
+      answers: this.answers,
+      name: this.name,
+      nameNoAirfleet: this.nameNoAirfleet,
+      repositoryBase: this.answers.pluginRepository.replace(/\.git$/, ""),
+      packageName: `@airfleet/${this.nameNoAirfleet.slug}-wp-plugin`,
+      mainBranch: "main",
+      year: new Date().getFullYear(),
+      phpVersion: this._getPhpVersion(this.answers.pluginPhpVersion),
+    };
+  }
+
+  writing() {
+    const templateExtension = this.answers.pluginUseBlade ? 'blade.php' : 'php';
+
+    const files = [
+      ".github/workflows/create-asana-attachment.yaml",
+      ".github/workflows/test-wordpress.yml",
+      ".husky/pre-commit",
+      ".vscode/settings.json",
+      "acf-json/.gitkeep",
+      "acf-json/field-groups/.gitkeep",
+      "acf-json/option-pages/.gitkeep",
+      "acf-json/option-pages/airfleet-site-settings.json",
+      "acf-json/post-types/.gitkeep",
+      "acf-json/taxonomies/.gitkeep",
+      "assets/admin/styles/admin.entry.scss",
+      "assets/editor/styles/editor.entry.scss",
+      "assets/frontend/fonts/.gitkeep",
+      "assets/frontend/images/.gitkeep",
+      "assets/frontend/scripts/index.entry.js",
+      "assets/frontend/styles/main/_body.scss",
+      "assets/frontend/styles/main/_reset.scss",
+      "assets/frontend/styles/placeholders/_button.scss",
+      "assets/frontend/styles/placeholders/_container.scss",
+      "assets/frontend/styles/placeholders/_sections.scss",
+      "assets/frontend/styles/root/_fonts.scss",
+      "assets/frontend/styles/_main.scss",
+      "assets/frontend/styles/_placeholders.scss",
+      "assets/frontend/styles/_root.scss",
+      "assets/frontend/styles/critical.entry.scss",
+      "assets/frontend/styles/index.entry.scss",
+      "assets/login/.gitkeep",
+      "assets/shared/styles/lib/mixins/_background.scss",
+      "assets/shared/styles/lib/mixins/_body.scss",
+      "assets/shared/styles/lib/mixins/_breakpoints.scss",
+      "assets/shared/styles/lib/mixins/_helpers.scss",
+      "assets/shared/styles/lib/mixins/_list-inline.scss",
+      "assets/shared/styles/lib/mixins/_position.scss",
+      "assets/shared/styles/lib/_mixins.scss",
+      "assets/shared/styles/lib/_scss-variables.scss",
+      "assets/shared/styles/_figma-variables.scss",
+      "assets/shared/styles/_lib.scss",
+      "assets/shared/styles/_root.scss",
+      "assets/shared/styles/_shared.scss",
+      "figma/design-tokens/.gitkeep",
+      "figma/design-tokens/manifest.json",
+      "inc/Features/Menus.php.ejs",
+      "inc/Setup/AjaxVariables.php.ejs",
+      "inc/Setup/AjaxVariablesAdmin.php.ejs",
+      "inc/Setup/Breakpoints.php.ejs",
+      "inc/Setup/Colors.php.ejs",
+      "inc/Setup/RegisterViews.php.ejs",
+      "inc/Setup.php.ejs",
+      "views/blocks/.gitkeep",
+      "views/components/.gitkeep",
+      "views/custom-templates/.gitkeep",
+      `views/partials/footer/footer.${templateExtension}.ejs`,
+      `views/partials/header/header.${templateExtension}.ejs`,
+      `views/partials/layout/layout.${templateExtension}.ejs`,
+      `views/templates/index/index.${templateExtension}.ejs`,
+      `views/templates/not-found/not-found.${templateExtension}.ejs`,
+      `views/templates/page/page.${templateExtension}.ejs`,
+      `views/templates/single/single.${templateExtension}.ejs`,
+      "views/parcelkeep.entry.scss",
+      "views-elements/partials/button/button.entry.scss",
+      "views-elements/partials/button/ButtonSetup.php.ejs",
+      "views-elements/.gitkeep",
+      ".airfleet-release",
+      ".editorconfig",
+      ".env",
+      ".gitattributes",
+      ".parcelrc",
+      ".prettierignore",
+      "CHANGELOG.md",
+      "composer.json.ejs",
+      "composer-scoped.json.ejs",
+      "index.php",
+      "LICENSE.ejs",
+      "package.json.ejs",
+      "phpcs.xml.ejs",
+      "README.md.ejs",
+      "scoper.custom.php.ejs",
+    ];
+    const templates = [
+      ...mapFilesToTemplates(files),
+      {
+        template: "gitignore",
+        destination: `.gitignore`,
+        isEnabled: true,
+      },
+      {
+        template: ".husky/gitignore",
+        destination: `.husky/.gitignore`,
+        isEnabled: true,
+      },
+      {
+        template: "plugin-name.php.ejs",
+        destination: `${this.name.slug}.php`,
+        isEnabled: true,
+      },
+      {
+        template: "acf-json/.gitkeep",
+        destination: `acf-json/.gitkeep`,
+        isEnabled: true,
+      },
+      {
+        template: ".vscode/airfleet.code-snippets.ejs",
+        destination: ".vscode/airfleet.code-snippets",
+        isEnabled: true,
+      },
+    ];
+
+    copyTemplates(this, templates, this.data);
+  }
+
+  install() {
+    this.spawnCommand("composer", ["install"]);
+  }
+
+  _getPhpVersion(pluginPhpVersion) {
+    const toFind = ['=','>'];
+
+    for (const char of toFind) {
+      const index = pluginPhpVersion.indexOf(char);
+
+      if (index >= 0) {
+        return pluginPhpVersion.substring(index + 1);
+      }
+    }
+
+    return pluginPhpVersion;
+  }
+
+}

package/generators/project-plugin/templates/.airfleet-release

@@ -0,0 +1 @@
+minor

package/generators/project-plugin/templates/.editorconfig

@@ -0,0 +1,18 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.php]
+indent_style = tab
+indent_size = 4

package/generators/project-plugin/templates/.gitattributes

@@ -0,0 +1,12 @@
+*.js eol=lf
+*.jsx eol=lf
+*.ts eol=lf
+*.tsx eol=lf
+*.json eol=lf
+*.md eol=lf
+*.yml eol=lf
+*.yaml eol=lf
+*.css eol=lf
+*.scss eol=lf
+*.php eol=lf
+*.xml eol=lf

package/generators/project-plugin/templates/.github/workflows/create-asana-attachment.yaml

@@ -0,0 +1,19 @@
+name: ✍️ Asana Create PR Attachment
+
+on:
+  pull_request:
+    types: [opened, reopened]
+
+jobs:
+  create-asana-attachment-job:
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    name: Create pull request attachments on Asana tasks
+    steps:
+      - name: Create pull request attachments
+        uses: Asana/create-app-attachment-github-action@latest
+        id: postAttachment
+        with:
+          asana-secret: ${{ secrets.ASANA_SECRET }}
+      - name: Log output status
+        run: echo "Status is ${{ steps.postAttachment.outputs.status }}"

package/generators/project-plugin/templates/.github/workflows/test-wordpress.yml

@@ -0,0 +1,44 @@
+name: 🧪 Test
+
+on:
+  push:
+    branches: ["staging", "development"]
+  pull_request:
+    branches: ["main", "staging", "development"]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 🚚 Get latest code
+        uses: actions/checkout@v3
+
+      - name: ⚙️ Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.2"
+          ini-values: short_open_tag=1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: ⚙️ Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: 🔨 Increase composer timeout
+        run: composer --global config process-timeout 1500
+
+      - name: 🔨 Composer install
+        run: composer install --prefer-dist --no-ansi --no-interaction --no-progress --optimize-autoloader
+
+      - name: 🔨 npm install
+        run: npm ci
+
+      - name: 🔬 Test
+        run: npm test
+
+      - name: 📦 Build
+        run: npm run build --if-present

package/generators/project-plugin/templates/.husky/gitignore

@@ -0,0 +1 @@
+_

package/generators/project-plugin/templates/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/generators/project-plugin/templates/.parcelrc

@@ -0,0 +1,4 @@
+{
+  "extends": "@parcel/config-default",
+  "reporters": ["...", "parcel-reporter-bundle-manifest"]
+}

package/generators/project-plugin/templates/.prettierignore

@@ -0,0 +1,15 @@
+node_modules
+coverage
+.npmrc
+vendor
+dist
+.parcel-cache
+.eslintcache
+.stylelintcache
+.phpcscache
+.composer-cache
+acf-json
+CHANGELOG.md
+.github
+vendor-scoped
+wp-content