Workout file parser library, suitable for
.erg files, with first-class TypeScript support.
Install the package:
npm install @sportloop/mrc
;;console.logcourseHeader.description; // > Spin at 30% FTP for a few minutes, then two back to back sprints and easy spin again.console.logcourseData; // > [0, 30]// Transform back to .mrc;
The difference between
.mrc is that
.erg always contains all information required to execute the workout, while
.mrc can be supplied with information, like FTP during execution time. Because of this, when using
.erg you should either use
WATTS as unit of course data or provide the
FTP field, as seen in examples in files folder.
Run tests in watch mode:
npm test -w
Once you're happy with your changes, use Conventional Commits standard to create your commit messages.
To build your package, use the command:
To create a new version of this package to deploy to NPM or the package repository of your choice, use:
npm run sv
Finally, make sure everything is up to date with your version control with
git push --follow-tags and then to publish your package, use:
Alternatively you can use the GitHub Worflow, by triggering a release - going to Releases -> Draft a new release. This will do the above for you, as well as publish it to GitHub's NPM Mirror. If you want to use this method, you need to edit Publish Workflow file by replacing
your-github-username with your GitHub username and adding the
npm_token secret in settings.