@airfleet/generator-init 0.30.0 → 0.31.0

package/generators/project-plugin/templates/.vscode/airfleet.code-snippets.ejs

@@ -0,0 +1,186 @@
+{
+  "Airfleet Feature": {
+    "scope": "php,html",
+    "prefix": "affeat",
+    "body": [
+      "<?php",
+      "",
+      "namespace Airfleet\\Plugins\\<%= nameNoAirfleet.pascal %>\\\\${TM_DIRECTORY/^.+[\\/\\\\]+(.*)$/$1/};",
+      "",
+      "use Airfleet\\Plugins\\<%= nameNoAirfleet.pascal %>\\Vendor\\Airfleet\\Framework\\Features\\BasePluginFeature;",
+      "",
+      "class $TM_FILENAME_BASE extends BasePluginFeature {",
+      "	public function initialize(): void {",
+      "		$0",
+      "	}",
+      "}",
+      ""
+    ],
+    "description": "Create a new plugin feature"
+  },
+  "Airfleet View Controller": {
+    "scope": "php,html",
+    "prefix": "afctrl",
+    "body": [
+      "<?php",
+      "",
+      "namespace Airfleet\\Plugins\\<%= nameNoAirfleet.pascal %>\\Views\\\\${1|Components,Blocks,Partials,Templates,CustomTemplates|}\\\\${TM_FILENAME_BASE/(.+)Controller/$1/};",
+      "",
+      "use Airfleet\\Plugins\\Views\\View\\ViewController;",
+      "",
+      "class $TM_FILENAME_BASE extends ViewController {",
+      "	$2",
+      "}",
+      ""
+    ],
+    "description": "Create a new view controller"
+  },
+  "Airfleet View Setup": {
+    "scope": "php,html",
+    "prefix": "afsetup",
+    "body": [
+      "<?php",
+      "",
+      "namespace Airfleet\\Plugins\\<%= nameNoAirfleet.pascal %>\\Views\\\\${1|Components,Blocks,Partials,Templates,CustomTemplates|}\\\\${TM_FILENAME_BASE/(.+)Setup/$1/};",
+      "",
+      "use Airfleet\\Plugins\\Views\\View\\ViewSetup;",
+      "",
+      "class $TM_FILENAME_BASE extends ViewSetup {",
+      "	public function initialize(): void {",
+      "		$2",
+      "	}",
+      "}",
+      ""
+    ],
+    "description": "Create a new view setup file"
+  },
+  "Airfleet Script": {
+    "scope": "javascript",
+    "prefix": "afjs",
+    "body": [
+      "export class ${TM_FILENAME_BASE/([^.]*)(\\..+)*$/${1:/pascalcase}/} {",
+      "  initialize() {",
+      "    const { domReady } = window._airfleet.elements.core;",
+      "",
+      "    domReady(() => {",
+      "      $1",
+      "    });",
+      "  }",
+      "}",
+      "",
+      "new ${TM_FILENAME_BASE/([^.]*)(\\..+)*$/${1:/pascalcase}/}().initialize();",
+      ""
+    ],
+    "description": "Create a view script"
+  },
+  "Airfleet Stylesheet": {
+    "scope": "scss,css,postcss",
+    "prefix": "afcss",
+    "body": [
+      ".${1|afc,afb,afp,aft|}-${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/} {",
+      "  $2",
+      "}",
+      ""
+    ],
+    "description": "Create a view stylesheet"
+  },
+  "Airfleet Block Meta": {
+    "scope": "json",
+    "prefix": "afblockmeta",
+    "body": [
+      "{",
+      "  \"$schema\": \"https://advancedcustomfields.com/schemas/json/main/block.json\",",
+      "  \"name\": \"${1|airfleet/,airfleet/elements-|}${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}\",",
+      "  \"title\": \"$2${TM_FILENAME_BASE/([^\\.]*)(\\.block)?$/${1:/capitalize}/}\",",
+      "  \"description\": \"$3\",",
+      "  \"keywords\": [\"airfleet\", \"${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}\"$4]",
+      "  \"supports\": { \"anchor\": true }",
+      "}",
+      ""
+    ],
+    "description": "Create a JSON meta file for a block"
+  },
+  "Airfleet Pattern Meta": {
+    "scope": "json",
+    "prefix": "afpatternmeta",
+    "body": [
+      "{",
+      "  \"name\": \"${1|airfleet/pattern-|}${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}\",",
+      "  \"title\": \"$2${TM_FILENAME_BASE/([^\\.]*)(\\.block)?$/${1:/capitalize}/}\",",
+      "  \"description\": \"$3\",",
+      "  \"keywords\": [\"airfleet\", \"pattern\", \"${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}\"$4]",
+      "}",
+      ""
+    ],
+    "description": "Create a JSON meta file for a pattern"
+  },
+  "Airfleet Block Template (PHP)": {
+    "scope": "php,html",
+    "prefix": "afblockphp",
+    "body": [
+      "<section <?php echo \\$_all_attrs( [ 'class' => 'afb-$TM_FILENAME_BASE' ] ); ?>>",
+      "  $1",
+      "</section>",
+      ""
+    ],
+    "description": "Bootstrap a PHP template for a block"
+  },
+  "Airfleet Block Template (Blade)": {
+    "scope": "blade",
+    "prefix": "afblock",
+    "body": [
+      "<section @all_attrs( [ 'class' => 'afb-${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}' ] )>",
+      "  $1",
+      "</section>",
+      ""
+    ],
+    "description": "Bootstrap a Blade template for a block"
+  },
+  "Airfleet Component Template (PHP)": {
+    "scope": "php,html",
+    "prefix": "afcompphp",
+    "body": [
+      "<div <?php echo \\$_all_attrs( [ 'class' => 'afc-$TM_FILENAME_BASE' ] ); ?>>",
+      "  $1",
+      "  <?php echo \\$_slot; ?>",
+      "</div>",
+      ""
+    ],
+    "description": "Bootstrap a PHP template for a component"
+  },
+  "Airfleet Component Template (Blade)": {
+    "scope": "blade",
+    "prefix": "afcomp",
+    "body": [
+      "<div @all_attrs( [ 'class' => 'afc-${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}' ] )>",
+      "  $1",
+      "  {!! \\$_slot !!}",
+      "</div>",
+      ""
+    ],
+    "description": "Bootstrap a Blade template for a component"
+  },
+  "Airfleet Partial Template (PHP)": {
+    "scope": "php,html",
+    "prefix": "afpartialphp",
+    "body": [
+      "<div <?php echo \\$_all_attrs( [ 'class' => 'afp-$TM_FILENAME_BASE' ] ); ?>>",
+      "  $1",
+      "  <?php echo \\$_slot; ?>",
+      "</div>",
+      ""
+    ],
+    "description": "Bootstrap a PHP template for a partial"
+  },
+  "Airfleet Partial Template (Blade)": {
+    "prefix": "afpartial",
+    "body": [
+      "<div @all_attrs( [ 'class' => 'afp-${TM_FILENAME_BASE/([^.]*)(\\..+)*$/$1/}' ] )>",
+      "  $1",
+      "  {!! \\$_slot !!}",
+      "</div>",
+      ""
+    ],
+    "description": "Bootstrap a Blade template for a partial"
+  }
+}

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

@@ -0,0 +1,33 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit",
+    "source.fixAll.eslint": "explicit"
+  },
+  "editor.formatOnSave": true,
+  "stylelint.validate": ["css", "scss", "postcss"],
+  "phpSniffer.autoDetect": true,
+  "[php]": {
+    "editor.defaultFormatter": "wongjn.php-sniffer"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[postcss]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[scss]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[css]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

package/generators/project-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/project-plugin/templates/LICENSE.ejs

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

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

@@ -0,0 +1,16 @@
+# <%= name.title %> WordPress Plugin
+
+[![🧪 Test](<%= repositoryBase %>/actions/workflows/test-wordpress.yml/badge.svg)](<%= repositoryBase %>/actions/workflows/test-wordpress.yml)
+
+<%= answers.pluginDescription %>
+
+## Getting Started
+
+```bash
+composer install
+npm install
+```
+
+## License
+
+© [Airfleet](https://www.airfleet.co/)

package/generators/project-plugin/templates/acf-json/option-pages/airfleet-site-settings.json

@@ -0,0 +1,22 @@
+{
+    "key": "ui_options_page_659577aa68c5c",
+    "title": "Airfleet Site Settings",
+    "active": true,
+    "menu_order": 0,
+    "page_title": "Airfleet Site Settings",
+    "menu_slug": "airfleet-site-settings",
+    "parent_slug": "options-general.php",
+    "advanced_configuration": 1,
+    "icon_url": "",
+    "menu_title": "Site Settings",
+    "position": "",
+    "redirect": false,
+    "description": "",
+    "update_button": "Update",
+    "updated_message": "Options Updated",
+    "capability": "edit_posts",
+    "data_storage": "options",
+    "post_id": "",
+    "autoload": 0,
+    "modified": 1704294791
+}

package/generators/project-plugin/templates/assets/admin/styles/admin.entry.scss

@@ -0,0 +1,2 @@
+@import '../../shared/styles/root';
+@import '../../shared/styles/shared';

package/generators/project-plugin/templates/assets/editor/styles/editor.entry.scss

@@ -0,0 +1,23 @@
+@import '../../shared/styles/lib';
+@import '../../frontend/styles/root';
+@import '../../frontend/styles/placeholders';
+
+@mixin fix-editor-conflicts {
+  p {
+    // Reset font size and line-height for paragraphs
+    // (something else is setting it in backend)
+    font-size: inherit;
+    line-height: inherit;
+  }
+}
+
+:where(.acf-block-preview) {
+  /* stylelint-disable-next-line no-invalid-position-at-import-rule */
+  @import '../../frontend/styles/main';
+
+  // ! Theme body
+  @include theme-body-styles();
+
+  // ! Editor overrides
+  @include fix-editor-conflicts();
+}

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

@@ -0,0 +1,3 @@
+if (module.hot) {
+  module.hot.accept();
+}

package/generators/project-plugin/templates/assets/frontend/styles/_main.scss

@@ -0,0 +1,3 @@
+// ! Import main styles
+@import 'main/reset';
+@import 'main/body';

package/generators/project-plugin/templates/assets/frontend/styles/_placeholders.scss

@@ -0,0 +1,3 @@
+@import 'placeholders/sections';
+@import 'placeholders/button';
+@import 'placeholders/container';

package/generators/project-plugin/templates/assets/frontend/styles/_root.scss

@@ -0,0 +1,4 @@
+// ! Imports that should be at the root/top of the styles
+// ! These cannot be scoped under other selectors
+@import 'root/fonts';
+@import '../../shared/styles/root';

package/generators/project-plugin/templates/assets/frontend/styles/critical.entry.scss

@@ -0,0 +1 @@
+@import '../../shared/styles/lib';

package/generators/project-plugin/templates/assets/frontend/styles/index.entry.scss

@@ -0,0 +1,6 @@
+// ! For variables and mixins, check the shared lib folder
+@import '../../shared/styles/lib';
+@import 'root';
+@import '../../shared/styles/shared';
+@import 'main';
+@import 'placeholders';

package/generators/project-plugin/templates/assets/frontend/styles/main/_body.scss

@@ -0,0 +1,6 @@
+@import '../../../shared/styles/lib';
+
+body {
+  // ! Update the styles inside the mixin instead of adding them here! This will ensure editor previews look consistent.
+  @include theme-body-styles();
+}

package/generators/project-plugin/templates/assets/frontend/styles/main/_reset.scss

@@ -0,0 +1,121 @@
+// ! This file is for global resets that are independent of project
+@import '../../../shared/styles/lib';
+
+* {
+  margin: 0;
+}
+
+*,
+*::before,
+*::after {
+  box-sizing: border-box;
+}
+
+body {
+  /* stylelint-disable-next-line plugin/no-unsupported-browser-features */
+  text-size-adjust: 100%;
+  -webkit-tap-highlight-color: transparent;
+  -webkit-font-smoothing: antialiased;
+  min-height: 100vh;
+  line-height: 1.4;
+}
+
+ul[role='list'],
+ol[role='list'] {
+  list-style: none;
+}
+
+:where(h1, h2, h3, h4, button, input, label) {
+  line-height: 1.1;
+}
+
+p,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  overflow-wrap: break-word;
+}
+
+p {
+  text-wrap: pretty;
+}
+
+a:not([class]) {
+  text-decoration-skip-ink: auto;
+  color: currentcolor;
+}
+
+video,
+canvas,
+svg,
+img,
+picture {
+  max-width: 100%;
+  display: block;
+}
+
+img {
+  height: auto;
+}
+
+input,
+button,
+textarea,
+select {
+  font-family: inherit;
+  font-size: inherit;
+}
+
+textarea {
+  /* stylelint-disable-next-line plugin/no-unsupported-browser-features */
+  resize: vertical;
+
+  &:not([rows]) {
+    min-height: 10em;
+  }
+}
+
+fieldset {
+  min-width: 0;
+  padding: 0;
+  border: 0;
+}
+
+b,
+strong {
+  font-weight: bolder;
+}
+
+table {
+  caption-side: bottom;
+  border-collapse: collapse;
+}
+
+iframe {
+  border: 0;
+}
+
+label {
+  display: inline-block;
+}
+
+[type='search'] {
+  appearance: textfield;
+  outline-offset: -2px;
+}
+
+[hidden] {
+  display: none;
+}
+
+:target {
+  scroll-margin-block: 5ex;
+}
+
+::placeholder {
+  color: inherit;
+  opacity: 1;
+}

package/generators/project-plugin/templates/assets/frontend/styles/placeholders/_button.scss

@@ -0,0 +1,43 @@
+:root {
+  // Default
+  --afs-button-font-size: 1rem;
+  --afs-button-padding-x: 16px;
+  --afs-button-padding-y: 6px;
+  --afs-button-border-width: 1px;
+  --afs-button-border-style: solid;
+  --afs-button-border-color: #ccc;
+  --afs-button-border-color-hover: #3a3a3a;
+  --afs-button-border-radius: 4px;
+  --afs-button-text-color: #000;
+  --afs-button-text-color-hover: #fff;
+  --afs-button-background: #fff;
+  --afs-button-background-hover: #3a3a3a;
+
+  // Primary
+  --afs-button-primary-font-size: var(--afs-button-font-size);
+  --afs-button-primary-padding-x: var(--afs-button-padding-x);
+  --afs-button-primary-padding-y: var(--afs-button-padding-y);
+  --afs-button-primary-border-width: var(--afs-button-border-width);
+  --afs-button-primary-border-style: var(--afs-button-border-style);
+  --afs-button-primary-border-radius: var(--afs-button-border-radius);
+  --afs-button-primary-border-color: #a9b1b2;
+  --afs-button-primary-border-color-hover: #ccc;
+  --afs-button-primary-text-color: #000;
+  --afs-button-primary-text-color-hover: #000;
+  --afs-button-primary-background: #fff;
+  --afs-button-primary-background-hover: #ccc;
+
+  // Secondary
+  --afs-button-secondary-font-size: var(--afs-button-font-size);
+  --afs-button-secondary-padding-x: var(--afs-button-padding-x);
+  --afs-button-secondary-padding-y: var(--afs-button-padding-y);
+  --afs-button-secondary-border-width: var(--afs-button-border-width);
+  --afs-button-secondary-border-style: var(--afs-button-border-style);
+  --afs-button-secondary-border-radius: var(--afs-button-border-radius);
+  --afs-button-secondary-border-color: #30387d;
+  --afs-button-secondary-border-color-hover: #ccc;
+  --afs-button-secondary-text-color: #000;
+  --afs-button-secondary-text-color-hover: #000;
+  --afs-button-secondary-background: #fff;
+  --afs-button-secondary-background-hover: #ccc;
+}

package/generators/project-plugin/templates/assets/frontend/styles/placeholders/_container.scss

@@ -0,0 +1,12 @@
+:root {
+  --afs-container-max-width: 1200px;
+  --afs-container-padding-x: 40px;
+}
+
+.container {
+  margin-inline: auto;
+  max-width: calc(
+    var(--afs-container-max-width) + var(--afs-container-padding-x)
+  );
+  padding-inline: calc(var(--afs-container-padding-x) * 0.5);
+}

package/generators/project-plugin/templates/assets/frontend/styles/placeholders/_sections.scss

@@ -0,0 +1,6 @@
+[style*='wp-block-airfleet-elements'],
+section {
+  &:nth-child(odd) {
+    background-color: var(--afa-color-neutral-150);
+  }
+}

package/generators/project-plugin/templates/assets/frontend/styles/root/_fonts.scss

@@ -0,0 +1,21 @@
+@import '../../../shared/styles/lib';
+
+// Declare font-faces here.
+// Use https://transfonter.org/ to convert fonts to other formats.
+
+// ! Instead of hard-coding the font path, use the variable below like this:
+// url($font-src + 'FontName.woff')
+
+$font-src: '/assets/frontend/fonts';
+
+// ! EXAMPLE
+// @font-face {
+//   font-family: 'Roboto Condensed';
+//   src: local('Roboto Condensed Italic'), local('RobotoCondensed-Italic'),
+//     url($font-src + '/RobotoCondensed-Italic.woff2') format('woff2'),
+//     url($font-src + '/RobotoCondensed-Italic.woff') format('woff'),
+//     url($font-src + '/RobotoCondensed-Italic.ttf') format('truetype');
+//   font-weight: normal;
+//   font-style: italic;
+//   font-display: swap;
+// }

package/generators/project-plugin/templates/assets/shared/styles/_figma-variables.scss

@@ -0,0 +1,7 @@
+/**
+ * * Generated by @airfleet/figma-bridge
+ * * !!! Do not edit directly
+ */
+
+:root {
+}

package/generators/project-plugin/templates/assets/shared/styles/_lib.scss

@@ -0,0 +1,4 @@
+// ! Import here all the variables, mixins, functions
+// ! i.e. everything that does not output CSS by default
+@import 'lib/scss-variables';
+@import 'lib/mixins';

package/generators/project-plugin/templates/assets/shared/styles/_root.scss

@@ -0,0 +1,6 @@
+@import 'lib';
+@import 'figma-variables';
+
+:root {
+  // Add root styles here
+}

package/generators/project-plugin/templates/assets/shared/styles/_shared.scss

@@ -0,0 +1 @@
+// Add shared styles here

package/generators/project-plugin/templates/assets/shared/styles/lib/_mixins.scss

@@ -0,0 +1,6 @@
+@import 'mixins/body';
+@import 'mixins/breakpoints';
+@import 'mixins/list-inline';
+@import 'mixins/position';
+@import 'mixins/background';
+@import 'mixins/helpers';

package/generators/project-plugin/templates/assets/shared/styles/lib/_scss-variables.scss

@@ -0,0 +1,2 @@
+// ? Add variables here
+// ! Do not add CSS variables here, only SCSS. Add CSS variables in `_root.scss`

package/generators/project-plugin/templates/assets/shared/styles/lib/mixins/_background.scss

@@ -0,0 +1,11 @@
+/**
+ *
+ * Background
+ *
+ */
+
+@mixin background($size: cover, $position: center, $repeat: no-repeat) {
+  background-position: $position;
+  background-repeat: $repeat;
+  background-size: $size;
+}

package/generators/project-plugin/templates/assets/shared/styles/lib/mixins/_body.scss

@@ -0,0 +1,4 @@
+// ! Body styles. The reason we do a separate mixin is to help us override styles in the block editor
+@mixin theme-body-styles {
+  // Add styles here
+}