Skip to content

feat(builder): Rewrite svg.less imports in libraryLessGenerator #1488

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
stopcoder wants to merge 1 commit into
base: main
Choose a base branch
from
+84 −10
Open

feat(builder): Rewrite svg.less imports in libraryLessGenerator #1488

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
36 changes: 26 additions & 10 deletions packages/builder/lib/processors/libraryLessGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import Resource from "@ui5/fs/Resource";

const IMPORT_PATTERN = /@import .*"(.*)";/g;
const BASE_LESS_PATTERN = /^\/resources\/sap\/ui\/core\/themes\/([^/]+)\/base\.less$/;
const SVG_LESS_PATTERN = /^\/resources\/sap\/ui\/core\/themes\/([^/]+)\/svg\.less$/;
const GLOBAL_LESS_PATTERN = /^\/resources\/sap\/ui\/core\/themes\/([^/]+)\/global\.less$/;

class LibraryLessGenerator {
Expand Down Expand Up @@ -53,18 +54,33 @@ class LibraryLessGenerator {
}
return array.join("");
}
async resolveLessImport(originalFilePath, resolvedFilePath, baseDir) {
// Rewrite base.less imports
const baseLessMatch = BASE_LESS_PATTERN.exec(resolvedFilePath);
if (baseLessMatch) {
let baseLessThemeName = baseLessMatch[1];
if (baseLessThemeName === "base") {
baseLessThemeName = "baseTheme";
static rewriteThemeDesignerImport({pattern, resolvedFilePath, baseDir, baseFolder, fileName, originalFilePath}) {
const match = pattern.exec(resolvedFilePath);
if (match) {
let themeName = match[1];
if (themeName === "base") {
themeName = "baseTheme";
}

const baseLessPath = LibraryLessGenerator.getPathToRoot(baseDir) +
"Base/baseLib/" + baseLessThemeName + "/base.less";
return "@import \"" + baseLessPath + "\"; /* ORIGINAL IMPORT PATH: \"" + originalFilePath + "\" */\n";
const rewrittenPath = LibraryLessGenerator.getPathToRoot(baseDir) +
"Base/" + baseFolder + "/" + themeName + "/" + fileName;
return "@import \"" + rewrittenPath + "\"; /* ORIGINAL IMPORT PATH: \"" + originalFilePath + "\" */\n";
}
return null;
}
async resolveLessImport(originalFilePath, resolvedFilePath, baseDir) {
// Rewrite Theme Designer imports (base.less, svg.less)
const themeDesignerRewrites = [
{pattern: BASE_LESS_PATTERN, baseFolder: "baseLib", fileName: "base.less"},
{pattern: SVG_LESS_PATTERN, baseFolder: "icons", fileName: "svg.less"},
];
for (const rewrite of themeDesignerRewrites) {
const result = LibraryLessGenerator.rewriteThemeDesignerImport({
...rewrite, resolvedFilePath, baseDir, originalFilePath
});
if (result) {
return result;
}
}

// Rewrite library imports to correct file name
Expand Down
58 changes: 58 additions & 0 deletions packages/builder/test/lib/processors/libraryLessGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,64 @@ test.serial("LibraryLessGenerator: Rewrite for sap.ui.core base.less (from diffe
t.is(loggerStub.error.callCount, 0);
});

test.serial("LibraryLessGenerator: Rewrite for sap.ui.core svg.less", async (t) => {
const {LibraryLessGenerator, loggerStub} = t.context;

const input = `@import "../base/svg.less";\n` +
`@import "svg.less";`;
const expectedOutput = `${FILE_HEADER}\n\n` +
`@import "../../../../../../Base/icons/baseTheme/svg.less"; ` +
`/* ORIGINAL IMPORT PATH: "../base/svg.less" */\n\n` +
`@import "../../../../../../Base/icons/sap_horizon/svg.less"; ` +
`/* ORIGINAL IMPORT PATH: "svg.less" */\n`;

const fs = {
readFile: sinon.stub().callsFake((filePath, options, cb) => {
const err = new Error("ENOENT: no such file or directory, open " + filePath);
err.code = "ENOENT";
cb(err);
})
};

const output = await (new LibraryLessGenerator({fs})).generate({
filePath: "/resources/sap/ui/core/themes/sap_horizon/library.source.less",
fileContent: input
});

t.is(output, expectedOutput);
t.is(fs.readFile.callCount, 0, "fs.readFile should not be called");
t.is(loggerStub.error.callCount, 0);
});

test.serial("LibraryLessGenerator: Rewrite for sap.ui.core svg.less (from different library)", async (t) => {
const {LibraryLessGenerator, loggerStub} = t.context;

const input = `@import "../../../../sap/ui/core/themes/base/svg.less";\n` +
`@import "../../../../sap/ui/core/themes/sap_fiori_3/svg.less";`;
const expectedOutput = `${FILE_HEADER}\n\n` +
`@import "../../../../../Base/icons/baseTheme/svg.less"; ` +
`/* ORIGINAL IMPORT PATH: "../../../../sap/ui/core/themes/base/svg.less" */\n\n` +
`@import "../../../../../Base/icons/sap_fiori_3/svg.less"; ` +
`/* ORIGINAL IMPORT PATH: "../../../../sap/ui/core/themes/sap_fiori_3/svg.less" */\n`;

const fs = {
readFile: sinon.stub().callsFake((filePath, options, cb) => {
const err = new Error("ENOENT: no such file or directory, open " + filePath);
err.code = "ENOENT";
cb(err);
})
};

const output = await (new LibraryLessGenerator({fs})).generate({
filePath: "/resources/sap/f/themes/sap_fiori_3/library.source.less",
fileContent: input
});

t.is(output, expectedOutput);
t.is(fs.readFile.callCount, 0, "fs.readFile should not be called");
t.is(loggerStub.error.callCount, 0);
});

test.serial("LibraryLessGenerator: Rewrite for library.source.less", async (t) => {
const {LibraryLessGenerator, loggerStub} = t.context;

Expand Down
Loading