codelenny / bike-workout-dsl Goto Github PK

Simplify the compiler by using a lexer instead of using grammar roles for everything.

Variables should be defined in:

• Provided configuration (key-value)
• Global plan (could also define the possible configurations passed in)
• As entry, in workout or inside loop
• As loop iteration variable ($i)

And variables should be usable as raw values or as math (${i - 1}) in:

• Strength
• Duration
• Names

Produce step-by-step guides for writing a new workout plan.

Basics

• Define an activity (5m at 50% FTP)
• Add attributes (name, description, messages)
• Define loop
• Add metadata?

Programming

• Use variables (loop variable from 100 - 150 to set FTP interval)
• Define free-standing variable
• Use scopes for variable scoping
• Define macro/function
• Declare variables for user input

Allow the user to specify the values of variables as CLI arguments

Allow looping sections, such as intervals

"Intervals" 5 times {
  "Activity 1" ...
}

"Intervals" $i 0 to 5 {
  "Activity 1" ...
}

"Intervals" $i 1 to 10 by 2 {
  "Activity 1" ...
}

Define the following words, and link to them throughout the documentation:

• FTP
• FTHR

It would be good for workout files to be (optionally) named with a date template such as $YYYY-$MM-$DD_Workout_1.

• Support metadata specifying a time offset between activities
• Add CLI option --start-date to specify the first workout date
• Add CLI option --date-prefix to prefix output files
• Update Workout#getFileName to optionally prefix dates

The FIT specification allows multiple FIT files to be concatted into a single file.

1. Would this accomplish what the Plan class does (bundling workouts)?
2. Would the bundled file actually be useful to users, with devices currently on the market?

If so, add a compilation config/flag/variable, and concat workouts after compiling fit files (potentially tweaking the compilation for each workout to support the concat)

(See section 3.3.4 Chained FIT files in D00001275 Flexible & Interoperable Data Transfer (FIT) Protocol Rev 2.3, included in ANT's FIT SDK)

Write the text section of the output files to supply commentary with timestamps.

• Compile and output files
• Add option for FTP
• Add documentation for running CLI in README
• Add entrypoint to package.json

Like codecov, put a URL to the latest documentation preview (e.g. https://codelenny.gitlab.io/-/bike-workout-dsl/-/jobs/195760938/artifacts/docs/out/index.html) in pull requests, as a GitLab CI post-script command.

• Add package script and ensure correct files are included (including TS)
• Run package and deploy locally to test (and reserve powergful)
• Add CI script to package

• Output filename
• Global/per-workout variables
• Short description

See Workout#getFileName for example.

Let activities be defined as a constant or function, and then instantiated inside a workout

Allow target strength to be specified as a gradient, e.g. 5..10w (or ->? 5 to 10w?)

Will allow using BPM/FTHR modes

Allow users to leave dialog entries, either for between activities or at specific times, as raw entries, instead of inside activities.

• Create landing page
• Build docs in CI
• Add API documentation
• Add grammar documentation (with railroad diagrams)
• Add tutorial to walk-through creating a workout file
• Publish docs for dev
• Publish docs for production (on master)

Instead of creating lots of compiled grammars, just compile the grammar once, and change the grammar's "start":

const ActivityName = nearley.Grammar.fromCompiled(Activity);
ActivityName.start = "ActivityName";

(Syntax has been tested)

This will:

• Improve compile time
• Reduce the complexity of the Jakefile
• Fix coverage being split
• Allow better coverage as any method can be called