root
/
webpack
mirror of https://github.com/webpack/webpack.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #12415 from webpack/bugfix/typings-compat 

make filesystem types compatible with memfs and normal fs
This commit is contained in:
Tobias Koppers 2021-01-13 13:13:11 +01:00 committed by GitHub
parent ead02b9c4f a2e326129c
commit 3ef285bda9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 135 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/Compiler.js
View File

@ -724,7 +724,10 @@ ${other}`);
return this.outputFileSystem.readFile(
targetPath,
(err, existingContent) => {
if (err || !content.equals(existingContent)) {
if (
err ||
!content.equals(/** @type {Buffer} */ (existingContent))
) {
return doWrite(content);
} else {
return alreadyWritten();

10
lib/ContextModuleFactory.js
View File

@ -298,11 +298,13 @@ module.exports = class ContextModuleFactory extends ModuleFactory {
const addDirectory = (directory, addSubDirectory, callback) => {
fs.readdir(directory, (err, files) => {
if (err) return callback(err);
files = files.map(file => file.normalize("NFC"));
files = cmf.hooks.contextModuleFiles.call(files);
if (!files || files.length === 0) return callback(null, []);
const processedFiles = cmf.hooks.contextModuleFiles.call(
/** @type {string[]} */ (files).map(file => file.normalize("NFC"))
);
if (!processedFiles || processedFiles.length === 0)
return callback(null, []);
asyncLib.map(
files.filter(p => p.indexOf(".") !== 0),
processedFiles.filter(p => p.indexOf(".") !== 0),
(segment, callback) => {
const subResource = join(fs, directory, segment);

18
lib/FileSystemInfo.js
View File

@ -1171,8 +1171,9 @@ class FileSystemInfo {
callback();
break;
}
this.fs.realpath(path, (err, realPath) => {
this.fs.realpath(path, (err, _realPath) => {
if (err) return callback(err);
const realPath = /** @type {string} */ (_realPath);
if (realPath !== path) {
resolveFiles.add(path);
}
@ -1192,8 +1193,9 @@ class FileSystemInfo {
callback();
break;
}
this.fs.realpath(path, (err, realPath) => {
this.fs.realpath(path, (err, _realPath) => {
if (err) return callback(err);
const realPath = /** @type {string} */ (_realPath);
if (realPath !== path) {
resolveFiles.add(path);
}
@ -2405,7 +2407,7 @@ class FileSystemInfo {
}
_readContextTimestamp(path, callback) {
this.fs.readdir(path, (err, files) => {
this.fs.readdir(path, (err, _files) => {
if (err) {
if (err.code === "ENOENT") {
this._contextTimestamps.set(path, null);
@ -2414,7 +2416,7 @@ class FileSystemInfo {
}
return callback(err);
}
files = files
const files = /** @type {string[]} */ (_files)
.map(file => file.normalize("NFC"))
.filter(file => !/^\./.test(file))
.sort();
@ -2501,7 +2503,7 @@ class FileSystemInfo {
}
_readContextHash(path, callback) {
this.fs.readdir(path, (err, files) => {
this.fs.readdir(path, (err, _files) => {
if (err) {
if (err.code === "ENOENT") {
this._contextHashes.set(path, null);
@ -2509,7 +2511,7 @@ class FileSystemInfo {
}
return callback(err);
}
files = files
const files = /** @type {string[]} */ (_files)
.map(file => file.normalize("NFC"))
.filter(file => !/^\./.test(file))
.sort();
@ -2624,7 +2626,9 @@ class FileSystemInfo {
return callback(err);
}
const set = new Set(
elements.map(element => join(this.fs, path, element))
/** @type {string[]} */ (elements).map(element =>
join(this.fs, path, element)
)
);
callback(null, set);
});

2
lib/serialization/FileMiddleware.js
View File

@ -441,7 +441,7 @@ class FileMiddleware extends SerializerMiddleware {
reject(err);
return;
}
let remaining = stats.size;
let remaining = /** @type {number} */ (stats.size);
let currentBuffer;
let currentBufferUsed;
const buf = [];

56
lib/util/fs.js
View File

@ -7,17 +7,57 @@
const path = require("path");
/** @typedef {import("fs").Stats} NodeFsStats */
/** @typedef {import("../../declarations/WebpackOptions").WatchOptions} WatchOptions */
/** @typedef {import("../FileSystemInfo").FileSystemInfoEntry} FileSystemInfoEntry */
/**
* @typedef {Object} IStats
* @property {() => boolean} isFile
* @property {() => boolean} isDirectory
* @property {() => boolean} isBlockDevice
* @property {() => boolean} isCharacterDevice
* @property {() => boolean} isSymbolicLink
* @property {() => boolean} isFIFO
* @property {() => boolean} isSocket
* @property {number | bigint} dev
* @property {number | bigint} ino
* @property {number | bigint} mode
* @property {number | bigint} nlink
* @property {number | bigint} uid
* @property {number | bigint} gid
* @property {number | bigint} rdev
* @property {number | bigint} size
* @property {number | bigint} blksize
* @property {number | bigint} blocks
* @property {number | bigint} atimeMs
* @property {number | bigint} mtimeMs
* @property {number | bigint} ctimeMs
* @property {number | bigint} birthtimeMs
* @property {Date} atime
* @property {Date} mtime
* @property {Date} ctime
* @property {Date} birthtime
*/
/**
* @typedef {Object} IDirent
* @property {() => boolean} isFile
* @property {() => boolean} isDirectory
* @property {() => boolean} isBlockDevice
* @property {() => boolean} isCharacterDevice
* @property {() => boolean} isSymbolicLink
* @property {() => boolean} isFIFO
* @property {() => boolean} isSocket
* @property {string | Buffer} name
*/
/** @typedef {function(NodeJS.ErrnoException=): void} Callback */
/** @typedef {function(NodeJS.ErrnoException=, Buffer=): void} BufferCallback */
/** @typedef {function(NodeJS.ErrnoException=, Buffer|string=): void} BufferOrStringCallback */
/** @typedef {function(NodeJS.ErrnoException=, string[]=): void} StringArrayCallback */
/** @typedef {function(NodeJS.ErrnoException=, (string | Buffer)[] | IDirent[]=): void} DirentArrayCallback */
/** @typedef {function(NodeJS.ErrnoException=, string=): void} StringCallback */
/** @typedef {function(NodeJS.ErrnoException=, number=): void} NumberCallback */
/** @typedef {function(NodeJS.ErrnoException=, NodeFsStats=): void} StatsCallback */
/** @typedef {function(NodeJS.ErrnoException=, IStats=): void} StatsCallback */
/** @typedef {function((NodeJS.ErrnoException | Error)=, any=): void} ReadJsonCallback */
/**
@ -45,7 +85,7 @@ const path = require("path");
* @property {function(string, Buffer|string, Callback): void} writeFile
* @property {function(string, Callback): void} mkdir
* @property {function(string, StatsCallback): void} stat
* @property {function(string, BufferCallback): void} readFile
* @property {function(string, BufferOrStringCallback): void} readFile
* @property {(function(string, string): string)=} join
* @property {(function(string, string): string)=} relative
* @property {(function(string): string)=} dirname
@ -53,12 +93,12 @@ const path = require("path");
/**
* @typedef {Object} InputFileSystem
* @property {function(string, BufferCallback): void} readFile
* @property {function(string, BufferOrStringCallback): void} readFile
* @property {(function(string, ReadJsonCallback): void)=} readJson
* @property {function(string, BufferOrStringCallback): void} readlink
* @property {function(string, StringArrayCallback): void} readdir
* @property {function(string, DirentArrayCallback): void} readdir
* @property {function(string, StatsCallback): void} stat
* @property {(function(string, StringCallback): void)=} realpath
* @property {(function(string, BufferOrStringCallback): void)=} realpath
* @property {(function(string=): void)=} purge
* @property {(function(string, string): string)=} join
* @property {(function(string, string): string)=} relative
@ -73,7 +113,7 @@ const path = require("path");
/**
* @typedef {Object} IntermediateFileSystemExtras
* @property {function(string): void} mkdirSync
* @property {function(string): import("fs").WriteStream} createWriteStream
* @property {function(string): NodeJS.WritableStream} createWriteStream
* @property {function(string, string, NumberCallback): void} open
* @property {function(number, Buffer, number, number, number, NumberCallback): void} read
* @property {function(number, Callback): void} close

1
test/configCases/types/filesystems/test.filter.js Normal file
View File

@ -0,0 +1 @@
module.exports = () => false;

17
test/configCases/types/filesystems/webpack.config.js Normal file
View File

@ -0,0 +1,17 @@
const memfs = require("memfs");
const fs = require("fs");
/** @type {import("../../../../").Configuration} */
module.exports = {
plugins: [
compiler => {
compiler.outputFileSystem = memfs.fs;
compiler.inputFileSystem = memfs.fs;
compiler.intermediateFileSystem = memfs.fs;
compiler.outputFileSystem = fs;
compiler.inputFileSystem = fs;
compiler.intermediateFileSystem = fs;
}
]
};

55
types.d.ts vendored
View File

@ -77,7 +77,6 @@ import {
WithStatement,
YieldExpression
} from "estree";
import { Stats as FsStats, WriteStream } from "fs";
import { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
import { default as ValidationError } from "schema-utils/declarations/ValidationError";
import {
@ -3765,6 +3764,43 @@ declare class HttpsUriPlugin {
*/
apply(compiler: Compiler): void;
}
declare interface IDirent {
isFile: () => boolean;
isDirectory: () => boolean;
isBlockDevice: () => boolean;
isCharacterDevice: () => boolean;
isSymbolicLink: () => boolean;
isFIFO: () => boolean;
isSocket: () => boolean;
name: string | Buffer;
}
declare interface IStats {
isFile: () => boolean;
isDirectory: () => boolean;
isBlockDevice: () => boolean;
isCharacterDevice: () => boolean;
isSymbolicLink: () => boolean;
isFIFO: () => boolean;
isSocket: () => boolean;
dev: number | bigint;
ino: number | bigint;
mode: number | bigint;
nlink: number | bigint;
uid: number | bigint;
gid: number | bigint;
rdev: number | bigint;
size: number | bigint;
blksize: number | bigint;
blocks: number | bigint;
atimeMs: number | bigint;
mtimeMs: number | bigint;
ctimeMs: number | bigint;
birthtimeMs: number | bigint;
atime: Date;
mtime: Date;
ctime: Date;
birthtime: Date;
}
declare class IgnorePlugin {
constructor(options: IgnorePluginOptions);
options: IgnorePluginOptions;
@ -3831,7 +3867,7 @@ declare abstract class InitFragment {
declare interface InputFileSystem {
readFile: (
arg0: string,
arg1: (arg0?: NodeJS.ErrnoException, arg1?: Buffer) => void
arg1: (arg0?: NodeJS.ErrnoException, arg1?: string | Buffer) => void
) => void;
readJson?: (
arg0: string,
@ -3843,15 +3879,18 @@ declare interface InputFileSystem {
) => void;
readdir: (
arg0: string,
arg1: (arg0?: NodeJS.ErrnoException, arg1?: string[]) => void
arg1: (
arg0?: NodeJS.ErrnoException,
arg1?: (string | Buffer)[] | IDirent[]
) => void
) => void;
stat: (
arg0: string,
arg1: (arg0?: NodeJS.ErrnoException, arg1?: FsStats) => void
arg1: (arg0?: NodeJS.ErrnoException, arg1?: IStats) => void
) => void;
realpath?: (
arg0: string,
arg1: (arg0?: NodeJS.ErrnoException, arg1?: string) => void
arg1: (arg0?: NodeJS.ErrnoException, arg1?: string | Buffer) => void
) => void;
purge?: (arg0?: string) => void;
join?: (arg0: string, arg1: string) => string;
@ -3863,7 +3902,7 @@ type IntermediateFileSystem = InputFileSystem &
IntermediateFileSystemExtras;
declare interface IntermediateFileSystemExtras {
mkdirSync: (arg0: string) => void;
createWriteStream: (arg0: string) => WriteStream;
createWriteStream: (arg0: string) => NodeJS.WritableStream;
open: (
arg0: string,
arg1: string,
@ -6816,11 +6855,11 @@ declare interface OutputFileSystem {
mkdir: (arg0: string, arg1: (arg0?: NodeJS.ErrnoException) => void) => void;
stat: (
arg0: string,
arg1: (arg0?: NodeJS.ErrnoException, arg1?: FsStats) => void
arg1: (arg0?: NodeJS.ErrnoException, arg1?: IStats) => void
) => void;
readFile: (
arg0: string,
arg1: (arg0?: NodeJS.ErrnoException, arg1?: Buffer) => void
arg1: (arg0?: NodeJS.ErrnoException, arg1?: string | Buffer) => void
) => void;
join?: (arg0: string, arg1: string) => string;
relative?: (arg0: string, arg1: string) => string;