Skip to content

docs: improve help text for --defaultThemeVariants CLI flag #4154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PKulkoRaccoonGang wants to merge 1 commit into
base: release-23.x
Choose a base branch
from
+14 −2
Open

docs: improve help text for --defaultThemeVariants CLI flag #4154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion bin/paragon-scripts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,11 @@ const COMMANDS = {
},
{
name: '--defaultThemeVariants',
description: `Specifies default theme variants. Defaults to a single 'light' theme variant.
description: `Specifies which theme variants are marked as defaults in the generated theme-urls.json.
Consuming applications (Open edX micro-frontends) use theme-urls.json to determine
which theme CSS files to load; variants listed here are loaded automatically without
requiring explicit configuration. Variants not listed as defaults are still built and
available but must be explicitly selected by the consuming application.
You can provide multiple default theme variants by passing multiple values, for
example: \`--defaultThemeVariants light dark\`
`,
Expand Down
10 changes: 9 additions & 1 deletion lib/__tests__/help.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,15 @@ describe('helpCommand', () => {
expect(console.log).toHaveBeenCalledWith(
expect.stringContaining(`${chalk.yellow.bold('--defaultThemeVariants')} ${chalk.grey('Default: light')}`),
);
expect(console.log).toHaveBeenCalledWith(expect.stringContaining('Specifies default theme variants'));
expect(console.log).toHaveBeenCalledWith(
expect.stringContaining('Specifies which theme variants are marked as defaults in the generated theme-urls.json.'),
);
expect(console.log).toHaveBeenCalledWith(
expect.stringContaining('Consuming applications (Open edX micro-frontends) use theme-urls.json'),
);
expect(console.log).toHaveBeenCalledWith(
expect.stringContaining('Variants not listed as defaults are still built and'),
);
expect(console.log).toHaveBeenCalledWith(expect.stringContaining('You can provide multiple default theme variants'));
expect(console.log).toHaveBeenCalledWith(expect.stringContaining('example: `--defaultThemeVariants light dark`'));
/* eslint-enable no-console */
Expand Down