Skip to content

Fix Sandcastle paths for windows #13026

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

Fix Sandcastle paths for windows #13026

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
11 changes: 10 additions & 1 deletion packages/sandcastle/scripts/buildGallery.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,17 @@ export async function buildGalleryList(options = {}) {
};

const galleryFiles = await globby(
galleryFilesPattern.map((pattern) => join(rootDirectory, pattern, "**/*")),
galleryFilesPattern.map((pattern) =>
// globby can only work with paths using '/' but node on windows uses '\'
// convert them right before passing to globby to ensure all joins work as expected
join(rootDirectory, pattern, "**/*").replaceAll("\\", "/"),
),
);
if (galleryFiles.length === 0) {
console.warn(
"Did not find any gallery files. Please check the configuration is correct",
);
}
const yamlFiles = galleryFiles.filter((path) =>
basename(path).match(galleryItemConfig),
);
Expand Down
4 changes: 2 additions & 2 deletions packages/sandcastle/scripts/typescriptCompile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import { fileURLToPath } from "node:url";
* @returns {number} exit code from the tsc command
*/
export default async function typescriptCompile(configPath) {
const tsPath = import.meta.resolve("typescript");
const binPath = fileURLToPath(join(tsPath, "../../bin/tsc"));
const tsPath = fileURLToPath(import.meta.resolve("typescript"));
const binPath = join(tsPath, "../../bin/tsc");
return new Promise((resolve, reject) => {
const ls = spawn(binPath, ["-p", configPath]);

Expand Down
14 changes: 0 additions & 14 deletions scripts/buildSandcastle.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@ import { buildGalleryList } from "../packages/sandcastle/scripts/buildGallery.js
const __dirname = dirname(fileURLToPath(import.meta.url));
const projectRoot = join(__dirname, "..");

// async function importSandcastleBuildFunctions() {
// // Import asynchronously, for now, because this script is not included or run in the release zip;
// const buildGalleryScriptPath = join(
// __dirname,
// "../packages/sandcastle/index.js",
// );
// return await import(pathToFileURL(buildGalleryScriptPath).href);
// }

/**
* Parses Sandcastle config file and returns its values.
* @returns {Promise<Record<string,any>>} A promise that resolves to the config values.
Expand Down Expand Up @@ -52,10 +43,7 @@ export async function buildSandcastleApp({
outputToBuildDir,
includeDevelopment,
}) {
// const { join, dirname } = path;
const __dirname = dirname(fileURLToPath(import.meta.url));
// const { createSandcastleConfig, buildStatic } =
// await importSandcastleBuildFunctions();
const version = await getVersion();
let config;
if (outputToBuildDir) {
Expand Down Expand Up @@ -168,8 +156,6 @@ export async function buildSandcastleGallery({
metadata,
} = gallery ?? {};

// const { buildGalleryList } = await importSandcastleBuildFunctions();

await buildGalleryList({
rootDirectory,
publicDirectory: outputDir,
Expand Down