Skip to content

Commit

Permalink
Configuring
Browse files Browse the repository at this point in the history
  • Loading branch information
srtfisher committed Jul 9, 2024
1 parent e1bb447 commit dbd4861
Show file tree
Hide file tree
Showing 25 changed files with 88 additions and 1,174 deletions.
40 changes: 0 additions & 40 deletions .github/workflows/merge-develop-to-scaffold.yml

This file was deleted.

1 change: 1 addition & 0 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ jobs:
wordpress: ["latest"]
uses: alleyinteractive/.github/.github/workflows/php-tests.yml@main
with:
database: ''
php: ${{ matrix.php }}
wordpress: ${{ matrix.wordpress }}
2 changes: 1 addition & 1 deletion .github/workflows/upgrade-wordpress-plugin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ jobs:
- uses: actions/checkout@v4
- uses: alleyinteractive/[email protected]
with:
plugin-file: 'plugin.php'
plugin-file: 'wp-command-palette.php'
upgrade-npm-dependencies: "true"
8 changes: 4 additions & 4 deletions .phpcs.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="create-wordpress-plugin" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
<description>PHP_CodeSniffer standard for create-wordpress-plugin.</description>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="wp-command-palette" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
<description>PHP_CodeSniffer standard for wp-command-palette.</description>

<!-- Include Alley Rules -->
<rule ref="Alley-Interactive" />
Expand Down Expand Up @@ -36,8 +36,8 @@
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array">
<element value="vendor_name" />
<element value="create_wordpress_plugin" />
<element value="alleyinteractive" />
<element value="wp_command_palette" />
</property>
</properties>
</rule>
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

All notable changes to `Create WordPress Plugin` will be documented in this file.
All notable changes to `WP Command Palette` will be documented in this file.

## 0.1.0 - 202X-XX-XX

Expand Down
4 changes: 0 additions & 4 deletions Makefile

This file was deleted.

51 changes: 11 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,8 @@
<!--delete-->
# Create WordPress Plugin
# WP Command Palette

This is a skeleton WordPress plugin that can scaffold a WordPress plugin. This
template includes a base plugin file, autoloaded PHP files, unit tests powered
by [Mantle](https://mantle.alley.com/), front-end assets compiled via Webpack,
and Continuous Integration [via GitHub Actions](.github/workflows). Actions are
configured to test the plugin and also build it for releases. A built tag
workflow will create `*-built` branches as well as a built release workflow that
will build and tag/release the plugin automatically. The built branches and
releases will include any compiled front-end assets (if using them).
Contributors: alleyinteractive

The plugin supports front-end assets which can be enqueued inside
`src/assets.php` or from within an entry points `index.php` file. For plugins
that don't require front-end assets, the configuration script below will prompt
you to delete the front-end files if you don't wish to use them.

## 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 plugin! 🎊

<!--/delete-->

# Create WordPress Plugin

Contributors: author_username

Tags: vendor_name, create-wordpress-plugin
Tags: alleyinteractive, wp-command-palette

Stable tag: 0.0.0

Expand All @@ -43,28 +14,28 @@ Requires PHP: 8.1

License: GPL v2 or later

[![Coding Standards](https://github.com/alleyinteractive/create-wordpress-plugin/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/alleyinteractive/create-wordpress-plugin/actions/workflows/coding-standards.yml)
[![Testing Suite](https://github.com/alleyinteractive/create-wordpress-plugin/actions/workflows/unit-test.yml/badge.svg)](https://github.com/alleyinteractive/create-wordpress-plugin/actions/workflows/unit-test.yml)
[![Coding Standards](https://github.com/alleyinteractive/wp-command-palette/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/alleyinteractive/wp-command-palette/actions/workflows/coding-standards.yml)
[![Testing Suite](https://github.com/alleyinteractive/wp-command-palette/actions/workflows/unit-test.yml/badge.svg)](https://github.com/alleyinteractive/wp-command-palette/actions/workflows/unit-test.yml)

A skeleton WordPress plugin.
Admin-wide command palette for easy access to setting pages..

## Installation

You can install the package via composer:

```bash
composer require alleyinteractive/create-wordpress-plugin
composer require alleyinteractive/wp-command-palette
```

## Usage

Activate the plugin in WordPress and use it like so:

```php
$plugin = Create_WordPress_Plugin\Skeleton\Example_Plugin();
$plugin = Alley\WP\Command_Palette\WP_Command_Palette\WP_Command_Palette();
$plugin->perform_magic();
```
<!--front-end-->

## Testing

Run `npm run test` to run Jest tests against JavaScript files. Run
Expand Down Expand Up @@ -156,9 +127,9 @@ 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)
- [Sean Fisher](https://github.com/Sean Fisher)
- [All Contributors](../../contributors)

## License

The GNU General Public License (GPL) license. Please see [License File](LICENSE) for more information.
The GNU General Public License (GPL) license. Please see [License File](LICENSE) for more information.
174 changes: 0 additions & 174 deletions buddy.yml

This file was deleted.

18 changes: 9 additions & 9 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
{
"name": "alleyinteractive/create-wordpress-plugin",
"description": "A skeleton WordPress plugin",
"name": "alleyinteractive/wp-command-palette",
"description": "Admin-wide command palette for easy access to setting pages.",
"type": "wordpress-plugin",
"keywords": [
"alleyinteractive",
"create-wordpress-plugin"
"wp-command-palette"
],
"homepage": "https://github.com/alleyinteractive/create-wordpress-plugin",
"homepage": "https://github.com/alleyinteractive/wp-command-palette",
"license": "GPL-2.0-or-later",
"authors": [
{
"name": "author_name",
"email": "email@domain.com"
"name": "Sean Fisher",
"email": "sean@alley.com"
}
],
"require": {
Expand All @@ -34,16 +34,16 @@
},
"autoload-dev": {
"psr-4": {
"Create_WordPress_Plugin\\Tests\\": "tests"
"Alley\WP\Command_Palette\\Tests\\": "tests"
}
},
"extra": {
"wordpress-autoloader": {
"autoload": {
"Create_WordPress_Plugin\\": "src"
"Alley\\WP\\Command_Palette": "src"
},
"autoload-dev": {
"Create_WordPress_Plugin\\Tests\\": "tests"
"Alley\\WP\\Command_Palette\\Tests": "tests"
}
}
},
Expand Down
Loading

0 comments on commit dbd4861

Please sign in to comment.