-
Notifications
You must be signed in to change notification settings - Fork 492
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into issue#7286
- Loading branch information
Showing
116 changed files
with
720 additions
and
422 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
import { Plugin } from "vite"; | ||
import * as fs from "fs"; | ||
import * as path from "path"; | ||
import * as glob from "glob"; | ||
|
||
/** | ||
* Interface defining options for the treeShakeUniconPathsPlugin. | ||
* | ||
* @interface TreeShakeUniconPathsPluginOptions | ||
* @property {string[]} iconWhitelist - An array of icon names to always include, even if not found in code. | ||
*/ | ||
|
||
export interface TreeShakeCareIconsOptions { | ||
iconWhitelist: string[]; | ||
} | ||
|
||
/** | ||
* Creates a Webpack plugin that tree-shakes unused Unicon paths from UniconPaths.json in production builds. | ||
* | ||
* @param {TreeShakeCareIconsOptions} [options] - Optional configuration options. Defaults to an empty iconWhitelist. | ||
* @returns {Plugin} Webpack plugin object. | ||
*/ | ||
|
||
export function treeShakeCareIcons( | ||
options: TreeShakeCareIconsOptions = { iconWhitelist: [] } | ||
): Plugin { | ||
const rootDir = path.resolve(__dirname, ".."); // update this if moving this code to a different file | ||
const lineIconNameRegex = /"l-[a-z]+(?:-[a-z]+)*"/g; | ||
const allUniconPaths = JSON.parse( | ||
fs.readFileSync( | ||
path.resolve(rootDir, "src/CAREUI/icons/UniconPaths.json"), | ||
"utf8" | ||
) | ||
); | ||
|
||
// Extracts icon names from a given file's content. | ||
// Returns an array of icon names like ["l-eye", "l-sync", "l-hearbeat"] | ||
function extractCareIconNames(file: string): string[] { | ||
const fileContent = fs.readFileSync(file, "utf8"); | ||
|
||
const lineIconNameMatches = fileContent.match(lineIconNameRegex) || []; | ||
|
||
const lineIconNames = lineIconNameMatches.map( | ||
(lineIconName) => lineIconName.slice(1, -1) // remove quotes | ||
); | ||
|
||
return lineIconNames; | ||
} | ||
// Finds all used icon names within the project's source files (`.tsx` or `.res` extensions). | ||
function getAllUsedIconNames() { | ||
const files = glob.sync(path.resolve(rootDir, "src/**/*.{tsx,res}")); | ||
const usedIconsArray: string[] = []; | ||
|
||
files.forEach((file) => { | ||
const iconNames = extractCareIconNames(file); | ||
usedIconsArray.push(...iconNames); | ||
}); | ||
|
||
return new Set(usedIconsArray); | ||
} | ||
// Generates a map of used icon names to their paths from UniconPaths.json, including any whitelisted icons. | ||
function getTreeShakenUniconPaths() { | ||
const usedIcons = [...getAllUsedIconNames(), ...options.iconWhitelist]; | ||
const treeshakenCareIconPaths = {}; | ||
|
||
for (const iconName of usedIcons) { | ||
const path = allUniconPaths[iconName]; | ||
if (path === undefined) { | ||
throw new Error(`Icon ${iconName} is not found in UniconPaths.json`); | ||
} else { | ||
treeshakenCareIconPaths[iconName] = path; | ||
} | ||
} | ||
|
||
return treeshakenCareIconPaths; | ||
} | ||
|
||
return { | ||
name: "tree-shake-care-icons", | ||
transform(_src, id) { | ||
if (process.env.NODE_ENV !== "production") { | ||
return; | ||
} | ||
|
||
// Replace the UniconPaths with the tree-shaken version | ||
if (id.endsWith("UniconPaths.json")) { | ||
return { | ||
code: `export default ${JSON.stringify(getTreeShakenUniconPaths())}`, | ||
map: null, | ||
}; | ||
} | ||
}, | ||
}; | ||
} |
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
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
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
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
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.