Helps to easily zip all files and folders to be ready for plugin install, the WordPress way.
Also for extraction to wordpress-org folder for auto deploy :), don't get? https://github.com/10up/action-wordpress-plugin-deploy for more info.
Donate link: I do not mind a token for ordering Pancakes 🥞, so you can Drop something for your boy 🤓 🥳
Make sure you put this file in your plugin parent directory.
Will think of doing an update for flexible file structure later 💆🏽♂️, can't stress 💅.
Also try to make your code sniffer ignore this file, e get why(There's a reason)
So basically, I was kind of tired when coding this, so it doesn't follow standards to the core, but you'll be fine, still good enough fam.
This requires PHP >= 5.6 (I know it's an obvious requirement 🤡) and the ZipArchive 🤐 extension.
You might enjoy this more using npm package installer, it's what i used to easily execute my cmd. e.g npm run compress-zip, you'll see a sample json in the repo.
Putting it in a bash script won't be bad also, whichever works for you.
php wp-plugin-deploy-helper.php --param1=values --param2=value1,value2
It takes in parameters via the Command Line Interface(CLI)
Command line options
--plugin_name The Name of your plugin, should be the same with your unique slug.
--ignore_file_path (optional) csv format of paths/files to ignore, if not called, there are default paths to be ignored by the script.
--delete_files_in_zip (optional) csv format of paths/files to delete in the zip(it also searches for matches, so git will ignore github,etc).
This was added cause i felt, adding all to ignore wont be as fast as deleting from the zip file.
note: **It doesn't delete folders for some weird reason.
--offload (optional) if set, the file will only extract the {plugin_name}.zip file to .wordpress-org folder, any value is true.
--offload_dir (optional) if not set, defaults extracting to .wordpress-org folder, only useful if -offload param is set.
`php wp-plugin-deploy-helper.php --plugin_name=woo-phone-validator --ignore_file_path=.git,.wordpress-org,node_modules,vendor,.sh --delete_files_in_zip=wp-plugin-deploy-helper.php,README.md,package-lock.json,composer.lock,.eslintrc.json,.distignore`
Notice the option field --offload_dir param is not called, it defaults extraction to .wordpress-org/ folder.
Add the --offload_dir=[folder_name] arg if you want to override the default folder.
php wp-plugin-deploy-helper.php --plugin_name=woo-phone-validator --offload=true
If you find this useful:
Do not forget to star 🤩✨⭐ the Repo and share.
Else if you want to buy me pancakes 🥞:
You can click the **Donate link** above 😘😉.
Else if you want to collaborate:
Feel free to join.
Else
Thanks for using and hanging around 👀.
Feel free to check my profile to reach me on any means you can.