[BD-46] feat: help command for Paragon CLI #2603

monteri · 2023-09-07T14:28:14Z

Description

PR includes:

new help command
new structure for COMMANDS object with commented example
documentation in the README.md
new support for paragon install-theme <theme> that can receive <theme> parameter

Merge Checklist

If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
Does your change adhere to the documented style conventions?
Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
Were your changes tested in the example app?
Is there adequate test coverage for your changes?
Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

Verify your changes were released to NPM at the expected version.
If you'd like, share your contribution in #show-and-tell.
🎉 🙌 Celebrate! Thanks for your contribution.

openedx-webhooks · 2023-09-07T14:28:20Z

Thanks for the pull request, @monteri!

When this pull request is ready, tag your edX technical lead.

netlify · 2023-09-07T14:28:21Z

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`3d463de`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/65083d9e74715300083cad64
😎 Deploy Preview	https://deploy-preview-2603--paragon-openedx.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

monteri · 2023-09-07T14:31:47Z

lib/install-theme.js

+  if (process.argv.length === 4) {
+    const providedTheme = process.argv[3];
+    installTheme(providedTheme);


I decided to add it in this PR since it is small and I could use newly created help command functionality to describe it straight away.

codecov · 2023-09-07T14:47:38Z

Codecov Report

Patch coverage has no change and project coverage change: +0.12% 🎉

Comparison is base (4fee4cc) 91.69% compared to head (3d463de) 91.81%.
Report is 21 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2603      +/-   ##
==========================================
+ Coverage   91.69%   91.81%   +0.12%     
==========================================
  Files         235      235              
  Lines        4214     4217       +3     
  Branches     1021     1020       -1     
==========================================
+ Hits         3864     3872       +8     
+ Misses        346      341       -5     
  Partials        4        4

Files Changed	Coverage Δ
src/SearchField/SearchFieldAdvanced.jsx	`90.47% <ø> (ø)`

... and 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

PKulkoRaccoonGang · 2023-09-07T15:02:55Z

bin/paragon-scripts.js

+  //     ...
+  //   ],
+  //   ********** Block for help command end **********
+  // },


Does it make sense to use the syntax to describe JSDocs?

PKulkoRaccoonGang · 2023-09-07T15:05:41Z

bin/paragon-scripts.js

@@ -1,26 +1,68 @@
 #!/usr/bin/env node
+/* eslint-disable no-console */


You turned off the linter for the entire page, even though you're only using console.log in one place. Should I turn off the linter rule only in one place?

it is used twice there but I agree for two cases it is good idea.

bin/paragon-scripts.js

PKulkoRaccoonGang · 2023-09-07T15:09:27Z

bin/paragon-scripts.js

+    return;
+  }
+
+  if (command === 'help') {


Is it necessary to move the word help into a constant with a meaningful name?

PKulkoRaccoonGang · 2023-09-07T15:14:40Z

lib/install-theme.js

-  const answers = await promptUserForTheme();
-  installTheme(answers.theme);
+  // Check if the user passed a theme parameter as a command-line argument
+  if (process.argv.length === 4) {


Can we give a meaningful name for this expression? This way you can remove the redundant comment

PKulkoRaccoonGang · 2023-09-07T15:15:07Z

lib/help.js

+ */
+function padLeft(description, offsetString) {
+  // Calculate the necessary padding based on the offsetString length
+  const padding = ' '.repeat(Math.max(0, DESCRIPTION_PAD - offsetString.length));


Can we give a meaningful name for this constant? This way you can remove the redundant comment

I think it is descriptive right now. Meaningful variable name would be very long

lib/install-theme.js

bin/paragon-scripts.js

lib/help.js

openedx-webhooks · 2023-09-20T08:57:08Z

@monteri 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-semantic-release · 2023-09-20T09:17:21Z

🎉 This PR is included in version 21.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

edx-semantic-release · 2023-09-22T13:21:30Z

🎉 This PR is included in version 22.0.0-alpha.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

feat: help command for Paragon CLI

c3ca114

openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label Sep 7, 2023

feat: remove console log

c73c078

monteri commented Sep 7, 2023

View reviewed changes

PKulkoRaccoonGang reviewed Sep 7, 2023

View reviewed changes

monteri mentioned this pull request Sep 8, 2023

[BD-46] feat: move CLI design tokens commands to paragon CLI #2609

Merged

10 tasks

feat: PR comments update

032e705

monteri requested review from adamstankiewicz and viktorrusakov September 14, 2023 08:44

viktorrusakov reviewed Sep 14, 2023

View reviewed changes

lib/install-theme.js Outdated Show resolved Hide resolved

bin/paragon-scripts.js Show resolved Hide resolved

lib/help.js Outdated Show resolved Hide resolved

feat: update commands code

3d463de

monteri requested review from viktorrusakov and PKulkoRaccoonGang September 18, 2023 12:08

viktorrusakov approved these changes Sep 20, 2023

View reviewed changes

viktorrusakov merged commit c778061 into openedx:master Sep 20, 2023
9 checks passed

edx-semantic-release added the released label Sep 20, 2023

viktorrusakov linked an issue Sep 21, 2023 that may be closed by this pull request

[CLI improvements] Help command #2544

Closed

edx-semantic-release added the released on @alpha label Sep 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BD-46] feat: help command for Paragon CLI #2603

[BD-46] feat: help command for Paragon CLI #2603

monteri commented Sep 7, 2023

openedx-webhooks commented Sep 7, 2023

netlify bot commented Sep 7, 2023 •

edited

Loading

monteri Sep 7, 2023

codecov bot commented Sep 7, 2023 •

edited

Loading

PKulkoRaccoonGang Sep 7, 2023

PKulkoRaccoonGang Sep 7, 2023

monteri Sep 8, 2023

PKulkoRaccoonGang Sep 7, 2023

PKulkoRaccoonGang Sep 7, 2023

PKulkoRaccoonGang Sep 7, 2023

monteri Sep 8, 2023 •

edited

Loading

openedx-webhooks commented Sep 20, 2023

edx-semantic-release commented Sep 20, 2023

edx-semantic-release commented Sep 22, 2023

		@@ -1,26 +1,68 @@
		#!/usr/bin/env node
		/* eslint-disable no-console */

[BD-46] feat: help command for Paragon CLI #2603

[BD-46] feat: help command for Paragon CLI #2603

Conversation

monteri commented Sep 7, 2023

Description

Merge Checklist

Post-merge Checklist

openedx-webhooks commented Sep 7, 2023

netlify bot commented Sep 7, 2023 • edited Loading

✅ Deploy Preview for paragon-openedx ready!

monteri Sep 7, 2023

Choose a reason for hiding this comment

codecov bot commented Sep 7, 2023 • edited Loading

Codecov Report

PKulkoRaccoonGang Sep 7, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Sep 7, 2023

Choose a reason for hiding this comment

monteri Sep 8, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Sep 7, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Sep 7, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Sep 7, 2023

Choose a reason for hiding this comment

monteri Sep 8, 2023 • edited Loading

Choose a reason for hiding this comment

openedx-webhooks commented Sep 20, 2023

edx-semantic-release commented Sep 20, 2023

edx-semantic-release commented Sep 22, 2023

netlify bot commented Sep 7, 2023 •

edited

Loading

codecov bot commented Sep 7, 2023 •

edited

Loading

monteri Sep 8, 2023 •

edited

Loading