{"id":21044639,"url":"https://github.com/tripflex/generator-wpplugin","last_synced_at":"2025-03-13T22:10:30.724Z","repository":{"id":147531807,"uuid":"44117551","full_name":"tripflex/generator-wpplugin","owner":"tripflex","description":"Yeoman WordPress plugin generator based off the WebDevStudios yeoman plugin generator","archived":false,"fork":false,"pushed_at":"2015-10-12T15:54:09.000Z","size":280,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-20T17:33:06.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tripflex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-12T15:48:05.000Z","updated_at":"2017-04-06T20:44:20.000Z","dependencies_parsed_at":"2023-04-09T18:46:52.865Z","dependency_job_id":null,"html_url":"https://github.com/tripflex/generator-wpplugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fgenerator-wpplugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fgenerator-wpplugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fgenerator-wpplugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fgenerator-wpplugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tripflex","download_url":"https://codeload.github.com/tripflex/generator-wpplugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243489898,"owners_count":20299001,"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":[],"created_at":"2024-11-19T14:18:00.851Z","updated_at":"2025-03-13T22:10:30.704Z","avatar_url":"https://github.com/tripflex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"generator-wpplugin [![Build Status](https://secure.travis-ci.org/WebDevStudios/generator-wpplugin.png?branch=master)](https://travis-ci.org/WebDevStudios/generator-wpplugin)\n=============================================================================================================================================================================\n\n\u003e [Yeoman](http://yeoman.io) generator for WordPress plugins, based off the [WebDevStudios plugin generator](https://github.com/webdevstudios/generator-wpplugin)\n\nGetting Started\n---------------\n\nPre-requisites: You'll need [node](https://nodejs.org/download/) which comes with [npm](https://github.com/npm/npm#super-easy-install).\n\nIf you don't have [Yeoman](http://yeoman.io/) installed:\n\n```bash\nnpm install -g yo\n```\n\nTo install generator-wpplugin from npm, run:\n\n```bash\nnpm install -g generator-wpplugin\n```\n\nTo use generator-wpplugin, `cd` to your WordPress plugins folder and:\n\n```bash\nyo wpplugin\n```\n\nYou'll be prompted with steps for creating your plugin.\n\nSub-generators\n--------------\n\nOnce your nifty new plugin has been generated, `cd` into your new plugin's directory. While in the plugin directory, you can run additional commands called sub-generators to automatically generate files to enhance your plugin.\n\n-\t`yo wpplugin:include include-name` [Basic Include](include/README.md)\n-\t`yo wpplugin:cpt cpt-name` [Custom Post Type](cpt/README.md)\n-\t`yo wpplugin:options options-name` [Option Page](options/README.md)\n-\t`yo wpplugin:widget widget-name` [Widget](widget/README.md)\n-\t`yo wpplugin:js` [Javascript](js/README.md)\n-\t`yo wpplugin:css` [Styles](css/README.md)\n\nFor the names of the include, cpt, options, and widget subgenerators remember that the plugin prefix will be added to the class name so no need to include the original plugin name there! Think of it as the file name for each instead.\n\nTests\n-----\n\nBy default the plugin generator adds some built in tests for you to add on to as you develop your plugin! To run these tests run the `install-wp-tests.sh` script in the bin folder with the proper database details for your local setup.\n\nOnce you've run the `install-wp-tests.sh` script you can run just `phpunit` in the main folder of your plugin.\n\nIf you don't want tests included in your plugin when it is generated run the main generator with the `--notests` option.\n\n### Adding Packages with Composer\n\nIf you chose composer as the autoloader option during the plugin's initiation, you can use composer to add additional dependencies.\n\nLet's `cd` into our new plugin's directory and add [CMB2](https://github.com/WebDevStudios/CMB2):\n\n```bash\ncomposer require webdevstudios/cmb2\n```\n\nCMB2 will now appear under `vendor`\n\n```bash\n-plugins\n  -wds-foo-plugin\n    -vendor\n      -webdevstudios\n        -cmb2\n```\n\nSee the complete list of WebDevStudios packages: https://packagist.org/packages/webdevstudios/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftripflex%2Fgenerator-wpplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftripflex%2Fgenerator-wpplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftripflex%2Fgenerator-wpplugin/lists"}