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.

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

Added support for absolute paths #147

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 27 additions & 35 deletions src/mapping-entry.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import * as path from "path";

export interface MappingEntry {
readonly pattern: string;
readonly paths: ReadonlyArray<string>;
readonly pattern: string;
readonly paths: ReadonlyArray<string>;
}

export interface Paths {
readonly [key: string]: ReadonlyArray<string>;
readonly [key: string]: ReadonlyArray<string>;
}

/**
Expand All @@ -18,47 +18,39 @@ export interface Paths {
* @param paths
* @param addMatchAll
*/
export function getAbsoluteMappingEntries(
absoluteBaseUrl: string,
paths: Paths,
addMatchAll: boolean
): ReadonlyArray<MappingEntry> {
// Resolve all paths to absolute form once here, and sort them by
// longest prefix once here, this saves time on each request later.
// We need to put them in an array to preserve the sorting order.
const sortedKeys = sortByLongestPrefix(Object.keys(paths));
const absolutePaths: Array<MappingEntry> = [];
for (const key of sortedKeys) {
absolutePaths.push({
pattern: key,
paths: paths[key].map((pathToResolve) =>
path.join(absoluteBaseUrl, pathToResolve)
),
});
}
// If there is no match-all path specified in the paths section of tsconfig, then try to match
// all paths relative to baseUrl, this is how typescript works.
if (!paths["*"] && addMatchAll) {
absolutePaths.push({
pattern: "*",
paths: [`${absoluteBaseUrl.replace(/\/$/, "")}/*`],
});
}
export function getAbsoluteMappingEntries(absoluteBaseUrl: string, paths: Paths, addMatchAll: boolean): ReadonlyArray<MappingEntry> {
// Resolve all paths to absolute form once here, and sort them by
// longest prefix once here, this saves time on each request later.
// We need to put them in an array to preserve the sorting order.
const sortedKeys = sortByLongestPrefix(Object.keys(paths));
const absolutePaths: Array<MappingEntry> = [];
for (const key of sortedKeys) {
absolutePaths.push({
pattern: key,
paths: paths[key].map((pathToResolve) => (path.isAbsolute(pathToResolve) ? pathToResolve : path.join(absoluteBaseUrl, pathToResolve))),
});
}
// If there is no match-all path specified in the paths section of tsconfig, then try to match
// all paths relative to baseUrl, this is how typescript works.
if (!paths["*"] && addMatchAll) {
absolutePaths.push({
pattern: "*",
paths: [`${absoluteBaseUrl.replace(/\/$/, "")}/*`],
});
}

return absolutePaths;
return absolutePaths;
}

/**
* Sort path patterns.
* If a module name can be matched with multiple patterns then pattern with the longest prefix will be picked.
*/
function sortByLongestPrefix(arr: Array<string>): Array<string> {
return arr
.concat()
.sort((a: string, b: string) => getPrefixLength(b) - getPrefixLength(a));
return arr.concat().sort((a: string, b: string) => getPrefixLength(b) - getPrefixLength(a));
}

function getPrefixLength(pattern: string): number {
const prefixLength = pattern.indexOf("*");
return pattern.substr(0, prefixLength).length;
const prefixLength = pattern.indexOf("*");
return pattern.substr(0, prefixLength).length;
}
96 changes: 57 additions & 39 deletions test/mapping-entry-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,63 @@ import { getAbsoluteMappingEntries } from "../src/mapping-entry";
import { join } from "path";

describe("mapping-entry", () => {
it("should change to absolute paths and sort in longest prefix order", () => {
const result = getAbsoluteMappingEntries(
"/absolute/base/url",
{
"*": ["/foo1", "/foo2"],
"longest/pre/fix/*": ["/foo2/bar"],
"pre/fix/*": ["/foo3"],
},
true
);
assert.deepEqual(result, [
{
pattern: "longest/pre/fix/*",
paths: [join("/absolute", "base", "url", "foo2", "bar")],
},
{
pattern: "pre/fix/*",
paths: [join("/absolute", "base", "url", "foo3")],
},
{
pattern: "*",
paths: [
join("/absolute", "base", "url", "foo1"),
join("/absolute", "base", "url", "foo2"),
],
},
]);
});
it("should change to absolute paths and sort in longest prefix order", () => {
const result = getAbsoluteMappingEntries(
"/absolute/base/url",
{
"*": ["foo1", "foo2"],
"longest/pre/fix/*": ["foo2/bar"],
"pre/fix/*": ["foo3"],
},
true
);
assert.deepEqual(result, [
{
pattern: "longest/pre/fix/*",
paths: [join("/absolute", "base", "url", "foo2", "bar")],
},
{
pattern: "pre/fix/*",
paths: [join("/absolute", "base", "url", "foo3")],
},
{
pattern: "*",
paths: [join("/absolute", "base", "url", "foo1"), join("/absolute", "base", "url", "foo2")],
},
]);
});

it("should should add a match-all pattern when requested", () => {
let result = getAbsoluteMappingEntries("/absolute/base/url", {}, true);
assert.deepEqual(result, [
{
pattern: "*",
paths: [join("/absolute", "base", "url", "*")],
},
]);
it("should avoid the resolution of the already absolute paths", () => {
const result = getAbsoluteMappingEntries(
"/absolute/base/url",
{
"pre/fix/*": ["foo3"],
"pre/fixA/*": ["/absolute_path/foo4"],
},
false
);
assert.deepEqual(result, [
{
pattern: "pre/fixA/*",
paths: [join("/absolute_path", "foo4")],
},
{
pattern: "pre/fix/*",
paths: [join("/absolute", "base", "url", "foo3")],
},
]);
});

result = getAbsoluteMappingEntries("/absolute/base/url", {}, false);
assert.deepEqual(result, []);
});
it("should should add a match-all pattern when requested", () => {
let result = getAbsoluteMappingEntries("/absolute/base/url", {}, true);
assert.deepEqual(result, [
{
pattern: "*",
paths: [join("/absolute", "base", "url", "*")],
},
]);

result = getAbsoluteMappingEntries("/absolute/base/url", {}, false);
assert.deepEqual(result, []);
});
});