A Seneca.js tool to check plugins
seneca-skeleton
A Seneca tool to check conformance of plugins with others
- Version: 0.0.1
- Node: 0.10, 0.12, 4
If you are new to Seneca in general, please take a look at senecajs.org. We have everything from tutorials to sample apps to help get you up and running quickly.
If you're using this module, and need help, you can:
- Post a github issue,
- Tweet to @senecajs,
- Ask on the Gitter.
Install
To install from master, simply use npm link.
git clone https://github.com/maxired/seneca-check-plugin
cd seneca-check-plugin
npm install
npm link
Quick Example
Before started, be sure to be in a clean directory.
Running the script will create two directory, default
and to-check
The goal
seneca-check-plugin <githubUsername/githubRepo>
If everything look goods you should see the following message: everything looks good
In case of error, it will be described in the command line
What you want do is going inside the to-check
directory and fix your error
Then, go back in the previous directory and run
seneca-check-plugin continue
Proceed the same way as long as your have error.
Then, it says that your project is good. this is ONLY REGARDING BASIC ATTRIBUTES
If you change anything to your code, or package.json, please run npm install
and npm test
before going further
More Info ?
seneca-check-plugin --help
Usage: seneca-check-plugin [options] TOCHECK
Options:
-h, --help output usage information
-V, --version output the version number
-m,--model <model> The Repo we will check TOCHECK against
-f,--fix Should we try to automattically solve some issues
Syntax for MODEL and TOCHECK :
MODEL AND TOCHECK are github repository identifiant. They should follow the syntax Username/Repo.
For example, the defaut MODEL is maxired/seneca-skeleton
It corresponds to the repo seneca-skeleton from user maxired
And can be access at https://github.com/maxired/seneca-skeleton
if TOCHECK equal "continue", then the last check will be continued
Examples :
seneca-check-plugin senecajs/seneca-level-store
seneca-check-plugin continue
Contributing
The Senecajs org encourages open participation. If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.
License
Copyright Richard Rodger and other contributors 2015, Licensed under MIT.