Skip to content

feat: add start:with-theme and build:with-theme NPM scripts with Paragon CLI #641

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

Draft
adamstankiewicz wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat: add start:with-theme and build:with-theme NPM scripts with Paragon CLI #641

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f990ab8
feat: add start:with-theme and build:with-theme NPM scripts with Para…
adamstankiewicz Aug 23, 2023
3503158
fix: update package-lock.json
adamstankiewicz Aug 23, 2023
ba328da
chore: wip
adamstankiewicz Sep 19, 2023
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
Prev Previous commit
chore: wip
  • Loading branch information
@adamstankiewicz
adamstankiewicz committed Sep 19, 2023
commit ba328da06c2c37dc6a3f50dd414bf0d415070b98
182 changes: 82 additions & 100 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"lint:fix": "fedx-scripts eslint --fix --ext .js --ext .jsx .",
"snapshot": "fedx-scripts jest --updateSnapshot",
"start": "fedx-scripts webpack-dev-server --progress",
"start:with-theme": "paragon install-theme && npm start",
"start:with-theme": "paragon install-theme --brand=@edx/brand-edx.org@latest && npm start",
Copy link
Contributor

@arbrandes arbrandes Sep 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be made generic, somehow? Otherwise, the command would warrant being called start:with-edx-theme... and in that case, including it here would be debatable.

Copy link
Member Author

@adamstankiewicz adamstankiewicz Sep 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arbrandes Ah, yes. Let me mark this PR as a draft as it's still in flux a bit. The paragon install-theme command does now accept a --brand argument for more programmatic usage of the CLI tool (e.g., in build+deploy processes, if needed). But, we do not intend to include --brand as part of the NPM scripts in MFEs.

Instead, if the --brand argument is not passed, it prompts the user in terminal for the name/version of an NPM package to install as the @edx/brand alias instead.

We also heard some feedback recently, where a third usage pattern for this command might be a Git-ignored config file where an engineer could specify something like the following to persist the custom @edx/brand theme selection without requiring manual input each time.

// paragon-cli.config.js, gitignored
{
  'commands': {
    'install-theme': {
      'brand': '@edx/brand-edx.org@latest',
    }
}

Copy link
Contributor

@arbrandes arbrandes Sep 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latter looks like a neat way out!

"test": "fedx-scripts jest --coverage --passWithNoTests"
},
"husky": {
Expand All @@ -36,10 +36,10 @@
},
"dependencies": {
"@edx/brand": "npm:@edx/[email protected]",
"@edx/frontend-component-footer": "12.2.0",
"@edx/frontend-component-footer": "12.2.1",
"@edx/frontend-component-header": "4.6.0",
"@edx/frontend-platform": "5.1.0",
"@edx/paragon": "21.1.2",
"@edx/frontend-platform": "4.6.3",
"@edx/paragon": "21.1.6",
"@fortawesome/fontawesome-svg-core": "1.2.36",
"@fortawesome/free-brands-svg-icons": "5.15.4",
"@fortawesome/free-regular-svg-icons": "5.15.4",
Expand All @@ -50,8 +50,8 @@
"react": "17.0.2",
"react-dom": "17.0.2",
"react-redux": "7.2.9",
"react-router": "6.15.0",
"react-router-dom": "6.15.0",
"react-router": "5",
"react-router-dom": "5",
"redux": "4.2.1",
"regenerator-runtime": "0.13.11"
},
Expand Down