create-phtml-plugin

create-phtml-plugin

Create pHTML Plugin lets you quickly create new pHTML plugins with documentation, tests, and built in compiling for supported Node environments.

npm init phtml-plugin YOUR_DESTINATION

npx create-phtml-plugin YOUR_DESTINATION

After completing the instructions, write your plugin to src/index.js and update README.md with further details outlining your plugin functionality.

Options

You can pass options into phtml-plugin to automate plugin creation.

to

The to argument defines the destination of the new project. The first undefined argument will also determine this value.

npm init phtml-plugin --to path/to/plugin

title

The title argument defines the formal name of the project.

npm init phtml-plugin --title Super

npm init phtml-plugin --title "Awesome Blossom"

id

The id argument defines the id used by the project package.json and repository.

npm init phtml-plugin --id awes-blos

desc

The desc or description argument defines the description used by the project README.md and package.json.

# becomes "Use exciting new functions" and "Awesome Blossom lets you create new functions in HTML."
npm init phtml-plugin --desc "use exciting new functions"

# becomes "Use exciting new functions" and "Awesome Blossom lets you create new functions in HTML."
npm init phtml-plugin --description "use exciting new functions"

author

The author argument defines the author used by the project package.json.

npm init phtml-plugin --author "Joe Bloggs"

email

The email argument defines the email used by the project package.json.

npm init phtml-plugin --email "jonathantneal@hotmail.com"

user

The user argument defines the repository user or group hosting the project.

npm init phtml-plugin --user "phtmlorg"

keywords

The keywords argument defines the keywords used by the project package.json.

npm init phtml-plugin --keywords "awesome,blossom"

no-install

The no-install argument instructs the project to not automatically install dependencies.

npm init phtml-plugin --no-install