Сreate new PostAPL plugins in a few steps:
-
Execute the wizard script. It will ask you a few questions and fill all files with your data.
npx postapl-plugin-boilerplate <directory>
Call it with
--npm
argument, if you have yarn installed, but prefer to use npm as the package manager (by default, it will automatically decide whether to use yarn or npm):node postapl-plugin-boilerplate --npm <directory>
Or use
--no-install
if you want to skip dependencies installation. -
Your plugin repository will now have a clean Git history. Create the GitHub repository and push your project there.
-
Add your project to Travis CI.
-
Write some code to
index.js
and tests toindex.test.js
. -
Execute
npm test
command -
Add input and output APL examples to
README.md
. -
Add options descriptions if your plugin has them.
-
Fill
CHANGELOG.md
with initial version. -
Release by calling
npx clean-publish
(this tool will remove development configs frompackage.json
). -
Fork PostAPL, add your plugin to the Plugins list and send a pull request.