The current documentation testing workflow is quite complicated, especially the part, where "localFiles" key needs to be added to JSON configuration. We can simplify this by adding few command line options to docucheck to speedup this process.
Proposed changes
Add -t path | --test path option to set path to source repository.
Usage of this option has the same effect as "localFiles" key in configuration JSON
Multiple test switches can be used at once.
docucheck will determine repository identifier from the path automatically, unless -tr | --testRepo switch doesn't precede the switch. See examples below.
Add -tr repo-id | --testRepo repo-id to use custom repository identifier for the next --test | -t switch
This is useful in situations when you have cloned local files at path that cannot match repository identifier.
Optimize "localFiles" implementation. Currently it makes a deep copy of the repository, instead of just use files directly from the different repository location.
Examples
-t ../server/poweraut-server
will set localFiles for application powerauth-server
The current documentation testing workflow is quite complicated, especially the part, where
"localFiles"key needs to be added to JSON configuration. We can simplify this by adding few command line options todocucheckto speedup this process.Proposed changes
-t path | --test pathoption to setpathto source repository."localFiles"key in configuration JSONdocucheckwill determine repository identifier from the path automatically, unless-tr | --testReposwitch doesn't precede the switch. See examples below.-tr repo-id | --testRepo repo-idto use custom repository identifier for the next--test | -tswitchExamples
-t ../server/poweraut-serverlocalFilesfor applicationpowerauth-server-tr powerauth-server -t ../server/powerauth-server-copylocalFilesfor applicationpowerauth-server, becuase the repository is cloned under the path that doesn't match application in JSON confing.