Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wp-digital/wp-cli-scaffold-theme-command
https://github.com/wp-digital/wp-cli-scaffold-theme-command
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/wp-digital/wp-cli-scaffold-theme-command
- Owner: wp-digital
- Created: 2018-12-13T16:28:43.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-25T11:31:30.000Z (about 5 years ago)
- Last Synced: 2024-04-02T17:44:05.895Z (9 months ago)
- Language: PHP
- Size: 64.5 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
innocode-digital/wp-cli-scaffold-theme-command
==============================================
Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
## Using
This package implements the following command:
### wp scaffold theme
Generates starter code for a theme based on Innocode theme skeleton.
wp scaffold theme [--activate] [--enable-network] [--name=] [--author=] [--author_uri=] [--force]
See the [WP Theme Skeleton](https://github.com/innocode-digital/wp-theme-skeleton) for more details.
**OPTIONS**
The slug for the new theme.
[--activate]
Activate the newly downloaded theme.
[--enable-network]
Enable the newly downloaded theme for the entire network.
[--name=]
What to put in the 'Theme Name:' header in 'style.css'. Default is with uppercase first letter.
[--version=]
What to put in the 'Version:' header in 'style.css' and in the 'version' property in 'composer.json' and 'package.json' files. Default is '1.0.0'.
[--description=]
What to put in the 'Description:' header in 'style.css' and in the 'description' property in 'composer.json' and 'package.json' files. Default is ''.
[--author=]
What to put in the 'Author:' header in 'style.css'. Default is 'Innocode'.
[--author_uri=]
What to put in the 'Author URI:' header in 'style.css'. Default is 'https://innocode.com/'.
[--text_domain=]
What to put in the 'Text Domain:' header in 'style.css'. Default is .
[--repo=]
What is a repo on Github for this project. Default is 'innocode-digital/'.
[--force]
Overwrite files that already exist.
[--skeleton_source=]
What is a source of skeleton theme. Possible values are 'github' and 'zip'. Default is 'github'.
[--source_username=]
What is a username on Github. Default is 'innocode-digital'.
[--source_repo=]
What is a repository on Github. No need to use it when is 'zip'. Default is 'wp-theme-skeleton'.
[--source_url=]
What is an URL of source. Applicable only when is 'zip'.
[--skip-env]
Don't generate .env file.
[--skip-install-notice]
Don't show notice about need to run installation commands.
## Installing
Installing this package requires WP-CLI v2.0.0 or greater. Update to the latest stable release with `wp cli update`.
Once you've done so, you can install this package with:
wp package install innocode-digital/wp-cli-scaffold-theme-command
To be able to authenticate to Github, so it will be possible to retrieve your user data and insert
into `composer.json` as author as well as into `package.json` as contributor during scaffolding and
also in case when you want to use private skeleton repository, you need to add token with one of
the following methods:
* Add to your local `auth.json` OAuth token from the command line:
~~~
composer config -g github-oauth.github.com xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
~~~
* Add to your local `auth.json` OAuth token manually in `$HOME/.composer/auth.json`:
~~~
{
"github-oauth": {
"github.com": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}
~~~
* Define `GITHUB_PAT` constant in `wp-config.php`:
~~~
define( 'GITHUB_PAT', 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' );
~~~
To generate token go to [Settings / Developer settings](https://github.com/settings/tokens).
Token should has at least next scopes:
* `repo` - Full control of private repositories
* `user`
* `read:user` - Read all user profile data