Merge branch 'develop' into feature/release-automation

Author: gabriel-detassigny

.eslintignore

@@ -0,0 +1,37 @@
+name: Build Docs
+
+on:
+  push:
+    branches:
+      - master
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  hookdocs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build docs
+        run: npm run build:docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs

.eslintrc.json

@@ -61,3 +61,6 @@ package/dist
 
 # PHPStan result cache
 /.phpstan-cache/
+
+# Generated docs (published to gh-pages by workflow)
+/docs/

.github/workflows/build-docs.yml

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="utf-8">
+	<title><?js= title ?> - Cloudinary Docs</title>
+
+	<script src="scripts/prettify/prettify.js"></script>
+	<script src="scripts/prettify/lang-css.js"></script>
+	<!--[if lt IE 9]>
+	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+	<![endif]-->
+	<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+	<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+
+	<link
+			href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans:300,400|Playfair+Display:900&display=swap"
+			rel="stylesheet">
+</head>
+
+<body>
+
+<div id="main">
+
+	<?js if (title !== 'Home') { ?>
+	<h1 class="page-title"><?js= title ?></h1>
+	<?js } ?>
+
+	<?js= content ?>
+</div>
+
+<nav>
+	<?js= this.nav ?>
+</nav>
+
+<br class="clear">
+
+<footer>
+	<a href="https://cloudinary.com/" target="_blank" rel="noopener noreferrer">Cloudinary</a> |
+	<a href="https://github.com/cloudinary/cloudinary_wordpress/" target="_blank" rel="noopener noreferrer">Cloudinary
+		on GitHub</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>

.gitignore

@@ -0,0 +1,74 @@
+const globals = require( 'globals' );
+const wpPlugin = require( '@wordpress/eslint-plugin' );
+
+// eslint-import-resolver-typescript v4+ is incompatible with eslint-plugin-import
+// (throws "invalid interface loaded as resolver"), and this project has no TypeScript
+// anyway, so strip the typescript resolver that @wordpress/eslint-plugin configures.
+const recommended = wpPlugin.configs.recommended.map( ( config ) => {
+	if ( ! config.settings || ! config.settings[ 'import/resolver' ] ) {
+		return config;
+	}
+	const { typescript, ...resolver } = config.settings[ 'import/resolver' ];
+	return {
+		...config,
+		settings: {
+			...config.settings,
+			'import/resolver': resolver,
+		},
+	};
+} );
+
+module.exports = [
+	{
+		ignores: [
+			'**/build/**',
+			'**/built/**',
+			'**/node_modules/**',
+			'**/vendor/**',
+			'js/**',
+			'**/*.min.js',
+			// Vendored third-party library (https://github.com/kallookoo/wp-color-picker-alpha).
+			'src/js/wp-color-picker-alpha.js',
+		],
+	},
+	...recommended,
+	{
+		settings: {
+			'import/resolver': {
+				node: true,
+			},
+		},
+		languageOptions: {
+			globals: {
+				...globals.browser,
+				cloudinary: 'readonly',
+				jQuery: 'readonly',
+				$: 'readonly',
+				CLDN: 'readonly',
+				CLDLB: 'readonly',
+				CLD_GLOBAL_TRANSFORMATIONS: 'readonly',
+				samplePlayer: 'readonly',
+				CLDCACHE: 'readonly',
+				cldData: 'readonly',
+				CLD_METADATA: 'readonly',
+				CLDASSETS: 'readonly',
+			},
+		},
+		rules: {
+			'no-alert': 'off',
+			'no-console': 'off',
+			'no-unused-vars': 'off',
+			'no-nested-ternary': 'off',
+			'jsx-a11y/click-events-have-key-events': 'off',
+			'react-hooks/rules-of-hooks': 'error',
+			'react-hooks/exhaustive-deps': 'warn',
+			'@wordpress/no-global-event-listener': 'off',
+			// CLD_Deactivate is a wp_localize_script object name (php/class-deactivation.php);
+			// renaming it would require a matching PHP-side change.
+			camelcase: [
+				'error',
+				{ properties: 'never', allow: [ '^CLD_Deactivate$' ] },
+			],
+		},
+	},
+];

.hookdoc/layout.tmpl

@@ -0,0 +1,19 @@
+{
+  "opts": {
+    "destination": "docs",
+    "template": "node_modules/wp-hookdoc/template",
+    "recurse": true,
+    "readme": "./README.md"
+  },
+  "source": {
+    "includePattern": ".+\\.(php|inc)?$"
+  },
+  "plugins": [
+    "node_modules/wp-hookdoc/plugin"
+  ],
+  "templates": {
+    "default": {
+      "layoutFile": ".hookdoc/layout.tmpl"
+    }
+  }
+}