@airfleet/generator-init 0.5.1 → 0.9.0

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/package.json.ejs

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

package/generators/plugin/index.js

@@ -109,15 +109,30 @@ export default class extends Generator {
 
   writing() {
     const files = [
+      ".husky/.gitignore",
+      ".husky/pre-commit",
+      ".vscode/settings.json",
+      "acf-json/.gitkeep",
+      "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 = [
@@ -132,11 +147,6 @@ export default class extends Generator {
         destination: `${this.name.slug}.php`,
         isEnabled: true,
       },
-      {
-        template: "src/Plugin.php.ejs",
-        destination: `src/${this.nameNoAirfleet.pascal}.php`,
-        isEnabled: true,
-      },
     ];
 
     copyTemplates(this, templates, this.data);

package/generators/plugin/templates/.gitattributes

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

package/generators/plugin/templates/.gitlab-ci.yml

@@ -1,8 +1,13 @@
 stages:
+  - test
   - release
 
 include:
+  # Test
+  - project: "codersclan/tools/gitlab-ci-templates"
+    ref: main
+    file: "/test/wordpress.yaml"
   # Release process
-  - project: 'codersclan/tools/gitlab-ci-templates'
+  - project: "codersclan/tools/gitlab-ci-templates"
     ref: main
-    file: '/release/wp-plugin.yaml'
+    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/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

@@ -2,18 +2,37 @@
   "name": "airfleet/<%= name.slug %>",
   "type": "wordpress-plugin",
   "authors": [
-      {
-          "name": "Airfleet",
-          "email": "dev@airfleet.co"
-      }
+    {
+      "name": "Airfleet",
+      "email": "dev@airfleet.co"
+    }
   ],
   "require": {
-      "php": "<%- answers.pluginPhpVersion %>",
-      "composer/installers": "^2.0"
+    "php": "<%- answers.pluginPhpVersion %>",
+    "composer/installers": "^2.0"
+  },
+  "require-dev": {
+    "airfleet/wordpress-dev": "^2.0"
   },
   "autoload": {
-      "psr-4": {
-          "Airfleet\\Plugins\\": "src/"
-      }
+    "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

@@ -2,3 +2,10 @@ 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,60 @@
+<?php
+
+namespace Airfleet\Plugins\<%= nameNoAirfleet.pascal %>;
+
+class Setup {
+
+	/**
+	 * Setup the plugin.
+	 *
+	 * @return void
+	 */
+	public function initialize(): void {
+		$this->show_admin_notice_if_missing_framework();
+		add_action(
+			'airfleet/init',
+			function () {
+				$plugin = new \Airfleet\Plugin(
+					[
+						'slug' => '<%= name.slug %>',
+						'title' => '<%= name.title %>',
+						'short_title' => '<%= nameNoAirfleet.title %>',
+						'url' => \<%= name.constant %>_URL,
+						'path' => \<%= name.constant %>_PATH,
+						'version' => \<%= name.constant %>_VERSION,
+					]
+				);
+				$plugin->setup_acf_json();
+        $plugin->enqueue();
+        $plugin->enqueue_admin();
+        <%_ if (answers.pluginCreateOptions) { _%>
+        $plugin->add_options_page();
+        <%_ } _%>
+			}
+		);
+	}
+
+	/**
+	 * Show and admin notification if the Airfleet Framework plugin is not enabled.
+	 *
+	 * @return void
+	 */
+	public function show_admin_notice_if_missing_framework(): void {
+		add_action(
+			'admin_notices',
+			function () {
+				global $airfleet_framework_missing_notice;
+
+				if ( $airfleet_framework_missing_notice || defined( 'AIRFLEET_FRAMEWORK_VERSION' ) ) {
+					return;
+				}
+				$airfleet_framework_missing_notice = true;
+				?>
+				<div class="notice notice-error">
+					<p>Please install the Airfleet Framework to enable the Airfleet plugins.</p>
+				</div>
+				<?php
+			}
+		);
+	}
+}

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

@@ -3,7 +3,25 @@
   "description": "<%= answers.pluginDescription %>",
   "version": "<%= answers.pluginVersion %>",
   "scripts": {
-    "build": "echo Done"
+    "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": [
@@ -19,9 +37,42 @@
     "type": "git",
     "url": "<%= answers.pluginRepository %>"
   },
-  "type": "module",
   "engines": {
     "node": "<%- answers.pluginNodeVersion %>"
   },
-  "dependencies": {}
+  "dependencies": {},
+  "devDependencies": {
+    "@airfleet/wordpress-dev": "^0.3.1"
+  },
+  "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

@@ -23,18 +23,20 @@
 
 // Exit if accessed directly.
 if ( ! defined( 'ABSPATH' ) ) {
-    die;
+	die;
 }
 
 // Plugin version.
 define( '<%= name.constant %>_VERSION', '<%= answers.pluginVersion %>' );
+define( '<%= name.constant %>_PATH', plugin_dir_path( __FILE__ ) );
+define( '<%= name.constant %>_URL', plugin_dir_url( __FILE__ ) );
 
 // Autoload classes.
 require_once __DIR__ . '/vendor/autoload.php';
 
 // Initialize plugin.
-$plugin = new \Airfleet\Plugins\<%= nameNoAirfleet.pascal %>();
-$plugin->initialize();
+$<%= name.snake %> = new \Airfleet\Plugins\<%= nameNoAirfleet.pascal %>\Setup();
+$<%= name.snake %>->initialize();
 
 /**
  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

package/package.json

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

package/utils/nameCases.js

@@ -1,4 +1,4 @@
-import { camelCase, constantCase, 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) {
@@ -24,6 +24,9 @@ export default function nameCases(name) {
     // "TEST_STRING"
     constant: constantCase(name),
 
+    // "test_string"
+    snake: snakeCase(name),
+
     // For more utilities see https://github.com/blakeembrey/change-case
   };
 }

package/generators/plugin/templates/src/Plugin.php.ejs

@@ -1,45 +0,0 @@
-<?php
-
-namespace Airfleet\Plugins;
-
-class <%= nameNoAirfleet.pascal %>
-{
-	/**
-	 * Setup the plugin.
-	 *
-	 * @return void
-	 */
-	public function initialize()
-	{
-    <%_ if (answers.pluginCreateOptions) { _%>
-		add_action( 'acf/init', array( $this,'add_option_pages' ) );
-    <%_ } _%>
-	}
-  <%_ if (answers.pluginCreateOptions) {%>
-	/**
-	 * Add theme options pages.
-	 *
-	 * @return void
-	 */
-	public function add_option_pages()
-	{
-		if ( ! function_exists( 'acf_add_options_page' ) ) {
-			return;
-		}
-		acf_add_options_page(
-			array(
-				'page_title' => __( 'Airfleet Theme Settings', 'airfleet' ),
-				'menu_title' => __( 'Airfleet', 'airfleet' ),
-				'menu_slug'  => 'airfleet-settings',
-			)
-		);
-		acf_add_options_sub_page(
-			array(
-				'page_title'  => __( '<%= name.title %> Settings', '<%= name.slug %>' ),
-				'menu_title'  => __( '<%= nameNoAirfleet.title %>', '<%= name.slug %>' ),
-				'parent_slug' => 'airfleet-settings',
-			)
-		);
-	}
-  <% } _%>
-}