@airfleet/generator-init 0.4.0 → 0.7.0

package/README.md

@@ -22,7 +22,8 @@ npm install -g @airfleet/generator-init
 | --------- | ------------------------------------- | ----------------------------------------- |
 | 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    |
+| npm       | `yo @airfleet/init:npm`               | Generate an npm package for publishing    |
+| Plugin    | `yo @airfleet/init:plugin`            | Create a WP plugin                        |
 
 ## Documentation
 

package/generators/npm/index.js

@@ -96,14 +96,20 @@ export default class extends Generator {
       ".airfleet-release",
       ".editorconfig",
       ".gitattributes",
-      ".gitignore",
       ".gitlab-ci.yml",
       "CHANGELOG.md",
       "LICENSE.ejs",
       "package.json.ejs",
       "README.md.ejs",
     ];
-    const templates = mapFilesToTemplates(files);
+    const templates = [
+      ...mapFilesToTemplates(files),
+      {
+        template: "gitignore",
+        destination: `.gitignore`,
+        isEnabled: true,
+      },
+    ];
 
     copyTemplates(this, templates, this.data);
   }

package/generators/npm/templates/.gitattributes

@@ -9,3 +9,4 @@
 *.css eol=lf
 *.scss eol=lf
 *.php eol=lf
+*.xml eol=lf

package/generators/npm/templates/gitignore

@@ -0,0 +1,3 @@
+node_modules
+coverage
+.npmrc

package/generators/npm/templates/package.json.ejs

@@ -19,7 +19,6 @@
     "type": "git",
     "url": "<%= answers.npmRepository %>"
   },
-  "type": "module",
   "engines": {
     "node": "<%- answers.npmNodeVersion %>"
   },

package/generators/plugin/index.js

@@ -0,0 +1,157 @@
+"use strict";
+import Generator from "yeoman-generator";
+
+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 brandText from "../../utils/log/text/brandText.js";
+import dangerText from "../../utils/log/text/dangerText.js";
+import infoBox from "../../utils/log/boxes/infoBox.js";
+
+export default class extends Generator {
+  async prompting() {
+    this.log(
+      lines([
+        title(`Let's generate a ${highlightText("WordPress plugin")}!`),
+        infoBox(
+          lines([
+            "This will create the files for a WP plugin.",
+            "",
+            "Before starting you should have:",
+            " - Created a repository",
+            " - Created the Notion page (can start empty)",
+            "",
+            "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? (start with "Airfleet")',
+        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: "pluginDocumentationUrl",
+        message: "What's the documentation URL? (Notion page)",
+        validate: requiredText("Please enter the documentation URL"),
+      },
+      {
+        type: "confirm",
+        name: "pluginCreateOptions",
+        message: "Create theme options page?",
+        default: true,
+      },
+      {
+        type: "input",
+        name: "pluginVersion",
+        message: "What's the starting version for the plugin?",
+        validate: requiredText("Please enter the starting version"),
+        default: "0.0.0",
+      },
+      {
+        type: "input",
+        name: "pluginPhpVersion",
+        message: "What's the required PHP version?",
+        validate: requiredText("Please enter the PHP version"),
+        default: ">=7.4",
+      },
+      {
+        type: "input",
+        name: "pluginNodeVersion",
+        message: "What's the required Node version?",
+        validate: requiredText("Please enter the Node version"),
+        default: ">=14",
+      },
+    ];
+
+    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(),
+    };
+  }
+
+  writing() {
+    const files = [
+      ".husky/.gitignore",
+      ".husky/pre-commit",
+      ".vscode/settings.json",
+      "assets/admin/scripts/admin.entry.js",
+      "assets/admin/styles/admin.scss",
+      "assets/frontend/fonts/.gitkeep",
+      "assets/frontend/images/.gitkeep",
+      "assets/frontend/scripts/index.entry.js",
+      "assets/frontend/styles/index.scss",
+      "inc/Setup.php.ejs",
+      ".airfleet-release",
+      ".editorconfig",
+      ".env",
+      ".gitattributes",
+      ".gitlab-ci.yml",
+      ".parcelrc",
+      ".prettierignore",
+      "CHANGELOG.md",
+      "composer.json.ejs",
+      "index.php",
+      "LICENSE.ejs",
+      "package.json.ejs",
+      "phpcs.xml.ejs",
+      "README.md.ejs",
+    ];
+    const templates = [
+      ...mapFilesToTemplates(files),
+      {
+        template: "gitignore",
+        destination: `.gitignore`,
+        isEnabled: true,
+      },
+      {
+        template: "plugin-name.php.ejs",
+        destination: `${this.name.slug}.php`,
+        isEnabled: true,
+      },
+    ];
+
+    copyTemplates(this, templates, this.data);
+  }
+
+  install() {
+    this.spawnCommand("composer", ["install"]);
+  }
+}

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

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

package/generators/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/plugin/templates/.env

@@ -0,0 +1 @@
+PARCEL_WORKER_BACKEND=process

package/generators/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/plugin/templates/.gitlab-ci.yml

@@ -0,0 +1,8 @@
+stages:
+  - release
+
+include:
+  # Release process
+  - project: "codersclan/tools/gitlab-ci-templates"
+    ref: main
+    file: "/release/wp-plugin.yaml"

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

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

package/generators/plugin/templates/.parcelrc

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

package/generators/plugin/templates/.prettierignore

@@ -0,0 +1,12 @@
+node_modules
+coverage
+.npmrc
+vendor
+dist
+.parcel-cache
+.eslintcache
+.stylelintcache
+.phpcscache
+.composer-cache
+acf-json
+CHANGELOG.md

package/generators/plugin/templates/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": true
+  },
+  "editor.formatOnSave": true,
+  "stylelint.validate": ["css", "scss", "postcss"],
+  "[php]": {
+    "editor.formatOnSave": false
+  }
+}

package/generators/plugin/templates/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Added

package/generators/plugin/templates/LICENSE.ejs

@@ -0,0 +1,2 @@
+Copyright (c) <%= year %> Airfleet <dev@airfleet.co> (https://www.airfleet.co/)
+All rights reserved.

package/generators/plugin/templates/README.md.ejs

@@ -0,0 +1,20 @@
+# <%= name.title %> WordPress Plugin
+
+[![pipeline status](<%= repositoryBase %>/badges/main/pipeline.svg)](<%= repositoryBase %>/-/commits/main)
+
+<%= answers.pluginDescription %>
+
+## Getting Started
+
+```bash
+composer install
+npm install
+```
+
+## Documentation
+
+- [Documentation](<%= answers.pluginDocumentationUrl %>).
+
+## License
+
+© [Airfleet](https://www.airfleet.co/)

package/generators/plugin/templates/assets/admin/scripts/admin.entry.js

@@ -0,0 +1 @@
+import "../styles/admin.scss";

package/generators/plugin/templates/assets/frontend/scripts/index.entry.js

@@ -0,0 +1,5 @@
+import "../styles/index.scss";
+
+if (module.hot) {
+  module.hot.accept();
+}

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

@@ -0,0 +1,38 @@
+{
+  "name": "airfleet/<%= name.slug %>",
+  "type": "wordpress-plugin",
+  "authors": [
+    {
+      "name": "Airfleet",
+      "email": "dev@airfleet.co"
+    }
+  ],
+  "require": {
+    "php": "<%- answers.pluginPhpVersion %>",
+    "composer/installers": "^2.0"
+  },
+  "require-dev": {
+    "airfleet/wordpress-dev": "^1.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Airfleet\\Plugins\\<%= nameNoAirfleet.pascal %>\\": "inc/"
+    }
+  },
+  "scripts": {
+    "lint": "phpcs",
+    "fix": "phpcbf",
+    "install-codestandards": [
+      "Dealerdirect\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin::run"
+    ],
+    "post-install-cmd": [
+      "@install-codestandards"
+    ]
+  },
+  "config": {
+    "allow-plugins": {
+      "composer/installers": true,
+      "dealerdirect/phpcodesniffer-composer-installer": true
+    }
+  }
+}

package/generators/plugin/templates/gitignore

@@ -0,0 +1,11 @@
+node_modules
+coverage
+.npmrc
+vendor
+dist
+.parcel-cache
+.eslintcache
+.stylelintcache
+.phpcscache
+.composer-cache
+.env

package/generators/plugin/templates/inc/Setup.php.ejs

@@ -0,0 +1,92 @@
+<?php
+
+namespace Airfleet\Plugins\<%= nameNoAirfleet.pascal %>;
+
+class Setup {
+
+	/**
+	 * Setup the plugin.
+	 *
+	 * @return void
+	 */
+	public function initialize() {
+		<%_ if (answers.pluginCreateOptions) { _%>
+    $this->add_option_pages();
+		<%_ } _%>
+		$this->enqueue();
+	}
+
+	/**
+	 * Enqueue the scripts and styles.
+	 *
+	 * @return void
+	 */
+	public function enqueue() {
+		$version = <%= name.constant %>_VERSION;
+
+		add_action(
+			'wp_enqueue_scripts',
+			function () use ( $version ) {
+				wp_enqueue_style(
+					'<%= name.slug %>-styles',
+					plugins_url( '/dist/frontend/scripts/index.entry.css', __DIR__ ),
+					[],
+					$version
+				);
+				wp_enqueue_script(
+					'<%= name.slug %>-scripts',
+					plugins_url( '/dist/frontend/scripts/index.entry.js', __DIR__ ),
+					[],
+					$version,
+					true
+				);
+			}
+		);
+		add_action(
+			'admin_enqueue_scripts',
+			function () use ( $version ) {
+				wp_enqueue_style(
+					'<%= name.slug %>-admin-styles',
+					plugins_url( '/dist/admin/scripts/admin.entry.css', __DIR__ ),
+					[],
+					$version
+				);
+				wp_enqueue_script(
+					'<%= name.slug %>-admin-scripts',
+					plugins_url( '/dist/admin/scripts/admin.entry.js', __DIR__ ),
+					[],
+					$version,
+					true
+				);
+			}
+		);
+	}
+	<%_ if (answers.pluginCreateOptions) {%>
+	/**
+	 * Add theme options pages.
+	 *
+	 * @return void
+	 */
+	public function add_option_pages() {
+		add_action(
+			'acf/init',
+			function () {
+        \acf_add_options_page(
+          [
+            'page_title' => __( 'Airfleet Theme Settings', 'airfleet' ),
+            'menu_title' => __( 'Airfleet', 'airfleet' ),
+            'menu_slug' => 'airfleet-settings',
+          ]
+        );
+        \acf_add_options_sub_page(
+          [
+            'page_title' => __( '<%= name.title %> Settings', '<%= name.slug %>' ),
+            'menu_title' => __( '<%= nameNoAirfleet.title %>', '<%= name.slug %>' ),
+            'parent_slug' => 'airfleet-settings',
+          ]
+        );
+			}
+		);
+	}
+	<% } _%>
+}

package/generators/plugin/templates/index.php

@@ -0,0 +1 @@
+<?php // Silence is golden

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

@@ -0,0 +1,78 @@
+{
+  "name": "<%= packageName %>",
+  "description": "<%= answers.pluginDescription %>",
+  "version": "<%= answers.pluginVersion %>",
+  "scripts": {
+    "build": "dotenv -- parcel build --log-level verbose ./assets/**/*.entry.js",
+    "start": "dotenv -- parcel serve --hmr-port 1236 --port 1234 --log-level verbose ./assets/**/*.entry.js",
+    "base:eslint": "eslint assets --ext .js,.jsx --cache --ignore-path .gitignore",
+    "base:prettier": "prettier \"**/*.{js,jsx,ts,tsx,json,css,scss,xml,yaml,yml,md}\"",
+    "base:stylelint": "stylelint \"**/*.{css,scss}\" --cache --ignore-path .gitignore",
+    "lint": "run-s --continue-on-error lint:*",
+    "lint:prettier": "npm run base:prettier -- --check",
+    "lint:eslint": "npm run base:eslint",
+    "lint:stylelint": "npm run base:stylelint",
+    "lint:phpcs": "composer run lint",
+    "fix": "run-s fix:*",
+    "fix:prettier": "npm run base:prettier -- --write",
+    "fix:eslint": "npm run base:eslint -- --fix",
+    "fix:stylelint": "npm run base:stylelint -- --fix",
+    "fix:phpcs": "composer run fix",
+    "pretest": "npm run lint",
+    "test": "echo Testing done",
+    "prepare": "husky install",
+    "cz": "git-cz"
+  },
+  "private": true,
+  "keywords": [
+    "airfleet"
+  ],
+  "homepage": "https://www.airfleet.co",
+  "author": {
+    "name": "Airfleet",
+    "email": "dev@airfleet.co",
+    "url": "https://www.airfleet.co/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "<%= answers.pluginRepository %>"
+  },
+  "engines": {
+    "node": "<%- answers.pluginNodeVersion %>"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@airfleet/wordpress-dev": "^0.3.0"
+  },
+  "browserslist": [
+    "defaults",
+    "not IE 11",
+    "not op_mini all"
+  ],
+  "prettier": "@airfleet/prettier-config-wordpress",
+  "stylelint": {
+    "extends": [
+      "@airfleet/stylelint-config-wordpress"
+    ]
+  },
+  "eslintConfig": {
+    "extends": [
+      "@airfleet/eslint-config-wordpress",
+      "plugin:no-jquery/all"
+    ]
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,json,css,scss,xml,yaml,yml,md}": "prettier --write",
+    "*.{js,jsx}": "eslint --cache --ignore-path .gitignore --fix",
+    "*.{css,scss}": "stylelint --cache --ignore-path .gitignore --fix",
+    "*.php": [
+      "composer run fix",
+      "composer run lint"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  }
+}

package/generators/plugin/templates/phpcs.xml.ejs

@@ -0,0 +1,33 @@
+<?xml version="1.0" ?>
+<ruleset
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd"
+>
+
+  <!--
+    #############################################################################
+    COMMAND LINE ARGUMENTS
+    https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
+    #############################################################################
+	-->
+
+  <!-- Set cache file -->
+  <arg name="cache" value=".phpcscache" />
+
+  <!-- Check all files in this directory and the directories below it. -->
+  <file>.</file>
+
+  <!-- Airfleet config -->
+  <rule ref="Airfleet" />
+
+  <!-- Custom i18n text domain  -->
+  <rule ref="WordPress.WP.I18n">
+    <properties>
+      <property name="text_domain" type="array">
+        <element value="airfleet" />
+        <element value="<%= name.slug %>" />
+      </property>
+    </properties>
+  </rule>
+
+</ruleset>

package/generators/plugin/templates/plugin-name.php.ejs

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * <%= name.title %>
+ *
+ * @package           Airfleet\Plugins\<%= nameNoAirfleet.pascal %>
+ * @version           <%= answers.pluginVersion %>
+ * @author            Airfleet
+ * @link              https://www.airfleet.co/
+ *
+ * @wordpress-plugin
+ * Plugin Name:       <%= name.title %>
+ * Plugin URI:        <%= answers.pluginDocumentationUrl %>
+ * Description:       <%= answers.pluginDescription %>
+ * Version:           <%= answers.pluginVersion %>
+ * Author:            Airfleet
+ * Author URI:        https://www.airfleet.co/
+ * Text Domain:       <%= name.slug %>
+ * GitLab Plugin URI: <%= repositoryBase %>
+ * Primary Branch:    <%= mainBranch %>
+ * Release Asset:     true
+ */
+
+// Exit if accessed directly.
+if ( ! defined( 'ABSPATH' ) ) {
+	die;
+}
+
+// Plugin version.
+define( '<%= name.constant %>_VERSION', '<%= answers.pluginVersion %>' );
+
+// Autoload classes.
+require_once __DIR__ . '/vendor/autoload.php';
+
+// Initialize plugin.
+$<%= name.snake %> = new \Airfleet\Plugins\<%= nameNoAirfleet.pascal %>\Setup();
+$<%= name.snake %>->initialize();
+
+/**
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * ! Do not make changes to this file.
+ * ! Edit the plugin class in folder src/.
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@airfleet/generator-init",
   "description": "A Yeoman generator to scaffold common Airfleet features",
-  "version": "0.4.0",
+  "version": "0.7.0",
   "scripts": {},
   "publishConfig": {
     "access": "public"

package/utils/nameCases.js

@@ -1,4 +1,4 @@
-import { camelCase, noCase, paramCase, pascalCase } from "change-case";
+import { camelCase, constantCase, noCase, paramCase, pascalCase, snakeCase } from "change-case";
 import { titleCase } from "title-case";
 
 export default function nameCases(name) {
@@ -20,5 +20,13 @@ export default function nameCases(name) {
 
     // "test string"
     noCase: noCase(name),
+
+    // "TEST_STRING"
+    constant: constantCase(name),
+
+    // "test_string"
+    snake: snakeCase(name),
+
+    // For more utilities see https://github.com/blakeembrey/change-case
   };
 }