Skip to content

Commit

Permalink
Merge pull request #357 from 43081j/improve-types
Browse files Browse the repository at this point in the history 
fix: improve typescript defs
  • Loading branch information
@TheLarkInn
TheLarkInn authored Apr 28, 2023
2 parents a359876 + e9496a7 commit de23c0e
Show file tree
Hide file tree
Showing 6 changed files with 254 additions and 81 deletions.
8 changes: 6 additions & 2 deletions lib/Resolver.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ const {

/** @typedef {import("./ResolverFactory").ResolveOptions} ResolveOptions */

/** @typedef {Error & {details?: string}} ErrorWithDetail */

/** @typedef {(err: ErrorWithDetail|null, res?: string|false, req?: ResolveRequest) => void} ResolveCallback */

/**
* @typedef {Object} FileSystemStats
* @property {function(): boolean} isDirectory
Expand Down Expand Up @@ -262,7 +266,7 @@ class Resolver {
* @param {string} path context path
* @param {string} request request string
* @param {ResolveContext} resolveContext resolve context
* @param {function(Error | null, (string|false)=, ResolveRequest=): void} callback callback function
* @param {ResolveCallback} callback callback function
* @returns {void}
*/
resolve(context, path, request, resolveContext, callback) {
Expand Down Expand Up @@ -312,7 +316,7 @@ class Resolver {

const finishWithoutResolve = log => {
/**
* @type {Error & {details?: string}}
* @type {ErrorWithDetail}
*/
const error = new Error("Can't " + message);
error.details = log.join("\n");
Expand Down
128 changes: 97 additions & 31 deletions lib/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,23 @@ const ResolverFactory = require("./ResolverFactory");
/** @typedef {import("./PnpPlugin").PnpApiImpl} PnpApi */
/** @typedef {import("./Resolver")} Resolver */
/** @typedef {import("./Resolver").FileSystem} FileSystem */
/** @typedef {import("./Resolver").ResolveCallback} ResolveCallback */
/** @typedef {import("./Resolver").ResolveContext} ResolveContext */
/** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
/** @typedef {import("./ResolverFactory").Plugin} Plugin */
/** @typedef {import("./ResolverFactory").UserResolveOptions} ResolveOptions */
/** @typedef {{
* (context: object, path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
* (context: object, path: string, request: string, callback: ResolveCallback): void;
* (path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
* (path: string, request: string, callback: ResolveCallback): void;
* }} ResolveFunctionAsync
*/
/** @typedef {{
* (context: object, path: string, request: string): string|false;
* (path: string, request: string): string|false;
* }} ResolveFunction
*/

const nodeFileSystem = new CachedInputFileSystem(fs, 4000);

Expand All @@ -28,63 +41,116 @@ const asyncResolver = ResolverFactory.createResolver({
extensions: [".js", ".json", ".node"],
fileSystem: nodeFileSystem
});
function resolve(context, path, request, resolveContext, callback) {
if (typeof context === "string") {
callback = resolveContext;
resolveContext = request;
request = path;
path = context;
context = nodeContext;
}
if (typeof callback !== "function") {
callback = resolveContext;
}
asyncResolver.resolve(context, path, request, resolveContext, callback);
}

/**
* @type {ResolveFunctionAsync}
*/
const resolve =
/**
* @param {object|string} context
* @param {string} path
* @param {string|ResolveContext|ResolveCallback} request
* @param {ResolveContext|ResolveCallback=} resolveContext
* @param {ResolveCallback=} callback
*/
(context, path, request, resolveContext, callback) => {
if (typeof context === "string") {
callback = /** @type {ResolveCallback} */ (resolveContext);
resolveContext = /** @type {ResolveContext} */ (request);
request = path;
path = context;
context = nodeContext;
}
if (typeof callback !== "function") {
callback = /** @type {ResolveCallback} */ (resolveContext);
}
asyncResolver.resolve(
context,
path,
/** @type {string} */ (request),
/** @type {ResolveContext} */ (resolveContext),
/** @type {ResolveCallback} */ (callback)
);
};

const syncResolver = ResolverFactory.createResolver({
conditionNames: ["node"],
extensions: [".js", ".json", ".node"],
useSyncFileSystemCalls: true,
fileSystem: nodeFileSystem
});
function resolveSync(context, path, request) {
if (typeof context === "string") {
request = path;
path = context;
context = nodeContext;
}
return syncResolver.resolveSync(context, path, request);
}

/**
* @type {ResolveFunction}
*/
const resolveSync =
/**
* @param {object|string} context
* @param {string} path
* @param {string=} request
*/
(context, path, request) => {
if (typeof context === "string") {
request = path;
path = context;
context = nodeContext;
}
return syncResolver.resolveSync(
context,
path,
/** @type {string} */ (request)
);
};

/** @typedef {Omit<ResolveOptions, "fileSystem"> & Partial<Pick<ResolveOptions, "fileSystem">>} ResolveOptionsOptionalFS */

/**
* @param {ResolveOptionsOptionalFS} options Resolver options
* @returns {ResolveFunctionAsync} Resolver function
*/
function create(options) {
options = {
const resolver = ResolverFactory.createResolver({
fileSystem: nodeFileSystem,
...options
};
const resolver = ResolverFactory.createResolver(options);
});
/**
* @param {object|string} context Custom context
* @param {string} path Base path
* @param {string|ResolveContext|ResolveCallback} request String to resolve
* @param {ResolveContext|ResolveCallback=} resolveContext Resolve context
* @param {ResolveCallback=} callback Result callback
*/
return function (context, path, request, resolveContext, callback) {
if (typeof context === "string") {
callback = resolveContext;
resolveContext = request;
callback = /** @type {ResolveCallback} */ (resolveContext);
resolveContext = /** @type {ResolveContext} */ (request);
request = path;
path = context;
context = nodeContext;
}
if (typeof callback !== "function") {
callback = resolveContext;
callback = /** @type {ResolveCallback} */ (resolveContext);
}
resolver.resolve(context, path, request, resolveContext, callback);
resolver.resolve(
context,
path,
/** @type {string} */ (request),
/** @type {ResolveContext} */ (resolveContext),
callback
);
};
}

/**
* @param {ResolveOptionsOptionalFS} options Resolver options
* @returns {ResolveFunction} Resolver function
*/
function createSync(options) {
options = {
const resolver = ResolverFactory.createResolver({
useSyncFileSystemCalls: true,
fileSystem: nodeFileSystem,
...options
};
const resolver = ResolverFactory.createResolver(options);
});
return function (context, path, request) {
if (typeof context === "string") {
request = path;
Expand Down
53 changes: 36 additions & 17 deletions test/resolve.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function testResolve(name, context, moduleName, result) {
resolve(context, moduleName, function (err, filename) {
if (err) return done(err);
should.exist(filename);
filename.should.equal(result);
/** @type {string} */ (filename).should.equal(result);
done();
});
});
Expand All @@ -48,7 +48,7 @@ function testResolveContext(name, context, moduleName, result) {
asyncContextResolve(context, moduleName, function (err, filename) {
if (err) done(err);
should.exist(filename);
filename.should.equal(result);
/** @type {string} */ (filename).should.equal(result);
done();
});
});
Expand Down Expand Up @@ -269,7 +269,7 @@ describe("resolve", function () {
function (err, filename) {
if (err) done(err);
should.exist(filename);
filename.should.equal(
/** @type {string} */ (filename).should.equal(
path.resolve(issue238, "./src/common/config/myObjectFile.js")
);
done();
Expand All @@ -281,7 +281,9 @@ describe("resolve", function () {
preferRelativeResolve(fixtures, "main1.js", function (err, filename) {
if (err) done(err);
should.exist(filename);
filename.should.equal(path.join(fixtures, "main1.js"));
/** @type {string} */ (filename).should.equal(
path.join(fixtures, "main1.js")
);
done();
});
});
Expand All @@ -290,29 +292,46 @@ describe("resolve", function () {
preferRelativeResolve(fixtures, "m1/a.js", function (err, filename) {
if (err) done(err);
should.exist(filename);
filename.should.equal(path.join(fixtures, "node_modules", "m1", "a.js"));
/** @type {string} */ (filename).should.equal(
path.join(fixtures, "node_modules", "m1", "a.js")
);
done();
});
});

it("should not crash when passing undefined as path", done => {
resolve(fixtures, undefined, err => {
err.should.be.instanceof(Error);
done();
});
resolve(
fixtures,
/** @type {string} */ (/** @type {unknown} */ (undefined)),
err => {
/** @type {Error} */ (err).should.be.instanceof(Error);
done();
}
);
});

it("should not crash when passing undefined as context", done => {
resolve({}, undefined, "./test/resolve.js", err => {
err.should.be.instanceof(Error);
done();
});
resolve(
{},
/** @type {string} */ (/** @type {unknown} */ (undefined)),
"./test/resolve.js",
err => {
/** @type {Error} */ (err).should.be.instanceof(Error);
done();
}
);
});

it("should not crash when passing undefined everywhere", done => {
resolve(undefined, undefined, undefined, undefined, err => {
err.should.be.instanceof(Error);
done();
});
resolve(
/** @type {object} */ (undefined),
/** @type {string} */ (/** @type {unknown} */ (undefined)),
/** @type {string} */ (/** @type {unknown} */ (undefined)),
/** @type {object} */ (/** @type {unknown} */ (undefined)),
err => {
/** @type {Error} */ (err).should.be.instanceof(Error);
done();
}
);
});
});
6 changes: 4 additions & 2 deletions test/simple.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ describe("simple", function () {
new Error([err.message, err.stack, err.details].join("\n"))
);
should.exist(filename);
filename.should.have.type("string");
filename.should.be.eql(path.join(__dirname, "..", "lib", "index.js"));
/** @type {string} */ (filename).should.have.type("string");
/** @type {string} */ (filename).should.be.eql(
path.join(__dirname, "..", "lib", "index.js")
);
done();
});
});
Expand Down
12 changes: 8 additions & 4 deletions test/symlink.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -214,15 +214,19 @@ describe("symlink", function () {
resolve(pathToIt[0], pathToIt[1], function (err, filename) {
if (err) return done(err);
should.exist(filename);
filename.should.have.type("string");
filename.should.be.eql(path.join(__dirname, "..", "lib", "index.js"));
/** @type {string} */ (filename).should.have.type("string");
/** @type {string} */ (filename).should.be.eql(
path.join(__dirname, "..", "lib", "index.js")
);
resolveWithoutSymlinks(pathToIt[0], pathToIt[1], function (
err,
filename
) {
if (err) return done(err);
filename.should.have.type("string");
filename.should.be.eql(path.resolve(pathToIt[0], pathToIt[1]));
/** @type {string} */ (filename).should.have.type("string");
/** @type {string} */ (filename).should.be.eql(
path.resolve(pathToIt[0], pathToIt[1])
);
done();
});
});
Expand Down
Loading

0 comments on commit de23c0e

Please sign in to comment.