@storepress/create-plugin-html 0.0.6 → 0.1.1

package/plugin-templates/tools/changelog.js.mustache

@@ -1,60 +1,59 @@
 #!/usr/bin/env node
-'use strict'
+"use strict";
 /**
  * External dependencies
  */
-const fs = require('fs-extra')
-const { stdout } = require('process')
+const fs = require("fs");
 
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
+const { getPackageProp, fromProjectRoot } = require("@wordpress/scripts/utils");
 
-const {
-	getPackageProp,
-	fromProjectRoot,
-} = require('@wordpress/scripts/utils')
+// Get Current Version.
+const version = getPackageProp("version");
 
-const version = getPackageProp('version')
+// Get Changelog File.
+const changelogFile = fromProjectRoot("changelog.txt");
 
-const changelogFile = fromProjectRoot('changelog.txt')
+// Read and find the changelog entry for the current version.
+const changelogContent = fs.readFileSync(changelogFile, "utf8");
+const lines = changelogContent.split("\n");
+const changelogEntry = [];
 
-// 2. Read and find the changelog entry for the current version.
-const changelogJs = fs.readFileSync(changelogFile, 'utf8')
-const lines = changelogJs.split('\n')
-const changelogEntry = []
-let inSection = false
-const versionString = `version ${version}`
-const dateRegex = /^\d{4}-\d{2}-\d{2}/
+const commonPattern = `^(?:\\d{4}-\\d{2}-\\d{2}|\\d{2}-\\d{2}-\\d{4})\\s*-\\s*version`;
+const currentPattern = `${commonPattern}\\s*${version}`;
+
+const currentExp = new RegExp(currentPattern, "i");
+
+const sectionExp = new RegExp(commonPattern, "i");
+
+let inSection = false;
 
 for (const line of lines) {
-	if (inSection) {
-		if (dateRegex.test(line) && !line.includes(versionString)) {
-			break
-		}
-		changelogEntry.push(line)
-	} else if (line.includes(versionString)) {
-		inSection = true
-		// continue
-		// changelogEntry.push(line)
-	}
+    // Reach current section.
+    if (currentExp.test(line)) {
+        inSection = true;
+        continue;
+    }
+
+    // We have to stop when we get another section.
+    if (inSection) {
+        if (sectionExp.test(line)) {
+            inSection = false;
+            break;
+        }
+
+        changelogEntry.push(line);
+    }
 }
 
 if (changelogEntry.length === 0) {
-	changelogEntry.push(`- No changelog entry for version ${version}.\n\n`)
+    changelogEntry.push(`- No changelog entry for version ${version}.\n\n`);
 }
 
-// 3. Prepare the final output string
-const finalOutput = changelogEntry.join('\n').trim()
-
-// 4. Check if running in GitHub Actions environment
-/*if (process.env.GITHUB_OUTPUT) {
-	// If yes, write to the GITHUB_OUTPUT file to set an output variable
-	// The format `key<<DELIMITER` is used for multiline strings
-	fs.appendFileSync(process.env.GITHUB_OUTPUT, `changelog_body<<EOF\n${finalOutput}\nEOF\n`)
-} else {
-	stdout.write(`${finalOutput}\n`)
-}*/
+// Prepare the final output string
+const finalOutput = changelogEntry.join("\n").trim();
 
-stdout.write(`## What's Changed\n\n`)
-stdout.write(`${finalOutput}\n`)
+process.stdout.write(`## What's Changed\n\n`);
+process.stdout.write(`${finalOutput}\n`);

package/plugin-templates/tools/package.js.mustache

@@ -3,49 +3,50 @@
 /**
  * External dependencies
  */
-const AdmZip = require('adm-zip');
-const { sync: glob } = require('fast-glob');
-const { dirname } = require('path');
-const { stdout } = require('process');
-const fs = require('fs-extra');
+const AdmZip = require( 'adm-zip' );
+const { sync: glob } = require( 'fast-glob' );
+const { dirname, join } = require( 'path' );
+const { stdout } = require( 'process' );
+const fs = require( 'fs-extra' );
+
 /**
- * Internal dependencies
+ * WordPress dependencies
  */
-
 const {
 	hasPackageProp,
 	getPackageProp,
 	hasArgInCLI,
-} = require('@wordpress/scripts/utils');
+} = require( '@wordpress/scripts/utils' );
 
-const npm_package_name = getPackageProp('name');
-const npm_package_version = getPackageProp('version');
+const packageName = getPackageProp( 'name' );
+const packageVersion = getPackageProp( 'version' );
 
-stdout.write(`Creating package for \`${npm_package_name}\` plugin... 🎁\n\n`);
+stdout.write( `Creating package for \`${ packageName }\` plugin... 🎁\n\n` );
 const zip = new AdmZip();
-const isZip = hasArgInCLI('--zip');
+const isZip = hasArgInCLI( '--zip' );
 
 let files = [];
 
-if (hasPackageProp('zip')) {
+if ( hasPackageProp( 'files' ) ) {
 	stdout.write(
 		'Using the `files` field from `package.json` to detect files:\n\n'
 	);
 
-	files = glob(getPackageProp('zip'), {
+	files = glob( getPackageProp( 'files' ), {
 		caseSensitiveMatch: false,
-	});
+	} );
 } else {
-	stdout.write('Using Plugin Handbook best practices to discover files:\n\n');
+	stdout.write(
+		'Using Plugin Handbook best practices to discover files:\n\n'
+	);
 	// See https://developer.wordpress.org/plugins/plugin-basics/best-practices/#file-organization.
 	files = glob(
 		[
-			'admin/**',
 			'build/**',
 			'includes/**',
 			'languages/**',
-			'public/**',
-			`${npm_package_name}.php`,
+			'templates/**',
+			`${ packageName }.php`,
 			'uninstall.php',
 			'block.json',
 			'changelog.*',
@@ -58,34 +59,41 @@ if (hasPackageProp('zip')) {
 	);
 }
 
-if (isZip) {
+if ( isZip ) {
 	stdout.write(
-		`Creating archive for \`${npm_package_name}\` plugin... 🎁\n\n`
+		`Creating archive for \`${ packageName }\` plugin... 🎁\n\n`
 	);
-	files.forEach((file) => {
-		stdout.write(`  🥳 Adding \`${file}\`.\n`);
-		const zipDirectory = dirname(file);
-		zip.addLocalFile(file, zipDirectory !== '.' ? zipDirectory : '');
-	});
+	files.forEach( ( file ) => {
+		stdout.write( `  🥳 Adding \`${ file }\`.\n` );
+		const zipDirectory = dirname( file );
+		// Prefix every entry with the slug folder
+		const targetDir =
+			zipDirectory !== '.'
+				? join( packageName, zipDirectory )
+				: packageName;
+		zip.addLocalFile( file, targetDir );
+	} );
 
-	zip.writeZip(`./${npm_package_name}.zip`);
-	stdout.write(`\nDone. \`${npm_package_name}.zip\` is ready! 🎉\n`);
+	zip.writeZip( `./${ packageName }-v${ packageVersion }.zip` );
+	stdout.write(
+		`\nDone. \`${ packageName }-v${ packageVersion }.zip\` is ready! 🎉\n`
+	);
 } else {
-	fs.remove(npm_package_name).then(() => {
-		fs.ensureDir(npm_package_name, () => {
+	fs.remove( packageName ).then( () => {
+		fs.ensureDir( packageName, () => {
 			stdout.write(
-				`Creating directory for \`${npm_package_name}\` plugin... 🎁\n\n`
+				`Creating directory for \`${ packageName }\` plugin... 🎁\n\n`
 			);
 
-			files.forEach((file) => {
-				const to = `${npm_package_name}/${file}`;
-				stdout.write(`  🥳 Adding \`${file}\`.\n`);
-				fs.copy(file, to);
-			});
+			files.forEach( ( file ) => {
+				const to = `${ packageName }/${ file }`;
+				stdout.write( `  🥳 Adding \`${ file }\`.\n` );
+				fs.copy( file, to );
+			} );
 
 			stdout.write(
-				`\n\nDone. \`${npm_package_name}\` directory is ready! 🎉\n`
+				`\n\nDone. \`${ packageName }\` directory is ready! 🎉\n`
 			);
-		});
-	});
+		} );
+	} );
 }

package/plugin-templates/tools/packages-install.js.mustache

@@ -23,8 +23,6 @@ function readJSONFile (fileName) {
 }
 
 const EXACT_VERSION_PACKAGES = {
-	'eslint-formatter-pretty':'5.0.0',
-	'eslint-plugin-prettier':'^5.5.4',
 	'prettier':'npm:wp-prettier@3.0.3',
 }
 

package/plugin-templates/tools/webpack-helpers.js.mustache

@@ -19,22 +19,17 @@ const scriptHandleMap = {
 };
 
 const externalModulesMap = {
-          //  1. static import.
-          // '@wordpress/a11y': 'import @wordpress/a11y',
-          // '@storepress/utils': 'import @storepress/utils',
 
-          // view.js <script type="module" src="./view.js"></script>
-          // import { ... } from '@storepress/utils';
+    //	'module @wordpress/a11y'  →  import * as X from '@wordpress/a11y'
+    //  'import @wordpress/a11y'  →  module.exports = import('@wordpress/a11y')
 
-          // 2. dynamic import.
-          // '@storepress/utils': 'module @storepress/utils',
+    '@storepress/utils' : 'module @storepress/utils',
 
-          // view.js <script type="module" src="./view.js"></script>
-          // import('@storepress/utils').then(()=>{});
-          // OR
-          // const config = await fetch('../config.json').then(response => response.json());
-          // const driver = await import(`@storepress/utils`);
-          // driver.connect();
+    // import('@storepress/utils').then(()=>{});
+    // OR
+    // const config = await fetch('../config.json').then(response => response.json());
+    // const driver = await import(`@storepress/utils`);
+    // driver.connect();
 
     /*
           ```html
@@ -51,29 +46,7 @@ const externalModulesMap = {
               <link rel="modulepreload" href="http://example.com/wp-includes/js/dist/script-modules/interactivity/index.min.js" fetchpriority="low" />
               <link rel="modulepreload" href="./build/storepress-utils-module.js" fetchpriority="low" />
               ```*/
-
-          // in view.js
-          // ```js
-          // "import" prefix — static import (top-level, resolved at load time)
-          // import { store, getContext } from '@wordpress/a11y';
-          // ```
-
-          // dynamic import.
-          // @see: https://github.com/WordPress/gutenberg/blob/trunk/packages/block-library/src/query/view.js#L40
-          // ```js
-          //  import('@wordpress/interactivity-router').then({});
-          // ```
-          // '@wordpress/interactivity-router': 'import @wordpress/interactivity-router',
-
-          // view.js
-
-          // "import" prefix — static import (top-level, resolved at load time)
-          //  import { store, getContext } from '@wordpress/interactivity';
-
-          // "module" prefix — dynamic import (lazy, resolved at runtime)
-          // const loadRouter = () => import('@wordpress/interactivity-router');
-      }
-;
+};
 
 /**
  * Default request to global transformation
@@ -145,7 +118,7 @@ function getWebPackAlias() {
         //'@storepress/icons': getFile('packages/icons'),
         //'@storepress/utils': getFile('packages/utils'),
         //'@storepress/components': getFile('packages/components'),
-        '@{{kebabNamespace}}/{{kebabSlug}}' : getFile('index.js'),
+        '@storepress/html-plugin' : getFile('storepress/index.js'),
     };
 }
 

package/plugin-templates/tools/webpack.config.externals.js.mustache

@@ -0,0 +1,130 @@
+const [
+		  defaultJSConfig,
+		  defaultModuleConfig,
+	  ]                                            = require('@wordpress/scripts/config/webpack.config');
+const {
+		  requestToExternal,
+		  requestToHandle,
+		  requestToExternalModule,
+		  getFile,
+		  getRootFile,
+		  getWebPackAlias,
+	  }                                            = require('./webpack-helpers');
+const DependencyExtractionWebpackPlugin            = require('@wordpress/dependency-extraction-webpack-plugin');
+const RemoveEmptyScriptsPlugin                     = require('webpack-remove-empty-scripts');
+const webpack                                      = require('webpack');
+
+// Helper to route files to the correct directory
+
+const getOutputFilename = (pathData) => {
+
+	const condition = (pathData.chunk.name.startsWith('wp-') || pathData.chunk.name.startsWith('react-'))
+
+	return condition
+		? `externals/scripts/[name].js`
+		: '[name].js';
+};
+
+const getOutputFilenameAsModule = (pathData) => {
+
+	const condition = (pathData.chunk.name.startsWith('wp-') || pathData.chunk.name.startsWith('react-'))
+
+	return condition
+		? `externals/modules/[name].js`
+		: '[name].js';
+};
+
+const scriptConfig = {
+	...defaultJSConfig,
+	entry : {
+		'wp-element'        : {
+			import  : '@wordpress/element',
+			library : {
+				name : ['wp', 'element'],
+				type : 'window'
+			}
+		},
+		'react-jsx-runtime' : {
+			import  : 'react/jsx-runtime',
+			library : {
+				name : ['ReactJSXRuntime'],
+				type : 'window',
+			}
+		},
+	},
+
+	output : {
+		...defaultJSConfig.output,
+		filename : getOutputFilename,
+	},
+
+	resolve : {
+		...defaultJSConfig.resolve,
+		alias : {
+			...defaultJSConfig.resolve.alias,
+			...getWebPackAlias(),
+		},
+	},
+
+	plugins : [
+		...defaultJSConfig.plugins,
+		...defaultJSConfig.plugins.filter(
+			(plugin) =>
+				plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
+		),
+		new webpack.optimize.LimitChunkCountPlugin({maxChunks : 1}),
+	],
+};
+
+const moduleConfig = {
+	...defaultModuleConfig,
+	entry : {
+		// ...defaultModuleConfig.entry(),
+		// 'custom-module': getFile( 'custom-module.js' ),
+		/*'storepress-utils-module': {
+			import: '@storepress/utils/build-module/index.js',
+			library: {
+				type: 'module',
+			},
+		}*/
+
+		'wp-interactivity' : {
+			import  : '@wordpress/interactivity',
+			library : {
+				type : 'module'
+			}
+		},
+	},
+
+	output : {
+		...defaultModuleConfig.output,
+		filename : getOutputFilenameAsModule,
+	},
+
+	resolve : {
+		...defaultModuleConfig.resolve,
+		alias : {
+			...defaultModuleConfig.resolve.alias,
+			...getWebPackAlias(),
+		},
+	},
+
+	plugins : [
+		...defaultModuleConfig.plugins,
+
+		...defaultModuleConfig.plugins.filter(
+			(plugin) =>
+				plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
+		),
+
+		new webpack.optimize.LimitChunkCountPlugin({maxChunks : 1}),
+
+		// Removes the empty `.js` files generated by webpack but
+		// sets it after WP has generated its `*.asset.php` file.
+		new RemoveEmptyScriptsPlugin({
+			stage : RemoveEmptyScriptsPlugin.STAGE_AFTER_PROCESS_PLUGINS,
+		}),
+	],
+};
+
+module.exports = [scriptConfig, moduleConfig];

package/plugin-templates/webpack.config.js.mustache

@@ -1,104 +1,113 @@
 const [
-	defaultJSConfig,
-	defaultModuleConfig,
-] = require( '@wordpress/scripts/config/webpack.config' );
+          defaultJSConfig,
+          defaultModuleConfig,
+      ]                                            = require('@wordpress/scripts/config/webpack.config');
 const {
-	requestToExternal,
-	requestToHandle,
-	requestToExternalModule,
-	getFile,
-	getRootFile,
-	getWebPackAlias,
-} = require( './tools/webpack-helpers' );
-const WoocommerceDependencyExtractionWebpackPlugin = require( '@woocommerce/dependency-extraction-webpack-plugin' );
-const DependencyExtractionWebpackPlugin = require( '@wordpress/dependency-extraction-webpack-plugin' );
-const RemoveEmptyScriptsPlugin = require( 'webpack-remove-empty-scripts' );
+          requestToExternal,
+          requestToHandle,
+          requestToExternalModule,
+          getFile,
+          getRootFile,
+          getWebPackAlias,
+      }                                            = require('./tools/webpack-helpers');
+const DependencyExtractionWebpackPlugin            = require('@wordpress/dependency-extraction-webpack-plugin');
+const RemoveEmptyScriptsPlugin                     = require('webpack-remove-empty-scripts');
 
 const scriptConfig = {
-	...defaultJSConfig,
-	entry: {
-		[`plugin`]: [
-			getRootFile('style.scss'),
-			getRootFile('script.js'),
+    ...defaultJSConfig,
+    entry : {
+        [`react-example`]             : [
+            getFile('react/index.js'),
         ],
-        'storepress-utils': {
-			import: '@storepress/utils/build-module/index.js',
-			library: {
-				name: ['StorePress','Utils'],
-				type: 'window'
-			},
-		}
-	},
 
-	resolve: {
-		...defaultJSConfig.resolve,
-		alias: {
-			...defaultJSConfig.resolve.alias,
-			...getWebPackAlias(),
-		},
-	},
+        'storepress-utils' : {
+            import  : '@storepress/utils/build-module/index.js',
+            library : {
+                name    : ['StorePress', 'Utils'],
+                type : 'window',
+            },
+        },
 
-	plugins: [
-		// ...defaultJSConfig.plugins,
-		...defaultJSConfig.plugins.filter(
-			( plugin ) =>
-				plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
-		),
-		new WoocommerceDependencyExtractionWebpackPlugin( {
-			requestToExternal,
-			requestToHandle,
-			requestToExternalModule,
-		} ),
+        [`script-example`] : [
+            getFile('storepress/style.scss'),
+            getFile('storepress/script.js'),
+        ],
+    },
 
-		// Removes the empty `.js` files generated by webpack but
-		// sets it after WP has generated its `*.asset.php` file.
-		new RemoveEmptyScriptsPlugin( {
-			stage: RemoveEmptyScriptsPlugin.STAGE_AFTER_PROCESS_PLUGINS,
-		} ),
-	]
-};
+    resolve : {
+        ...defaultJSConfig.resolve,
+        alias : {
+            ...defaultJSConfig.resolve.alias,
+            ...getWebPackAlias(),
+        },
+    },
+
+    plugins : [
+        ...defaultJSConfig.plugins,
+        ...defaultJSConfig.plugins.filter(
+            (plugin) =>
+                plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
+        ),
+
+        new DependencyExtractionWebpackPlugin({
+            requestToExternal,
+            requestToHandle,
+            requestToExternalModule,
+        }),
+
+        // Removes the empty `.js` files generated by webpack but
+        // sets it after WP has generated its `*.asset.php` file.
+        new RemoveEmptyScriptsPlugin({
+            stage : RemoveEmptyScriptsPlugin.STAGE_AFTER_PROCESS_PLUGINS,
+        }),
+    ],
+}
 
 const moduleConfig = {
-	...defaultModuleConfig,
-	output: { ...defaultModuleConfig.output, module: true },
-	experiments: { outputModule: true },
-	entry: {
-		// ...defaultModuleConfig.entry(),
-		// 'custom-module': getFile( 'custom-module.js' ),
-        /*'storepress-utils-module': {
+    ...defaultModuleConfig,
+    entry : {
+        'interactive-example' : getFile('interactive/index.js'),
+        'storepress-utils-module': {
             import: '@storepress/utils/build-module/index.js',
             library: {
                 type: 'module',
             },
-        }*/
-	},
+        },
+
+        [`module-example`] : [
+            getFile('storepress/style.scss'),
+            getFile('storepress/script.js'),
+        ],
+    },
+
+    resolve : {
+        ...defaultModuleConfig.resolve,
+        alias : {
+            ...defaultModuleConfig.resolve.alias,
+            ...getWebPackAlias(),
+        },
+    },
+
+    plugins : [
+        ...defaultModuleConfig.plugins,
 
-	resolve: {
-		...defaultModuleConfig.resolve,
-		alias: {
-			...defaultModuleConfig.resolve.alias,
-			...getWebPackAlias(),
-		},
-	},
+        ...defaultModuleConfig.plugins.filter(
+            (plugin) =>
+                plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
+        ),
 
-	plugins: [
-		// ...defaultModuleConfig.plugins,
-		...defaultModuleConfig.plugins.filter(
-			( plugin ) =>
-				plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
-		),
-		new DependencyExtractionWebpackPlugin( {
-			requestToExternal,
-			requestToHandle,
-			requestToExternalModule,
-		} ),
+        new DependencyExtractionWebpackPlugin({
+            requestToExternal,
+            requestToHandle,
+            requestToExternalModule,
+        }),
 
-		// Removes the empty `.js` files generated by webpack but
-		// sets it after WP has generated its `*.asset.php` file.
-		new RemoveEmptyScriptsPlugin( {
-			stage: RemoveEmptyScriptsPlugin.STAGE_AFTER_PROCESS_PLUGINS,
-		} ),
-	],
+        // Removes the empty `.js` files generated by webpack but
+        // sets it after WP has generated its `*.asset.php` file.
+        new RemoveEmptyScriptsPlugin({
+            stage : RemoveEmptyScriptsPlugin.STAGE_AFTER_PROCESS_PLUGINS,
+        }),
+    ],
 };
 
-module.exports = [ scriptConfig, moduleConfig ];
+module.exports = [scriptConfig, moduleConfig];

package/block-templates/index.js.mustache

@@ -1,20 +0,0 @@
-/**
- * External dependencies
- */
-import { createStorePressPlugin } from '@storepress/utils';
-
-/**
- * Internal dependencies
- */
-import { Plugin } from './Plugin';
-
-const {{pascaleSlug}} = createStorePressPlugin( {
-	selector: '[data-{{kebabSlug}}]',
-	options: {},
-	plugin: Plugin,
-	namespace: '{{pascaleSlug}}',
-} );
-
-{{pascaleSlug}}.setup();
-
-export default {{pascaleSlug}};