add: commander to optionally provide delete or download along with st…

brown-ccv / honeycomb

Starter repo for jspsych/react/electron behavioral tasks

https://brown-ccv.github.io/honeycomb-docs/

MIT License

9 stars 8 forks source link

add: commander to optionally provide delete or download along with st… #516

Closed YUUU23 closed 1 month ago

YUUU23 commented 2 months ago

import commander and initialize commander to be used
when no command provided, default action is to run main() as before, all prompts will be asked
- checks if the studyID / participantID passed in through argument are valid, return from main() if not (validating functions originally in prompt functions are pulled out for this purpose)
when user runs npm run cli download [study ID] [participant ID] or npm run cli delete [study ID] [participant ID], relative global variables (ACTION, STUDY_ID, PARTICIPANT_ID) are set to what's provided through command line input, skipping those prompts since we have a value assigned to the global variables already
- A message is also printed out to let user know which action and args are passed in through the command line
- Tested by interacting with the command line with different combinations

I accidentally pushed the code to the actual feat-v4 branch, but I reverted this commit (now in this PR)! Sorry about this

github-actions[bot] commented 2 months ago

Visit the preview URL for this PR (updated for commit 1cc9e92):

https://ccv-honeycomb--pr516-add-commander-9itykqix.web.app

_{(expires Wed, 21 Aug 2024 06:47:16 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 4ace1dcea913a952d2a1af84b94a4421bf36e610}

RobertGemmaJr commented 2 months ago

Actually @YUUU23 can you test what this PR would look like if merging into v3.4.2? All of the commander stuff with the CLI script should't have to wait until v4 to work but I'm not entirely sure.

YUUU23 commented 2 months ago

Actually @YUUU23 can you test what this PR would look like if merging into v3.4.2? All of the commander stuff with the CLI script should't have to wait until v4 to work but I'm not entirely sure.

It seems like all the forward commits for v4 features would also be on this branch to be merged into 3.4.2. Do you know if it's possible to rebase on a branch with less features that would delete those v4 features 3.4.2 doesn't have? Otherwise, I think I can also move the CLI script code into a new branch based off of 3.4.2 and open a new PR since the CLI code are all in one file.

RobertGemmaJr commented 1 month ago

To have this in writing - let's leave it as a change for v4 for right now. Eventually we will release the version and we can include a quick write up for bringing the CLI script into older versions of Honeycomb

YUUU23 commented 1 month ago

I commented to simplify some logical expressions. Looks like Rob reviewed this quite a bit ! Small changes, otherwise looks good to go !

Thank you so much for reviewing this!!

YUUU23 commented 1 month ago

Reverted changes Most recent changes in this PR: https://github.com/brown-ccv/honeycomb/pull/531