info: use prob specs cache #605
Conversation
This stops baking the prob-specs data into the binary, and make `configlet info` use the cached prob-specs directory like `configlet sync`. Advantages: - The prob-specs data is updated at run time; we no longer need commits like b54fe48 or 146d41c, and can remove `prob_specs_exercises.json` - The size of the configlet executable is reduced by 12 KiB (2.5%) - Fewer lines of code: we can remove `bin/write_probspecs_info.nim` Disadvantages: - The user must now pass `-o` or `---offline` when running `configlet info` with no/limited network connectivity. - `configlet info` is slower, even when using `-o`, because we run a few `git` commands to validate the cache repo. Closes: 483
ee7
force-pushed
the
info-use-prob-specs-cache
branch
from
15ac68d
to
ad4fbc4
Compare
| @@ -1,6 +1,6 @@ | |||
| import std/[algorithm, os, sequtils, sets, strformat, strutils, sugar, terminal] | |||
| import pkg/jsony | |||
| import ".."/[cli, types_track_config] | |||
| import ".."/[cli, sync/probspecs, types_track_config] | |||
There was a problem hiding this comment.
We could refactor later so that the types/procedures for cloning and validating prob-specs are in a common location.
| exerciseFmt*: string | ||
| updateFmt*: bool | ||
| yesFmt*: bool | ||
| of actInfo: | ||
| offlineInfo*: bool | ||
| of actSync: | ||
| exercise*: string | ||
| offline*: bool |
There was a problem hiding this comment.
offline and offlineInfo is consistent with e.g. exercise and exerciseFmt. But maybe it's better to move to offlineSync and exerciseSync later.
As a reminder, they can't both be called offline unless we make --offline a global flag. The relevant RFC is nim-lang/RFCs#368.
There was a problem hiding this comment.
Still waiting for the PR to implement that RFC...
| func isOffline(conf: Conf): bool = | ||
| (conf.action.kind == actSync and conf.action.offline) or | ||
| (conf.action.kind == actInfo and conf.action.offlineInfo) |
There was a problem hiding this comment.
Similarly, more clunky than usual. It'd be nice if something like this were possible:
func isOffline(conf: Conf): bool =
conf.action.kind in {actInfo, actSync} and conf.action.offlineor just
if conf.action.offlineThere was a problem hiding this comment.
if conf.action.offline
That would be sweet. We'll just have to wait I guess 🤷
This stops baking the prob-specs data into the binary, and makes
configlet infouse the cached prob-specs directory likeconfiglet sync.Advantages:
commits like b54fe48 or 146d41c, and can remove
prob_specs_exercises.jsonbin/write_probspecs_info.nimDisadvantages:
-oor---offlinewhen runningconfiglet infowith no/limited network connectivity.configlet infois slower, even when using-o, because we run a fewgitcommands to validate the cache repo.Closes: #483