diff --git a/.deployignore b/.deployignore new file mode 100644 index 0000000..e4481b0 --- /dev/null +++ b/.deployignore @@ -0,0 +1,22 @@ +.DS_Store +Thumbs.db +wp-cli.local.yml +node_modules/ +*.sql +*.tar.gz +*.zip +.phpunit.result.cache +Dockerfile +output.log +.github +tests +bin +composer.lock +phpcs.xml +phpunit.xml +configure.php +DOCKER_ENV +phpunit.xml +tests +.phpcs +Makefile diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..351b59f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,23 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = tab +indent_size = 4 + +[*.{js,jsx,scss,css,json,yaml,yml,feature,xml}] +indent_style = space +indent_size = 2 + +# Composer File +[composer.{json,lock}] +indent_style = space +indent_size = 4 + +# Dotfiles +[.*] +indent_style = space +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..a21ab7f --- /dev/null +++ b/.gitattributes @@ -0,0 +1,28 @@ +# +# Exclude these files from release archives. +# +# This will also make the files unavailable when using Composer with `--prefer-dist`. +# +# Via WPCS. +# +/.github export-ignore +/phpcs.xml export-ignore +/.phpcs export-ignore +/phpunit.xml export-ignore +/tests export-ignore +/configure.php export-ignore +/Makefile export-ignore + +# +# Auto detect text files and perform LF normalization. +# +# http://davidlaing.com/2012/09/19/customise-your-gitattributes-to-become-a-git-ninja/ +# +* text=auto + +# +# The above will handle all files not found below. +# +*.md text +*.php text +*.inc text diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..f33f034 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,15 @@ +# Please see the documentation for all configuration options: +# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + + - package-ecosystem: "composer" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/coding-quality.yml b/.github/workflows/coding-quality.yml new file mode 100644 index 0000000..769b420 --- /dev/null +++ b/.github/workflows/coding-quality.yml @@ -0,0 +1,14 @@ +name: Code Quality + +on: + push: + branches: + - main + pull_request: + # Uncomment and edit the following to run on a schedule. + # schedule: + # - cron: '45 5 * * 0' # Run once per week at 5:45am UTC on Sundays. + +jobs: + code-quality: + uses: alleyinteractive/.github/.github/workflows/php-code-quality.yml@main diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml new file mode 100644 index 0000000..49a310e --- /dev/null +++ b/.github/workflows/coding-standards.yml @@ -0,0 +1,16 @@ +name: Coding Standards + +on: + push: + branches: + - main + pull_request: + # Uncomment and edit the following to run on a schedule. + # schedule: + # - cron: '0 5 * * 0' # Run once per week at 5am UTC on Sundays. + +jobs: + coding-standards: + uses: alleyinteractive/.github/.github/workflows/php-coding-standards.yml@main + with: + php: "8.2" diff --git a/.github/workflows/dependabot-auto-approve.yml b/.github/workflows/dependabot-auto-approve.yml new file mode 100644 index 0000000..e2119de --- /dev/null +++ b/.github/workflows/dependabot-auto-approve.yml @@ -0,0 +1,11 @@ +name: dependabot-auto-approve +on: + pull_request: + +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + uses: alleyinteractive/.github/.github/workflows/dependabot-auto-approve.yml@main diff --git a/.github/workflows/dependabot-auto-merge.yml b/.github/workflows/dependabot-auto-merge.yml new file mode 100644 index 0000000..aaed13d --- /dev/null +++ b/.github/workflows/dependabot-auto-merge.yml @@ -0,0 +1,10 @@ +name: dependabot-auto-merge +on: pull_request_target + +permissions: + pull-requests: write + contents: write + +jobs: + dependabot: + uses: alleyinteractive/.github/.github/workflows/dependabot-auto-merge.yml@main diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml new file mode 100644 index 0000000..9500474 --- /dev/null +++ b/.github/workflows/unit-test.yml @@ -0,0 +1,16 @@ +name: Testing Suite + +on: + push: + branches: + - main + pull_request: + # Uncomment and edit the following to run on a schedule. + # schedule: + # - cron: '15 5 * * 0' # Run once per week at 5:15am UTC on Sundays. + +jobs: + unit-tests: + uses: alleyinteractive/.github/.github/workflows/php-tests.yml@main + with: + php: "8.2" diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml new file mode 100644 index 0000000..0cdea23 --- /dev/null +++ b/.github/workflows/update-changelog.yml @@ -0,0 +1,28 @@ +name: "Update Changelog" + +on: + release: + types: [released] + +jobs: + update: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + ref: main + + - name: Update Changelog + uses: stefanzweifel/changelog-updater-action@v1 + with: + latest-version: ${{ github.event.release.name }} + release-notes: ${{ github.event.release.body }} + + - name: Commit updated CHANGELOG + uses: stefanzweifel/git-auto-commit-action@v5 + with: + branch: main + commit_message: Update CHANGELOG + file_pattern: CHANGELOG.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a854579 --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# Build files +build +vendor +composer.lock +node_modules + +# Log files +*.log + +# Cache files +.phpcs/*.json +.phpunit.result.cache + +# Ignore temporary OS files +.DS_Store +.DS_Store? +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db +.thumbsdb + +# IDE files +*.code-workspace +.idea +.vscode diff --git a/.phpcs/.gitkeep b/.phpcs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..067df39 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `Create PHP Package` will be documented in this file. + +## 0.1.0 - 202X-XX-XX + +- Initial release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d9e033f --- /dev/null +++ b/Makefile @@ -0,0 +1,4 @@ +setup: + php ./configure.php + +.PHONY: setup diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e61fc7 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ + +# Create PHP Package + +This is a skeleton package for PHP packages that are built for WordPress +development. This template includes Composer autoloading and Alley's +WordPress-based coding standards to make it easy to build PHP packages geared +for WordPress development. + +## Getting Started + +Follow these steps to get started: + +1. Press the "Use template" button at the top of this repo to create a new repo + with the contents of this skeleton. +2. Run `make` (or `php ./configure.php`) to run a script that will replace all + placeholders throughout all the files. +3. Have fun creating your package! 🎊 + + + +# Create PHP Package + +[![Coding Standards](https://github.com/alleyinteractive/create-php-package/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/alleyinteractive/create-php-package/actions/workflows/coding-standards.yml) +[![Testing Suite](https://github.com/alleyinteractive/create-php-package/actions/workflows/unit-test.yml/badge.svg)](https://github.com/alleyinteractive/create-php-package/actions/workflows/unit-test.yml) + +A skeleton PHP package geared for WordPress Development + +## Installation + +You can install the package via composer: + +```bash +composer require alleyinteractive/create-php-package +``` + +## Usage + +Use this package like so: + +```php +$package = Create_PHP_Package\Skeleton\Example_Package(); +$package->perform_magic(); +``` + +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Credits + +This project is actively maintained by [Alley +Interactive](https://github.com/alleyinteractive). Like what you see? [Come work +with us](https://alley.co/careers/). + +- [author_name](https://github.com/author_name) +- [All Contributors](../../contributors) + +## License + +The GNU General Public License (GPL) license. Please see [License File](LICENSE) for more information. diff --git a/buddy.yml b/buddy.yml new file mode 100644 index 0000000..db65b1a --- /dev/null +++ b/buddy.yml @@ -0,0 +1,110 @@ +- pipeline: "Pull Request Tests" + trigger_mode: "ON_EVERY_PUSH" + ref_name: "refs/pull/*" + ref_type: "WILDCARD" + priority: "NORMAL" + target_site_url: "https://github.com/alleyinteractive/create-php-package" + fetch_all_refs: true + fail_on_prepare_env_warning: true + trigger_condition: "ALWAYS" + actions: + - action: "Gitignored files check" + type: "BUILD" + working_directory: "/buddy/create-php-package" + docker_image_name: "alleyops/ci-resources" + docker_image_tag: "8.2-fpm-wp" + execute_commands: + - "if [[ ! -z $(git ls-files -i --exclude-standard) ]]; then exit 1; fi" + volume_mappings: + - "/:/buddy/create-php-package" + trigger_condition: "ALWAYS" + shell: "BASH" + run_next_parallel: true + - action: "Check for git conflicts" + type: "BUILD" + working_directory: "/buddy/create-php-package" + docker_image_name: "alleyops/ci-resources" + docker_image_tag: "8.2-fpm-wp" + execute_commands: + - "! git grep -E '<<<<<<< |>>>>>>> ' -- './*' ':(exclude)buddy.yml' ':(exclude).buddy/*'" + volume_mappings: + - "/:/buddy/create-php-package" + trigger_condition: "ALWAYS" + shell: "BASH" + - action: "Composer install" + type: "BUILD" + working_directory: "/buddy/create-php-package" + docker_image_name: "alleyops/ci-resources" + docker_image_tag: "8.2-fpm-wp" + execute_commands: + - "composer install -q" + volume_mappings: + - "/:/buddy/create-php-package" + trigger_condition: "ALWAYS" + shell: "BASH" + - action: "phpunit" + type: "BUILD" + working_directory: "/buddy/create-php-package" + docker_image_name: "alleyops/ci-resources" + docker_image_tag: "8.2-fpm-wp" + execute_commands: + - "composer phpunit" + setup_commands: + - "echo \"extension=memcache.so\" >> /usr/local/etc/php/conf.d/buddy.ini" + services: + - type: "MARIADB" + version: "10.3" + connection: + host: "mariadb" + port: 3306 + user: "root" + password: "root" + db: "wordpress_unit_tests" + - type: "MEMCACHED" + version: "1.5.6" + connection: + host: "memcached" + port: 11211 + volume_mappings: + - "/:/buddy/create-php-package" + trigger_condition: "ALWAYS" + shell: "BASH" + run_next_parallel: true + - action: "composer phpcs" + type: "BUILD" + working_directory: "/buddy/create-php-package" + docker_image_name: "alleyops/ci-resources" + docker_image_tag: "8.2-fpm-wp" + execute_commands: + - "composer phpcs" + volume_mappings: + - "/:/buddy/create-php-package" + trigger_condition: "ALWAYS" + shell: "BASH" + variables: + - key: "CACHEDIR" + value: "/tmp/test-cache" + type: "VAR" + description: "Cache folder for remote requests." + - key: "SKIP_DISCOVERY" + value: "true" + type: "VAR" + - key: "WP_CORE_DIR" + value: "/tmp/wordpress" + type: "VAR" + description: "WordPress checkout folder." + - key: "WP_VERSION" + value: "latest" + type: "VAR" + - key: "WP_DB_PASSWORD" + value: "root" + type: "VAR" + - key: "WP_DB_HOST" + value: "mariadb" + type: "VAR" + - key: "WP_SKIP_DB_CREATE" + value: "true" + type: "VAR" + - key: "WP_PHPUNIT_PATH" + value: "composer run phpunit" + type: "VAR" diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..f343d91 --- /dev/null +++ b/composer.json @@ -0,0 +1,58 @@ +{ + "name": "alleyinteractive/create-php-package", + "description": "A skeleton PHP package geared for WordPress Development", + "type": "library", + "keywords": [ + "alleyinteractive", + "create-php-package" + ], + "homepage": "https://github.com/alleyinteractive/create-php-package", + "license": "GPL-2.0-or-later", + "authors": [ + { + "name": "author_name", + "email": "email@domain.com" + } + ], + "require": { + "php": "^8.0", + "alleyinteractive/composer-wordpress-autoloader": "^1.0" + }, + "require-dev": { + "alleyinteractive/alley-coding-standards": "^1.0 || ^2.0", + "mantle-framework/testkit": "^0.12", + "nunomaduro/collision": "^5.0 || ^6.0", + "szepeviktor/phpstan-wordpress": "^1.3" + }, + "config": { + "allow-plugins": { + "alleyinteractive/composer-wordpress-autoloader": true, + "dealerdirect/phpcodesniffer-composer-installer": true, + "pestphp/pest-plugin": true + }, + "sort-packages": true + }, + "extra": { + "wordpress-autoloader": { + "autoload": { + "Create_PHP_Package\\": "src" + }, + "autoload-dev": { + "Create_PHP_Package\\Tests\\": "tests" + } + } + }, + "minimum-stability": "dev", + "prefer-stable": true, + "scripts": { + "phpcbf": "phpcbf .", + "phpcs": "phpcs .", + "phpstan": "phpstan --memory-limit=512M", + "phpunit": "phpunit", + "test": [ + "@phpcs", + "@phpstan", + "@phpunit" + ] + } +} diff --git a/configure.php b/configure.php new file mode 100644 index 0000000..0778ef9 --- /dev/null +++ b/configure.php @@ -0,0 +1,219 @@ +#!/usr/bin/env php +.*/s', '', $contents ) ?: $contents ), + ); +} + +function determine_separator( string $path ): string { + return str_replace( '/', DIRECTORY_SEPARATOR, $path ); +} + +function list_all_files_for_replacement(): array { + return explode( PHP_EOL, run( 'grep -R -l ./ --exclude LICENSE --exclude configure.php --exclude composer.lock --exclude-dir .git --exclude-dir .github --exclude-dir vendor --exclude-dir bin --exclude-dir webpack --exclude-dir modules --exclude-dir .phpcs' ) ); +} + +function delete_files( string|array $paths ) { + if ( ! is_array( $paths ) ) { + $paths = [ $paths ]; + } + + foreach ( $paths as $path ) { + $path = determine_separator( $path ); + + if ( is_dir( $path ) ) { + run( "rm -rf {$path}" ); + } elseif ( file_exists( $path ) ) { + unlink( $path ); + } + } +} + +echo "\nWelcome friend to alleyinteractive/create-php-package! 😀\nLet's setup your PHP package 🚀\n\n"; + +$git_name = run( 'git config user.name' ); +$author_name = ask( 'Author name?', $git_name ); + +$git_email = run( 'git config user.email' ); +$author_email = ask( 'Author email?', $git_email ); + +$username_guess = explode( ':', run( 'git config remote.origin.url' ) )[1] ?? ''; +$username_guess = dirname( $username_guess ); +$username_guess = basename( $username_guess ); +$author_username = ask( 'Author username?', $username_guess ); + +$vendor_name = ask( 'Vendor name (usually the Github Organization)?', $username_guess ); +$vendor_slug = slugify( $vendor_name ); + +$current_dir = getcwd(); +$folder_name = ensure_capitalp( basename( $current_dir ) ); + +$package_name = ask( 'Package name?', str_replace( '_', ' ', title_case( $folder_name ) ) ); +$package_name_slug = slugify( $package_name ); + +$namespace = ask( 'Package namespace?', title_case( $package_name ) ); +$class_name = ask( 'Base class name for package?', title_case( $package_name ) ); + +$description = ask( 'Package description?', "This is my PHP package {$package_name}" ); + +writeln( '------' ); +writeln( "Author : {$author_name} ({$author_email})" ); +writeln( "Vendor : {$vendor_name} ({$vendor_slug})" ); +writeln( "Package : {$package_name} <{$package_name_slug}>" ); +writeln( "Description : {$description}" ); +writeln( "Namespace : {$namespace}" ); +writeln( "Main Class : {$class_name}" ); +writeln( '------' ); + +writeln( 'This script will replace the above values in all relevant files in the project directory.' ); + +if ( ! confirm( 'Modify files?', true ) ) { + exit( 1 ); +} + +$search_and_replace = [ + 'author_name' => $author_name, + 'author_username' => $author_username, + 'email@domain.com' => $author_email, + + 'A skeleton PHP package geared for WordPress Development' => $description, + + 'Create_PHP_Package' => $namespace, + 'Example_Package' => $class_name, + 'package_name' => $package_name, + + 'create-php-package' => $package_name_slug, + 'Create PHP Package' => $package_name, + + 'CREATE_PHP_PACKAGE' => strtoupper( str_replace( '-', '_', $package_name ) ), + 'Skeleton' => $class_name, + 'vendor_name' => $vendor_name, + 'alleyinteractive' => $vendor_slug, +]; + +foreach ( list_all_files_for_replacement() as $path ) { + echo "Updating $path...\n"; + replace_in_file( $path, $search_and_replace ); + + if ( str_contains( $path, determine_separator( 'src/class-example-package.php' ) ) ) { + rename( $path, determine_separator( './src/class-' . str_replace( '_', '-', strtolower( $class_name ) ) . '.php' ) ); + } + + if ( str_contains( $path, 'README.md' ) ) { + remove_readme_paragraphs( $path ); + } +} + +echo "Done!\n\n"; + +if ( confirm( 'Do you want to run `composer install`?', true ) ) { + if ( file_exists( __DIR__ . '/composer.lock' ) ) { + echo run( 'composer update' ); + } else { + echo run( 'composer install' ); + } + + echo "\n\n"; +} + +if ( + file_exists( __DIR__ . '/buddy.yml' ) && confirm( 'Do you need the Buddy CI configuration? (Alley devs only -- if the package is open-source it will not be needed)', false ) +) { + delete_files( [ '.buddy', 'buddy.yml' ] ); +} + +if ( confirm( 'Let this script delete itself?', true ) ) { + delete_files( + [ + 'Makefile', + __FILE__, + ] + ); +} + +echo "\n\nWe're done! 🎉\n\n"; + +die( 0 ); diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..fc57e61 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,45 @@ + + + PHP_CodeSniffer standard for create-php-package. + + + + + + + + + + + + + + + + + + + + + tests/ + build/ + vendor/ + + + + + + + + + + + + + + diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..88adee0 --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,17 @@ +includes: + - vendor/szepeviktor/phpstan-wordpress/extension.neon + +parameters: + # Level 9 is the highest level + level: max + + paths: + - src/ + +# ignoreErrors: +# - '#PHPDoc tag @var#' +# +# excludePaths: +# - ./*/*/FileToBeExcluded.php +# +# checkMissingIterableValueType: false diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..7d8c272 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,18 @@ + + + + tests/feature + + + tests/unit + + + diff --git a/src/class-example-package.php b/src/class-example-package.php new file mode 100644 index 0000000..ca2a9c2 --- /dev/null +++ b/src/class-example-package.php @@ -0,0 +1,15 @@ +maybe_rsync_plugin() + ->install(); diff --git a/tests/class-test-case.php b/tests/class-test-case.php new file mode 100644 index 0000000..ecdfb7a --- /dev/null +++ b/tests/class-test-case.php @@ -0,0 +1,11 @@ +assertTrue( true ); + $this->assertNotEmpty( home_url() ); + } +} diff --git a/tests/unit/test-example-unit-test.php b/tests/unit/test-example-unit-test.php new file mode 100644 index 0000000..caa7eef --- /dev/null +++ b/tests/unit/test-example-unit-test.php @@ -0,0 +1,13 @@ +assertTrue(true); + } +}