Skip to content

utils: perform portable path sanitisation of URLs #721

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
Open

utils: perform portable path sanitisation of URLs #721

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
12 changes: 10 additions & 2 deletions src/utils/data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { normalizePath } from 'docc-render/utils/assets';
import {
queryStringForParams, areEquivalentLocations, getAbsoluteUrl,
} from 'docc-render/utils/url-helper';
import { getSetting } from 'docc-render/utils/theme-settings';
import emitWarningForSchemaVersionMismatch from 'docc-render/utils/schema-version-check';
import RedirectError from 'docc-render/errors/RedirectError';
import FetchError from 'docc-render/errors/FetchError';
Expand Down Expand Up @@ -56,8 +57,15 @@ export async function fetchData(path, params = {}, options = {}) {
}

function createDataPath(path) {
const dataPath = path.replace(/\/$/, '');
return `${normalizePath(['/data', dataPath])}.json`;
function filePathFor(path) {
if (process.env.VUE_APP_TARGET !== 'ide' &&
getSetting(['features', 'docs', 'portablePaths', 'enable'], false)) {
return path.replace(/\/$/, "").replace(/[<>:"\/\\|*]/, "_");
} else {
return path.replace(/\/$/, "")
}
}
return `${normalizePath(['/data', filePathFor(path)])}.json`;
}

/**
Expand Down