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

monteri · 2023-09-08T14:26:56Z

Description

Include a description of your changes here, along with a link to any relevant Jira tickets and/or Github issues.

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-08T14:27:01Z

Thanks for the pull request, @monteri!

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

netlify · 2023-09-08T14:27:03Z

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`bca0f30`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/653bba6a3cdbf9000880c741
😎 Deploy Preview	https://deploy-preview-2609--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-08T14:28:29Z

I propose to add descriptions for newly added commands after the help command PR will be merged.
#2603

codecov · 2023-09-08T14:43:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.28%. Comparing base (2eae85c) to head (bca0f30).
Report is 680 commits behind head on alpha.

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #2609      +/-   ##
==========================================
+ Coverage   92.09%   93.28%   +1.19%     
==========================================
  Files         215      215              
  Lines        3616     3635      +19     
  Branches      890      898       +8     
==========================================
+ Hits         3330     3391      +61     
+ Misses        281      239      -42     
  Partials        5        5

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

viktorrusakov

@PKulkoRaccoonGang Left some initial comments, I will try to take another look later today

bin/paragon-scripts.js

viktorrusakov · 2023-10-19T08:27:04Z

bin/paragon-scripts.js

  if (command === HELP_COMMAND) {
-    helpCommand(COMMANDS);
+    helpCommand(COMMANDS, commandArgs);
    return;
  }


I think you can remove this code if you define help's executor as follows:

help: { executor: (args) => helpCommand(COMMANDS, args), ...

then try / catch below will be able to correctly execute help command

viktorrusakov · 2023-10-19T09:28:40Z

lib/build-scss.js

+      ora().succeed(chalk.underline.bold.green(`Stylesheets for ${capitalize(name)} build successfully!`));
+      // eslint-disable-next-line no-console
+      console.log();


You can avoid using console.log by adding \n to the previous line ora().succeed(chalk.underline.bold.green("Stylesheets for ${capitalize(name)} build successfully!\n"));

Also, right now it says the following when I run the command

I think it would be better to change the wording to something like this

just a suggestion (although I think we definitely need to add word theme somewhere, just saying Light / Core is not enough I think)

Yeah, it looks better

viktorrusakov · 2023-10-19T09:39:53Z

lib/build-scss.js

+function buildScssCommand(commandArgs) {
+  const argv = minimist(commandArgs);
+  const corePath = argv.corePath || path.resolve(process.cwd(), 'styles/scss/core/core.scss');
+  const themesPath = argv.themesPath || path.resolve(process.cwd(), 'styles/css/themes');
+  const outDir = argv.outDir || './dist';
+  const defaultThemeVariants = argv.defaultThemeVariants ? argv.defaultThemeVariants.split(',') : ['light'];


Reading through minimist docs I found that you can provide default values to args, I think we should try doing that, right now it looks a little dirty

this seems to work for me locally (also, I don't think you need to split defaultThemeVariants)

function buildScssCommand(commandArgs) { const defaultArgs = { corePath: path.resolve(process.cwd(), 'styles/scss/core/core.scss'), themesPath: path.resolve(process.cwd(), 'styles/css/themes'), outDir: './dist', defaultThemeVariants: 'light', }; const { corePath, themesPath, outDir, defaultThemeVariants, } = minimist(commandArgs, { default: defaultArgs });

brian-smith-tcril · 2023-10-20T17:02:34Z

README.md

+- `paragon install-theme [theme]`: Installs the specific [@edx/brand](https://github.com/edx/brand-edx.org) package.
+- `build-tokens`: Build Paragon's design tokens.
+- `replace-variables`: Replace SCSS variables usages or definitions to CSS variables and vice versa in `.scss` files.
+- `build-scss`: Compile Paragon's core and themes SCSS into CSS.


Do we prefer paragon command-name or just command-name for the README? I'm happy either way, but I think it should be consistent.

Yeah, it makes sense to be consistent, updated it to paragon command-name format

brian-smith-tcril · 2023-10-20T17:06:11Z

README.md

@@ -61,7 +61,10 @@ The Paragon CLI (Command Line Interface) is a tool that provides various utility

 ### Available Commands

- `paragon install-theme [theme]`: Installs the specific @edx/brand package.
+- `paragon install-theme [theme]`: Installs the specific [@edx/brand](https://github.com/edx/brand-edx.org) package.


This should reference the openedx brand package instead of the edx.org one

https://github.com/openedx/brand-openedx

Good point, updated, thanks.

openedx-webhooks · 2023-10-30T13:05:54Z

@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-10-30T13:36:46Z

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

The release is available on:

Your semantic-release bot 📦🚀

openedx-semantic-release-bot · 2024-05-14T15:49:43Z

🎉 This PR is included in version 23.0.0-alpha.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

* feat: move cli design tokens to paragon cli * feat: update paths for build-tokens.js * feat: added descriptions for CLI commands * refactor: removed commander implementation * refactor: added build-scss process status * feat: added ora compilation status * refactor: code refactoring * feat: added help description for single command * refactor: after review * refactor: refactoring after review * chore: update docs and cli params parsing --------- Co-authored-by: monteri <lansevermore> Co-authored-by: PKulkoRaccoonGang <[email protected]> Co-authored-by: Viktor Rusakov <[email protected]>

openedx-semantic-release-bot · 2024-12-12T02:36:02Z

🎉 This PR is included in version 23.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

monteri marked this pull request as draft September 8, 2023 14:27

monteri mentioned this pull request Sep 11, 2023

[CLI improvements] MFE migration commands for Design tokens #2545

Closed

PKulkoRaccoonGang mentioned this pull request Sep 11, 2023

[BD-46] feat: added Segment track for CLI scripts #2617

Merged

10 tasks

monteri marked this pull request as ready for review September 27, 2023 08:51

monteri and others added 4 commits September 27, 2023 12:43

feat: move cli design tokens to paragon cli

b6feb1b

feat: update paths for build-tokens.js

6b74e21

feat: added descriptions for CLI commands

9381af4

refactor: removed commander implementation

ff2569c

PKulkoRaccoonGang force-pushed the zadorozhnii/design-tokens-cli-commands branch from 7bb10d2 to ff2569c Compare September 27, 2023 09:46

PKulkoRaccoonGang added 3 commits September 27, 2023 22:14

refactor: added build-scss process status

21c659d

feat: added ora compilation status

ebba492

refactor: code refactoring

3032258

PKulkoRaccoonGang force-pushed the zadorozhnii/design-tokens-cli-commands branch 3 times, most recently from dfd8156 to b363867 Compare October 4, 2023 07:48

feat: added help description for single command

e9eedf9

PKulkoRaccoonGang force-pushed the zadorozhnii/design-tokens-cli-commands branch from b363867 to e9eedf9 Compare October 4, 2023 08:36

refactor: after review

1de83ba

PKulkoRaccoonGang force-pushed the zadorozhnii/design-tokens-cli-commands branch from 140bb96 to 1de83ba Compare October 4, 2023 09:36

PKulkoRaccoonGang requested review from adamstankiewicz and viktorrusakov October 4, 2023 13:25

viktorrusakov reviewed Oct 19, 2023

View reviewed changes

refactor: refactoring after review

db966ac

PKulkoRaccoonGang force-pushed the zadorozhnii/design-tokens-cli-commands branch from 37ee123 to db966ac Compare October 20, 2023 10:19

brian-smith-tcril reviewed Oct 20, 2023

View reviewed changes

chore: update docs and cli params parsing

bca0f30

PKulkoRaccoonGang requested a review from viktorrusakov October 30, 2023 12:48

viktorrusakov approved these changes Oct 30, 2023

View reviewed changes

viktorrusakov merged commit 75580fd into openedx:alpha Oct 30, 2023
8 checks passed

edx-semantic-release added the released on @alpha label Oct 30, 2023

openedx-semantic-release-bot added the released label Dec 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

monteri commented Sep 8, 2023

openedx-webhooks commented Sep 8, 2023 •

edited

Loading

netlify bot commented Sep 8, 2023 •

edited

Loading

monteri commented Sep 8, 2023

codecov bot commented Sep 8, 2023 •

edited

Loading

viktorrusakov left a comment

viktorrusakov Oct 19, 2023

PKulkoRaccoonGang Oct 20, 2023

viktorrusakov Oct 19, 2023 •

edited

Loading

PKulkoRaccoonGang Oct 20, 2023

viktorrusakov Oct 19, 2023

PKulkoRaccoonGang Oct 20, 2023

brian-smith-tcril Oct 20, 2023

viktorrusakov Oct 30, 2023

brian-smith-tcril Oct 20, 2023

viktorrusakov Oct 30, 2023

openedx-webhooks commented Oct 30, 2023

edx-semantic-release commented Oct 30, 2023

openedx-semantic-release-bot commented May 14, 2024

openedx-semantic-release-bot commented Dec 12, 2024

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

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

Conversation

monteri commented Sep 8, 2023

Description

Merge Checklist

Post-merge Checklist

openedx-webhooks commented Sep 8, 2023 • edited Loading

netlify bot commented Sep 8, 2023 • edited Loading

✅ Deploy Preview for paragon-openedx ready!

monteri commented Sep 8, 2023

codecov bot commented Sep 8, 2023 • edited Loading

Codecov Report

viktorrusakov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

viktorrusakov Oct 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openedx-webhooks commented Oct 30, 2023

edx-semantic-release commented Oct 30, 2023

openedx-semantic-release-bot commented May 14, 2024

openedx-semantic-release-bot commented Dec 12, 2024

openedx-webhooks commented Sep 8, 2023 •

edited

Loading

netlify bot commented Sep 8, 2023 •

edited

Loading

codecov bot commented Sep 8, 2023 •

edited

Loading

viktorrusakov Oct 19, 2023 •

edited

Loading