-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #583 from openedx/master
sync: master to alpha
- Loading branch information
Showing
19 changed files
with
2,263 additions
and
2,431 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| const path = require('path'); | ||
| const fs = require('fs'); | ||
|
|
||
| /** | ||
| * Retrieves the name of the brand package from the given directory. | ||
| * | ||
| * @param {string} dir - The directory path containing the package.json file. | ||
| * @return {string} The name of the brand package, or an empty string if not found. | ||
| */ | ||
| function getBrandPackageName(dir) { | ||
| const appDependencies = JSON.parse(fs.readFileSync(path.resolve(dir, 'package.json'), 'utf-8')).dependencies; | ||
| return Object.keys(appDependencies).find((key) => key.match(/@(open)?edx\/brand/)) || ''; | ||
| } | ||
|
|
||
| /** | ||
| * Attempts to extract the Paragon version from the `node_modules` of | ||
| * the consuming application. | ||
| * | ||
| * @param {string} dir Path to directory containing `node_modules`. | ||
| * @returns {string} Paragon dependency version of the consuming application | ||
| */ | ||
| function getParagonVersion(dir, { isBrandOverride = false } = {}) { | ||
| const npmPackageName = isBrandOverride ? getBrandPackageName(dir) : '@openedx/paragon'; | ||
| const pathToPackageJson = `${dir}/node_modules/${npmPackageName}/package.json`; | ||
| if (!fs.existsSync(pathToPackageJson)) { | ||
| return undefined; | ||
| } | ||
| return JSON.parse(fs.readFileSync(pathToPackageJson, 'utf-8')).version; | ||
| } | ||
|
|
||
| /** | ||
| * @typedef {Object} ParagonThemeCssAsset | ||
| * @property {string} filePath | ||
| * @property {string} entryName | ||
| * @property {string} outputChunkName | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {Object} ParagonThemeVariantCssAsset | ||
| * @property {string} filePath | ||
| * @property {string} entryName | ||
| * @property {string} outputChunkName | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {Object} ParagonThemeCss | ||
| * @property {ParagonThemeCssAsset} core The metadata about the core Paragon theme CSS | ||
| * @property {Object.<string, ParagonThemeVariantCssAsset>} variants A collection of theme variants. | ||
| */ | ||
|
|
||
| /** | ||
| * Attempts to extract the Paragon theme CSS from the locally installed `@openedx/paragon` package. | ||
| * @param {string} dir Path to directory containing `node_modules`. | ||
| * @param {boolean} isBrandOverride | ||
| * @returns {ParagonThemeCss} | ||
| */ | ||
| function getParagonThemeCss(dir, { isBrandOverride = false } = {}) { | ||
| const npmPackageName = isBrandOverride ? getBrandPackageName(dir) : '@openedx/paragon'; | ||
| const pathToParagonThemeOutput = path.resolve(dir, 'node_modules', npmPackageName, 'dist', 'theme-urls.json'); | ||
|
|
||
| if (!fs.existsSync(pathToParagonThemeOutput)) { | ||
| return undefined; | ||
| } | ||
| const paragonConfig = JSON.parse(fs.readFileSync(pathToParagonThemeOutput, 'utf-8')); | ||
| const { | ||
| core: themeCore, | ||
| variants: themeVariants, | ||
| defaults, | ||
| } = paragonConfig?.themeUrls || {}; | ||
|
|
||
| const pathToCoreCss = path.resolve(dir, 'node_modules', npmPackageName, 'dist', themeCore.paths.minified); | ||
| const coreCssExists = fs.existsSync(pathToCoreCss); | ||
|
|
||
| const themeVariantResults = Object.entries(themeVariants || {}).reduce((themeVariantAcc, [themeVariant, value]) => { | ||
| const themeVariantCssDefault = path.resolve(dir, 'node_modules', npmPackageName, 'dist', value.paths.default); | ||
| const themeVariantCssMinified = path.resolve(dir, 'node_modules', npmPackageName, 'dist', value.paths.minified); | ||
|
|
||
| if (!fs.existsSync(themeVariantCssDefault) && !fs.existsSync(themeVariantCssMinified)) { | ||
| return themeVariantAcc; | ||
| } | ||
|
|
||
| return ({ | ||
| ...themeVariantAcc, | ||
| [themeVariant]: { | ||
| filePath: themeVariantCssMinified, | ||
| entryName: isBrandOverride ? `brand.theme.variants.${themeVariant}` : `paragon.theme.variants.${themeVariant}`, | ||
| outputChunkName: isBrandOverride ? `brand-theme-variants-${themeVariant}` : `paragon-theme-variants-${themeVariant}`, | ||
| }, | ||
| }); | ||
| }, {}); | ||
|
|
||
| if (!coreCssExists || themeVariantResults.length === 0) { | ||
| return undefined; | ||
| } | ||
|
|
||
| const coreResult = { | ||
| filePath: path.resolve(dir, pathToCoreCss), | ||
| entryName: isBrandOverride ? 'brand.theme.core' : 'paragon.theme.core', | ||
| outputChunkName: isBrandOverride ? 'brand-theme-core' : 'paragon-theme-core', | ||
| }; | ||
|
|
||
| return { | ||
| core: fs.existsSync(pathToCoreCss) ? coreResult : undefined, | ||
| variants: themeVariantResults, | ||
| defaults, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * @typedef CacheGroup | ||
| * @property {string} type The type of cache group. | ||
| * @property {string|function} name The name of the cache group. | ||
| * @property {function} chunks A function that returns true if the chunk should be included in the cache group. | ||
| * @property {boolean} enforce If true, this cache group will be created even if it conflicts with default cache groups. | ||
| */ | ||
|
|
||
| /** | ||
| * @param {ParagonThemeCss} paragonThemeCss The Paragon theme CSS metadata. | ||
| * @returns {Object.<string, CacheGroup>} The cache groups for the Paragon theme CSS. | ||
| */ | ||
| function getParagonCacheGroups(paragonThemeCss) { | ||
| if (!paragonThemeCss) { | ||
| return {}; | ||
| } | ||
| const cacheGroups = { | ||
| [paragonThemeCss.core.outputChunkName]: { | ||
| type: 'css/mini-extract', | ||
| name: paragonThemeCss.core.outputChunkName, | ||
| chunks: chunk => chunk.name === paragonThemeCss.core.entryName, | ||
| enforce: true, | ||
| }, | ||
| }; | ||
|
|
||
| Object.values(paragonThemeCss.variants).forEach(({ entryName, outputChunkName }) => { | ||
| cacheGroups[outputChunkName] = { | ||
| type: 'css/mini-extract', | ||
| name: outputChunkName, | ||
| chunks: chunk => chunk.name === entryName, | ||
| enforce: true, | ||
| }; | ||
| }); | ||
| return cacheGroups; | ||
| } | ||
|
|
||
| /** | ||
| * @param {ParagonThemeCss} paragonThemeCss The Paragon theme CSS metadata. | ||
| * @returns {Object.<string, string>} The entry points for the Paragon theme CSS. Example: ``` | ||
| * { | ||
| * "paragon.theme.core": "/path/to/node_modules/@openedx/paragon/dist/core.min.css", | ||
| * "paragon.theme.variants.light": "/path/to/node_modules/@openedx/paragon/dist/light.min.css" | ||
| * } | ||
| * ``` | ||
| */ | ||
| function getParagonEntryPoints(paragonThemeCss) { | ||
| if (!paragonThemeCss) { | ||
| return {}; | ||
| } | ||
|
|
||
| const entryPoints = { [paragonThemeCss.core.entryName]: path.resolve(process.cwd(), paragonThemeCss.core.filePath) }; | ||
| Object.values(paragonThemeCss.variants).forEach(({ filePath, entryName }) => { | ||
| entryPoints[entryName] = path.resolve(process.cwd(), filePath); | ||
| }); | ||
| return entryPoints; | ||
| } | ||
|
|
||
| module.exports = { | ||
| getParagonVersion, | ||
| getParagonThemeCss, | ||
| getParagonCacheGroups, | ||
| getParagonEntryPoints, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.