From 3fd95a5dc89618f19e945bfebcd10e855ebeb43e Mon Sep 17 00:00:00 2001 From: Brian Hogg Date: Tue, 9 Dec 2025 06:50:04 -0500 Subject: [PATCH 01/21] WIP: Initial commit of generated divi extension --- includes/divi/extension/.gitignore | 29 + includes/divi/extension/README.md | 667 + .../divi/extension/includes/MyExtension.php | 46 + .../extension/includes/fields/Input/Input.jsx | 35 + .../extension/includes/fields/Input/style.css | 42 + .../divi/extension/includes/fields/index.js | 3 + includes/divi/extension/includes/loader.js | 11 + includes/divi/extension/includes/loader.php | 14 + .../modules/HelloWorld/HelloWorld.jsx | 23 + .../modules/HelloWorld/HelloWorld.php | 35 + .../includes/modules/HelloWorld/style.css | 3 + .../divi/extension/includes/modules/index.js | 3 + includes/divi/extension/languages/.gitignore | 0 includes/divi/extension/my-extension.php | 39 + includes/divi/extension/package.json | 33 + includes/divi/extension/scripts/frontend.js | 3 + includes/divi/extension/styles/.gitignore | 0 includes/divi/extension/yarn.lock | 13236 ++++++++++++++++ 18 files changed, 14222 insertions(+) create mode 100644 includes/divi/extension/.gitignore create mode 100644 includes/divi/extension/README.md create mode 100644 includes/divi/extension/includes/MyExtension.php create mode 100644 includes/divi/extension/includes/fields/Input/Input.jsx create mode 100644 includes/divi/extension/includes/fields/Input/style.css create mode 100644 includes/divi/extension/includes/fields/index.js create mode 100644 includes/divi/extension/includes/loader.js create mode 100644 includes/divi/extension/includes/loader.php create mode 100644 includes/divi/extension/includes/modules/HelloWorld/HelloWorld.jsx create mode 100644 includes/divi/extension/includes/modules/HelloWorld/HelloWorld.php create mode 100644 includes/divi/extension/includes/modules/HelloWorld/style.css create mode 100644 includes/divi/extension/includes/modules/index.js create mode 100644 includes/divi/extension/languages/.gitignore create mode 100644 includes/divi/extension/my-extension.php create mode 100644 includes/divi/extension/package.json create mode 100644 includes/divi/extension/scripts/frontend.js create mode 100644 includes/divi/extension/styles/.gitignore create mode 100644 includes/divi/extension/yarn.lock diff --git a/includes/divi/extension/.gitignore b/includes/divi/extension/.gitignore new file mode 100644 index 0000000000..57f06a63de --- /dev/null +++ b/includes/divi/extension/.gitignore @@ -0,0 +1,29 @@ +# See https://help.github.com/ignore-files/ for more about ignoring files. + +# dependencies +/node_modules + +# testing +/coverage + +# production +#/scripts/bundle.min.js +#/scripts/builder-bundle.min.js +#/scripts/frontend-bundle.min.js +#/styles/bundle.min.css +#/styles/backend-style.min.css +#/styles/style-dbp.min.css +#/styles/style.min.css +#asset-manifest.json +#*.map + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/includes/divi/extension/README.md b/includes/divi/extension/README.md new file mode 100644 index 0000000000..1dd09511d8 --- /dev/null +++ b/includes/divi/extension/README.md @@ -0,0 +1,667 @@ +This project was bootstrapped with [Create Divi Extension](https://github.com/elegantthemes/create-divi-extension). + +Below you will find some information on how to perform common tasks. You can find the most recent version of this guide [here](https://github.com/elegantthemes/create-divi-extension/blob/master/packages/divi-scripts/template/README.md). + +## Table of Contents + +- [Updating to New Releases](#updating-to-new-releases) +- [Sending Feedback](#sending-feedback) +- [Folder Structure](#folder-structure) +- [Available Scripts](#available-scripts) + - [yarn start](#yarn-start) + - [yarn build](#yarn-build) + - [yarn zip](#yarn-zip) + - [yarn eject](#yarn-eject) +- [Supported Browsers](#supported-browsers) +- [Supported Language Features and Polyfills](#supported-language-features-and-polyfills) +- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor) +- [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor) +- [Debugging in the Editor](#debugging-in-the-editor) +- [Formatting Code Automatically](#formatting-code-automatically) +- [Installing a Dependency](#installing-a-dependency) +- [Importing a Component](#importing-a-component) +- [Adding a Stylesheet](#adding-a-stylesheet) +- [Post-Processing CSS](#post-processing-css) +- [Adding Flow](#adding-flow) +- [Adding Custom Environment Variables](#adding-custom-environment-variables) + - [Referencing Environment Variables in the HTML](#referencing-environment-variables-in-the-html) + - [Adding Temporary Environment Variables In Your Shell](#adding-temporary-environment-variables-in-your-shell) + - [Adding Development Environment Variables In `.env`](#adding-development-environment-variables-in-env) +- [Can I Use Decorators?](#can-i-use-decorators) +- [Fetching Data with AJAX Requests](#fetching-data-with-ajax-requests) +- [Advanced Configuration](#advanced-configuration) +- [Troubleshooting](#troubleshooting) + - [`yarn start` doesn’t detect changes](#npm-start-doesnt-detect-changes) + - [`yarn test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra) + - [`yarn build` exits too early](#npm-run-build-exits-too-early) + - [`yarn build` fails to minify](#npm-run-build-fails-to-minify) + - [Moment.js locales are missing](#momentjs-locales-are-missing) +- [Alternatives to Ejecting](#alternatives-to-ejecting) +- [Something Missing?](#something-missing) + +## Updating to New Releases + +Create Divi Extension is divided into two packages: + +* `create-divi-extension` is a global command-line utility that you use to create new projects. +* `divi-scripts` is a development dependency in the generated projects (including this one). + +You almost never need to update `create-divi-extension` itself: it delegates all the setup to `divi-scripts`. + +When you run `create-divi-extension`, it always creates the project with the latest version of `divi-scripts` so you’ll get all the new features and improvements in newly created extensions automatically. + +To update an existing project to a new version of `divi-scripts`, [open the changelog](https://github.com/elegantthemes/create-divi-extension/blob/master/CHANGELOG.md), find the version you’re currently on (check `package.json` in this folder if you’re not sure), and apply the migration instructions for the newer versions. + +In most cases bumping the `divi-scripts` version in `package.json` and running `npm install` in this folder should be enough, but it’s good to consult the [changelog](https://github.com/elegantthemes/create-divi-extension/blob/master/CHANGELOG.md) for potential breaking changes. + +We commit to keeping the breaking changes minimal so you can upgrade `divi-scripts` painlessly. + +## Sending Feedback + +We are always open to [your feedback](https://github.com/elegantthemes/create-divi-extension/issues). + +## Folder Structure + +After creation, your project should look like this: + +``` +my-extension +├── includes +│   ├── modules +│   │   └── HelloWorld +│   │   ├── HelloWorld.jsx +│   │   ├── HelloWorld.php +│   │   └── style.css +│   ├── loader.js +│   ├── loader.php +│   └── MyExtension.php +├── languages +├── node_modules +├── scripts +│   └── frontend.js +├── styles +├── my-extension.php +├── package.json +└── README.md +``` + +For the project to build, **these files must exist with exact filenames**: + +* `includes/loader.js` is the JavaScript entry point. + +You need to **put any JS and CSS files inside `includes`, `scripts`, and/or `styles`**, otherwise Webpack won’t see them. + +## Available Scripts + +In the project directory, you can run: + +### `yarn start` + +Builds the extension in the development mode. Open your WordPress site to view it in the browser. The page will reload if you make edits to JavaScript files. You will also see any lint errors in the console. + +Note that `yarn start` will enable debug mode as well. However, you may encounter an issue where it doesn't work that way and causes your custom module not loaded properly. To fix it, you can enable it manually by adding `define( 'PREFIX_DEBUG', true );` on your `wp-config.php` file. Just replace `PREFIX` with your extension prefix. + +### `yarn build` + +Builds the extension for production to the `build` folder. It correctly optimizes the build for the best performance. + +### `yarn zip` + +Runs `build` and then creates a production release zip file. + +### `yarn eject` + +**Note: this is a one-way operation. Once you `eject`, you can’t go back!** + +If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. + +Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. + +You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. + +## Supported Browsers + +By default, the generated project uses the latest version of React. + +You can refer [to the React documentation](https://reactjs.org/docs/react-dom.html#browser-support) for more information about supported browsers. + +## Supported Language Features and Polyfills + +This project supports a superset of the latest JavaScript standard.
+In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports: + +* [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016) +* [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017) +* [Object Rest/Spread Properties](https://github.com/tc39/proposal-object-rest-spread) (ES2018) +* [Dynamic import()](https://github.com/tc39/proposal-dynamic-import) (stage 3 proposal) +* [Class Fields and Static Properties](https://github.com/tc39/proposal-class-public-fields) (stage 3 proposal) +* [JSX](https://facebook.github.io/react/docs/introducing-jsx.html) syntax +* [Flow](https://flowtype.org/) syntax + +Learn more about [different proposal stages](https://babeljs.io/docs/plugins/#presets-stage-x-experimental-presets-). + +While we recommend using experimental proposals with some caution, Facebook heavily uses these features in the product code, so they intend to provide [codemods](https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb) if any of these proposals change in the future. + +Note that **the project only includes a few ES6 [polyfills](https://en.wikipedia.org/wiki/Polyfill)**: + +* [`Object.assign()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) via [`object-assign`](https://github.com/sindresorhus/object-assign). +* [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) via [`promise`](https://github.com/then/promise). +* [`fetch()`](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) via [`whatwg-fetch`](https://github.com/github/fetch). + +If you use any other ES6+ features that need **runtime support** (such as `Array.from()` or `Symbol`), make sure you are including the appropriate polyfills manually, or that the browsers you are targeting already support them. + +Also note that using some newer syntax features like `for...of` or `[...nonArrayValue]` causes Babel to emit code that depends on ES6 runtime features and might not work without a polyfill. When in doubt, use [Babel REPL](https://babeljs.io/repl/) to see what any specific syntax compiles down to. + +## Syntax Highlighting in the Editor + +To configure the syntax highlighting in your favorite text editor, head to the [relevant Babel documentation page](https://babeljs.io/docs/editors) and follow the instructions. Some of the most popular editors are covered. + +## Displaying Lint Output in the Editor + +Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint. + +They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do. + +You would need to install an ESLint plugin for your editor first. Then, add a file called `.eslintrc` to the project root: + +```js +{ + "extends": "divi-extension" +} +``` + +Now your editor should report the linting warnings. + +Note that even if you edit your `.eslintrc` file further, these changes will **only affect the editor integration**. They won’t affect the terminal and in-browser lint output. This is because Create Divi Extension intentionally provides a minimal set of rules that find common mistakes. + +If you want to enforce a coding style for your project, consider using [Prettier](https://github.com/jlongster/prettier) instead of ESLint style rules. + +## Debugging in the Editor + +**This feature is currently only supported by [Visual Studio Code](https://code.visualstudio.com) and [WebStorm](https://www.jetbrains.com/webstorm/).** + +Visual Studio Code and WebStorm support debugging out of the box with Create Divi Extension. This enables you as a developer to write and debug your React code without leaving the editor, and most importantly it enables you to have a continuous development workflow, where context switching is minimal, as you don’t have to switch between tools. + +### Visual Studio Code + +You would need to have the latest version of [VS Code](https://code.visualstudio.com) and VS Code [Chrome Debugger Extension](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) installed. + +Then add the block below to your `launch.json` file and put it inside the `.vscode` folder in your app’s root directory. + +```json +{ + "version": "0.2.0", + "configurations": [{ + "name": "Chrome", + "type": "chrome", + "request": "launch", + "url": "http://localhost:3000", + "webRoot": "${workspaceRoot}/src", + "sourceMapPathOverrides": { + "webpack:///src/*": "${webRoot}/*" + } + }] +} +``` +>Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration). + +Start your extension by running `yarn start`, and start debugging in VS Code by pressing `F5` or by clicking the green debug icon. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor. + +Having problems with VS Code Debugging? Please see their [troubleshooting guide](https://github.com/Microsoft/vscode-chrome-debug/blob/master/README.md#troubleshooting). + +### WebStorm + +You would need to have [WebStorm](https://www.jetbrains.com/webstorm/) and [JetBrains IDE Support](https://chrome.google.com/webstore/detail/jetbrains-ide-support/hmhgeddbohgjknpmjagkdomcpobmllji) Chrome extension installed. + +In the WebStorm menu `Run` select `Edit Configurations...`. Then click `+` and select `JavaScript Debug`. Paste `http://localhost:3000` into the URL field and save the configuration. + +>Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration). + +Start your app by running `yarn start`, then press `^D` on macOS or `F9` on Windows and Linux or click the green debug icon to start debugging in WebStorm. + +You can debug your application in IntelliJ IDEA Ultimate, PhpStorm, PyCharm Pro, and RubyMine the same way. + +## Formatting Code Automatically + +Prettier is an opinionated code formatter with support for JavaScript, CSS and JSON. With Prettier you can format the code you write automatically to ensure a code style within your project. See the [Prettier's GitHub page](https://github.com/prettier/prettier) for more information, and look at this [page to see it in action](https://prettier.github.io/prettier/). + +To format our code whenever we make a commit in git, we need to install the following dependencies: + +```sh +npm install --save husky lint-staged prettier +``` + +Alternatively you may use `yarn`: + +```sh +yarn add husky lint-staged prettier +``` + +* `husky` makes it easy to use githooks as if they are npm scripts. +* `lint-staged` allows us to run scripts on staged files in git. See this [blog post about lint-staged to learn more about it](https://medium.com/@okonetchnikov/make-linting-great-again-f3890e1ad6b8). +* `prettier` is the JavaScript formatter we will run before commits. + +Now we can make sure every file is formatted correctly by adding a few lines to the `package.json` in the project root. + +Add the following line to `scripts` section: + +```diff + "scripts": { ++ "precommit": "lint-staged", + "start": "react-scripts start", + "build": "react-scripts build", +``` + +Next we add a 'lint-staged' field to the `package.json`, for example: + +```diff + "dependencies": { + // ... + }, ++ "lint-staged": { ++ "src/**/*.{js,jsx,json,css}": [ ++ "prettier --single-quote --write", ++ "git add" ++ ] ++ }, + "scripts": { +``` + +Now, whenever you make a commit, Prettier will format the changed files automatically. You can also run `./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx,json,css}"` to format your entire project for the first time. + +Next you might want to integrate Prettier in your favorite editor. Read the section on [Editor Integration](https://prettier.io/docs/en/editors.html) on the Prettier GitHub page. + +## Installing a Dependency + +The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create Divi Extension as a development dependency. You may install other dependencies with `npm`: + +```sh +npm install --save some-other-dependency +``` + +Alternatively you may use `yarn`: + +```sh +yarn add some-other-dependency +``` + +## Importing a Component + +This project setup supports ES6 modules thanks to Webpack.
+While you can still use `require()` and `module.exports`, we encourage you to use [`import` and `export`](http://exploringjs.com/es6/ch_modules.html) instead. + +For example: + +### `Button.js` + +```js +import React, { Component } from 'react'; + +class Button extends Component { + render() { + // ... + } +} + +export default Button; // Don’t forget to use export default! +``` + +### `DangerButton.js` + + +```js +import React, { Component } from 'react'; +import Button from './Button'; // Import a component from another file + +class DangerButton extends Component { + render() { + return