{"id":13610580,"url":"https://github.com/WPBP/generator","last_synced_at":"2025-04-12T22:34:17.858Z","repository":{"id":10757566,"uuid":"66861023","full_name":"WPBP/generator","owner":"WPBP","description":"Code Generator for the WPBP","archived":false,"fork":false,"pushed_at":"2024-07-23T09:19:03.000Z","size":398,"stargazers_count":77,"open_issues_count":1,"forks_count":22,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T15:06:08.510Z","etag":null,"topics":["php","script","wordpress"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WPBP.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-29T16:34:13.000Z","updated_at":"2025-01-13T02:48:32.000Z","dependencies_parsed_at":"2024-11-06T07:01:46.738Z","dependency_job_id":"e5dd4cf6-8d85-4e10-9085-4426acb941c6","html_url":"https://github.com/WPBP/generator","commit_stats":{"total_commits":219,"total_committers":9,"mean_commits":"24.333333333333332","dds":0.0639269406392694,"last_synced_commit":"b1b0e7fdac0fa757d51ff03233b5e003f2acb233"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2Fgenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2Fgenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2Fgenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WPBP%2Fgenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WPBP","download_url":"https://codeload.github.com/WPBP/generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642308,"owners_count":21138350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","script","wordpress"],"created_at":"2024-08-01T19:01:46.068Z","updated_at":"2025-04-12T22:34:17.806Z","avatar_url":"https://github.com/WPBP.png","language":"PHP","readme":"# WPBP Generator\n[![License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)\n![Downloads](https://img.shields.io/packagist/dt/wpbp/generator.svg) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/7dea19a435514ccd9079f614dacfda46)](https://www.codacy.com/gh/WPBP/generator?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=WPBP/generator\u0026amp;utm_campaign=Badge_Grade)\n\nThis generator (based on PHP) parse the [WordPress Plugin Boilerplate Powered](https://github.com/WPBP/WordPress-Plugin-Boilerplate-Powered) and remove the stuff that you don't need.\n\n## Requirements\n\nLet's have a look on what you need and how to install it:\n\n### Debian/Ubuntu\n\n`sudo apt install php php-zip php-mbstring php-yaml`\n\n### Fedora/Centos\n\n`sudo dnf install php php-zip php-mbstring php-yaml`\n\n### Mac OS\n\n`brew install pkg-config zlib`\n`pecl install zip mbstring yaml`\n(source: https://grrr.tech/posts/installing-homebrew-php-extensions-with-pecl)\n\n## Install\n\nFrom [here](https://github.com/WPBP/generator/releases) you can download the phar version or you can chose to install it with composer:\n\n`composer global require wpbp/generator:dev-master`\n\nAdd this directory to your PATH in your ~/.bash_profile (or ~/.bashrc) like this:\n\n`export PATH=~/.composer/vendor/bin:$PATH`\n\n## Execute\n\n`wpbp-generator --help` to get a list of commands\n\n```\n--dark\n     Use a dark theme for console output.\n\n--dev\n     Download from the master branch (the development version).\n\n--help\n     Show the help page for this command.\n\n--json\n     Generate a wpbp.json file in the current folder. Suggested to use the WordPress plugin folder.\n\n--no-download\n     Do you want to execute composer and npm manually? This is your flag!\n\n--verbose\n     Verbose output. Because this can be helpful for debugging!\n```\n\n## wpbp.json\n\nThis [file](https://github.com/WPBP/generator/blob/master/generator/wpbp.json) contains all the default variables that will be used to scaffold the boilerplate.  \n\n* *plugin*/*author* section includes [Plugin names for the WordPress plugin standard](https://developer.wordpress.org/plugins/plugin-basics/header-requirements/) but also the Comments section in every file\n* *public-assets* section includes code for frontend that [enqueue CSS and JS file](https://developer.wordpress.org/plugins/javascript/enqueuing/#enqueue-script)\n* *act-deact* section includes the code on [activation/deactivation of the plugin itself](https://developer.wordpress.org/plugins/plugin-basics/activation-deactivation-hooks/) and the [uninstall.php file](https://developer.wordpress.org/plugins/plugin-basics/uninstall-methods/#method-2-uninstall-php)\n* *admin-assets* section includes code for backend that [enqueue CSS and JS file](https://developer.wordpress.org/plugins/javascript/enqueuing/#enqueue-script), `settings` values are for the Plugin setting page and admin for the rest of backend, `admin-page` add a new setting plugin page\n* *ajax* section add code for [WordPress Ajax](https://codex.wordpress.org/AJAX_in_Plugins) system for [logged/non-logged users](https://developer.wordpress.org/plugins/javascript/enqueuing/#ajax-action)\n* *git-repo* execute automatically `git init` in the folder created\n* *block* adds the support for a custom block, *grumphp* adds the support for [GrumPHP](https://github.com/phpro/grumphp) and *phpstan* for [PHPStan](https://github.com/phpstan/phpstan)\n* *phpcs/phpstan* enable predefined settings and rulesets for this tools\n* *unit-test* adds the `tests` folder and `codeception.dist.yml` file with the various packages for composer about [Codeception](https://codeception.com/)\n* *wpcli* adds the support in the plugin code for the [WP-CLI tool](https://wp-cli.org/)\n* *language-files* adds the [po/mo files and the code to load custom languages files](https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/)\n* *libraries* includes all the composer packages that will be downloaded with the related example code in the boilerplate itself, removing them will not add it\n* *snippet* in the various subsections add specific code snippet integrated for the various needs in WordPress, removing them will not add it\n","funding_links":[],"categories":["PHP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWPBP%2Fgenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWPBP%2Fgenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWPBP%2Fgenerator/lists"}