Skip to content
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

🌎 Fetch config extensions from URL #1251

Merged
merged 4 commits into from
Jun 5, 2024
Merged

🌎 Fetch config extensions from URL #1251

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a730d69
🌎 Fetch config fields from URL
fwkoch May 25, 2024
c3a1619
🔧 Fix cache path construction
fwkoch May 27, 2024
1e4eaa9
🔧 Make remote config paths an option
fwkoch May 27, 2024
c7f233b
🔧 More fixes to types, awaits
fwkoch May 28, 2024
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
6 changes: 6 additions & 0 deletions .changeset/hot-actors-destroy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'myst-cli': patch
'mystmd': patch
---

Fetch config files from url
5 changes: 4 additions & 1 deletion packages/myst-cli/src/build/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,10 @@ export async function collectAllBuildExportOptions(
throw new Error(`When specifying output, you can only request one format`);
}
let exportOptionsList: ExportWithInputOutput[];
const projectPath = findCurrentProjectAndLoad(session, files[0] ? path.dirname(files[0]) : '.');
const projectPath = await findCurrentProjectAndLoad(
session,
files[0] ? path.dirname(files[0]) : '.',
);
if (projectPath) await loadProjectFromDisk(session, projectPath);
if (output) {
session.log.debug(`Exporting formats: "${requestedFormats.join('", "')}"`);
Expand Down
6 changes: 3 additions & 3 deletions packages/myst-cli/src/build/init.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export async function init(session: ISession, opts: InitOptions) {
if (!project && !site && !writeTOC) {
session.log.info(WELCOME());
}
loadConfig(session, '.');
await loadConfig(session, '.');
const state = session.store.getState();
const existingRawConfig = selectors.selectLocalRawConfig(state, '.');
const existingProjectConfig = selectors.selectLocalProjectConfig(state, '.');
Expand All @@ -96,7 +96,7 @@ export async function init(session: ISession, opts: InitOptions) {
}
if (siteConfig || projectConfig) {
session.log.info(`💾 Updating config file: ${existingConfigFile}`);
writeConfigs(session, '.', { siteConfig, projectConfig });
await writeConfigs(session, '.', { siteConfig, projectConfig });
}
} else {
// If no config is present, write it explicitly to include comments.
Expand All @@ -119,7 +119,7 @@ export async function init(session: ISession, opts: InitOptions) {
fs.writeFileSync(configFile, configData);
}
if (writeTOC) {
loadConfig(session, '.');
await loadConfig(session, '.');
await loadProjectFromDisk(session, '.', { writeTOC });
}
// If we have any options, this command is complete!
Expand Down
14 changes: 7 additions & 7 deletions packages/myst-cli/src/build/legacy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export async function localArticleToWord(
extraLinkTransformers?: LinkTransformer[],
): Promise<ExportResults> {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const exportOptionsList = (
await legacyCollectExportOptions(session, file, 'docx', [ExportFormats.docx], projectPath, opts)
Expand Down Expand Up @@ -81,7 +81,7 @@ export async function localArticleToJats(
extraLinkTransformers?: LinkTransformer[],
) {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const exportOptionsList = (
await legacyCollectExportOptions(session, file, 'xml', [ExportFormats.xml], projectPath, opts)
Expand Down Expand Up @@ -115,7 +115,7 @@ export async function localArticleToMd(
extraLinkTransformers?: LinkTransformer[],
) {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const exportOptionsList = (
await legacyCollectExportOptions(session, file, 'md', [ExportFormats.md], projectPath, opts)
Expand Down Expand Up @@ -146,7 +146,7 @@ export async function localProjectToMeca(
extraLinkTransformers?: LinkTransformer[],
) {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const exportOptionsList = (
await legacyCollectExportOptions(session, file, 'zip', [ExportFormats.meca], projectPath, opts)
Expand Down Expand Up @@ -179,7 +179,7 @@ export async function localArticleToPdf(
templateOptions?: Record<string, any>,
): Promise<ExportResults> {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const pdfExportOptionsList = (
await legacyCollectExportOptions(
Expand Down Expand Up @@ -249,7 +249,7 @@ export async function localArticleToTex(
extraLinkTransformers?: LinkTransformer[],
): Promise<ExportResults> {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const exportOptionsList = (
await legacyCollectExportOptions(session, file, 'tex', [ExportFormats.tex], projectPath, opts)
Expand Down Expand Up @@ -323,7 +323,7 @@ export async function localArticleToTypst(
extraLinkTransformers?: LinkTransformer[],
): Promise<ExportResults> {
let { projectPath } = opts;
if (!projectPath) projectPath = findCurrentProjectAndLoad(session, path.dirname(file));
if (!projectPath) projectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (projectPath) await loadProjectFromDisk(session, projectPath);
const exportOptionsList = (
await legacyCollectExportOptions(session, file, 'typ', [ExportFormats.typst], projectPath, opts)
Expand Down
40 changes: 21 additions & 19 deletions packages/myst-cli/src/build/site/manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,25 +211,27 @@ async function resolveTemplateFileOptions(
options: Record<string, any>,
) {
const resolvedOptions = { ...options };
mystTemplate.getValidatedTemplateYml().options?.forEach((option) => {
if (option.type === TemplateOptionType.file && options[option.id]) {
const configPath = selectors.selectCurrentSitePath(session.store.getState());
const absPath = configPath
? resolveToAbsolute(session, configPath, options[option.id])
: options[option.id];
const fileHash = hashAndCopyStaticFile(
session,
absPath,
session.publicPath(),
(m: string) => {
addWarningForFile(session, options[option.id], m, 'error', {
ruleId: RuleId.templateFileCopied,
});
},
);
resolvedOptions[option.id] = `/${fileHash}`;
}
});
await Promise.all(
(mystTemplate.getValidatedTemplateYml().options ?? []).map(async (option) => {
if (option.type === TemplateOptionType.file && options[option.id]) {
const configPath = selectors.selectCurrentSitePath(session.store.getState());
const absPath = configPath
? await resolveToAbsolute(session, configPath, options[option.id])
: options[option.id];
const fileHash = hashAndCopyStaticFile(
session,
absPath,
session.publicPath(),
(m: string) => {
addWarningForFile(session, options[option.id], m, 'error', {
ruleId: RuleId.templateFileCopied,
});
},
);
resolvedOptions[option.id] = `/${fileHash}`;
}
}),
);
return resolvedOptions;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/myst-cli/src/build/site/start.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export async function startServer(
opts: StartOptions,
): Promise<AppServer | undefined> {
// Ensure we are on the latest version of the configs
session.reload();
await session.reload();
warnOnHostEnvironmentVariable(session, opts);
const mystTemplate = await getMystTemplate(session, opts);
if (!opts.headless) await installSiteTemplate(session, mystTemplate);
Expand Down
2 changes: 1 addition & 1 deletion packages/myst-cli/src/build/utils/collectExportOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ export async function collectExportOptions(
sourceFiles.map(async (file) => {
let fileProjectPath: string | undefined;
if (!projectPath) {
fileProjectPath = findCurrentProjectAndLoad(session, path.dirname(file));
fileProjectPath = await findCurrentProjectAndLoad(session, path.dirname(file));
if (fileProjectPath) await loadProjectFromDisk(session, fileProjectPath);
} else {
fileProjectPath = projectPath;
Expand Down
6 changes: 4 additions & 2 deletions packages/myst-cli/src/build/utils/localArticleExport.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,11 @@ async function _localArticleExport(
exportOptionsList.map(async (exportOptionsWithFile) => {
const { $file, $project, ...exportOptions } = exportOptionsWithFile;
const { format, output } = exportOptions;
const sessionClone = session.clone();
const sessionClone = await session.clone();
const fileProjectPath =
projectPath ?? $project ?? findCurrentProjectAndLoad(sessionClone, path.dirname($file));
projectPath ??
$project ??
(await findCurrentProjectAndLoad(sessionClone, path.dirname($file)));

if (fileProjectPath) {
await loadProjectFromDisk(sessionClone, fileProjectPath);
Expand Down
Loading
Loading