Skip to content

Commit

Permalink
Scaffolding out the plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
srtfisher committed Jul 6, 2023
1 parent 209fdb9 commit 8994e6d
Show file tree
Hide file tree
Showing 44 changed files with 95 additions and 32,150 deletions.
2 changes: 0 additions & 2 deletions .eslintignore

This file was deleted.

6 changes: 0 additions & 6 deletions .eslintrc.json

This file was deleted.

11 changes: 0 additions & 11 deletions .github/workflows/built-branch.yml

This file was deleted.

11 changes: 0 additions & 11 deletions .github/workflows/built-tag.yml

This file was deleted.

34 changes: 0 additions & 34 deletions .github/workflows/merge-develop-to-scaffold.yml

This file was deleted.

15 changes: 0 additions & 15 deletions .github/workflows/node-tests.yml

This file was deleted.

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@v3
- uses: alleyinteractive/[email protected]
with:
plugin-file: 'plugin.php'
plugin-file: 'wp-environment-switcher.php'
upgrade-npm-dependencies: "true"
1 change: 0 additions & 1 deletion .nvmrc

This file was deleted.

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-environment-switcher" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
<description>PHP_CodeSniffer standard for wp-environment-switcher.</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_environment_switcher" />
</property>
</properties>
</rule>
Expand Down
3 changes: 0 additions & 3 deletions .stylelintrc.json

This file was deleted.

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 `WordPress Environment Switcher` 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.

47 changes: 10 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,8 @@
<!--delete-->
# Create WordPress Plugin
# WordPress Environment Switcher

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 release. A `main-built`
branch and `v0.1.0-built` tags will be created with all dependencies included
for use when submoduling a plugin. The built branches will include Composer
dependencies and any compiled front-end assets (if using them).
Contributors: srtfisher

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-environment-switcher

Stable tag: 0.1.0

Expand All @@ -41,25 +14,25 @@ Requires PHP: 8.0

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-environment-switcher/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/alleyinteractive/wp-environment-switcher/actions/workflows/coding-standards.yml)
[![Testing Suite](https://github.com/alleyinteractive/wp-environment-switcher/actions/workflows/unit-test.yml/badge.svg)](https://github.com/alleyinteractive/wp-environment-switcher/actions/workflows/unit-test.yml)

A skeleton WordPress plugin.
Easily switch between different site environments from the WordPress admin bar..

## Installation

You can install the package via composer:

```bash
composer require alleyinteractive/create-wordpress-plugin
composer require alleyinteractive/wp-environment-switcher
```

## Usage

Activate the plugin in WordPress and use it like so:

```php
$plugin = Create_WordPress_Plugin\Skeleton\Example_Plugin();
$plugin = Alley\WP\WordPress_Environment_Switcher\WordPress_Environment_Switcher\WordPress_Environment_Switcher();
$plugin->perform_magic();
```
<!--front-end-->
Expand Down Expand Up @@ -121,9 +94,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.
14 changes: 0 additions & 14 deletions babel.config.js

This file was deleted.

33 changes: 0 additions & 33 deletions blocks/README.md

This file was deleted.

Loading

0 comments on commit 8994e6d

Please sign in to comment.