2.0.0 • Published 9 months ago
create-redcap-module v2.0.0
create-redcap-module
A simple CLI tool to generate new REDCap external modules.
Requirements
- Node.js (developed with v16.20.0, not tested on other versions)
How to use
Please check the documentation for detailed instructions.
Navigate into your redcap modules folder
cd modulesRun the module generator directly over npx
npx create-redcap-moduleAfter completing the necessary input, a module folder will be available at /redcap/modules/.
Development
Feature and pull requests are welcome.
Running the CLI locally:
1. Clone the repo.
2. Run node ./path-to-module/bin/create-redcap-module
(please ensure your node version is set to required version ,see .nvmrc)
Roadmap
Optimize template generation- Add more features to template(s) (BabelJS, phpunit, composer, ..)
- Add more template variations (Action Tag, API Extension, ..)
Add help option/explanation to CLI (optionator)
Automatic npm publishing flow (@release)
Changelog
| Version | Description |
|---|---|
| v1.0.0 | Initial release. |
| v1.0.1 | Added first features. |
| v1.1.0 | Rewrite of most parts. |
| v1.1.1 | Update Readme(s). |
| v1.1.2 | Fix path building cross platform. |
| v1.2.0 | Add features through composer: Psalm, PHPUnit and varDump. |
| v1.3.1 | Upgrade REDCap Framework version, upgrade npm dependecies |
| v2.0.0 | Update package dependencies, REDCap Framework version, remove psalm task (covered by framework itself) |