2023-02-14 11:38:45 -05:00
|
|
|
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
refactor(core): include_js_files! 'dir' option doesn't change specifiers (#18019)
This commit changes "include_js_files!" macro from "deno_core"
in a way that "dir" option doesn't cause specifiers to be rewritten
to include it.
Example:
```
include_js_files! {
dir "js",
"hello.js",
}
```
The above definition required embedders to use:
`import ... from "internal:<ext_name>/js/hello.js"`.
But with this change, the "js" directory in which the files are stored
is an implementation detail, which for embedders results in:
`import ... from "internal:<ext_name>/hello.js"`.
The directory the files are stored in, is an implementation detail and
in some cases might result in a significant size difference for the
snapshot. As an example, in "deno_node" extension, we store the
source code in "polyfills" directory; which resulted in each specifier
to look like "internal:deno_node/polyfills/<module_name>", but with
this change it's "internal:deno_node/<module_name>".
Given that "deno_node" has over 100 files, many of them having
several import specifiers to the same extension, this change removes
10 characters from each import specifier.
2023-03-04 21:31:38 -05:00
|
|
|
import Dirent from "internal:deno_node/_fs/_fs_dirent.ts";
|
|
|
|
import { assert } from "internal:deno_node/_util/asserts.ts";
|
|
|
|
import { ERR_MISSING_ARGS } from "internal:deno_node/internal/errors.ts";
|
2023-02-14 11:38:45 -05:00
|
|
|
import { TextDecoder } from "internal:deno_web/08_text_encoding.js";
|
|
|
|
|
|
|
|
export default class Dir {
|
|
|
|
#dirPath: string | Uint8Array;
|
|
|
|
#syncIterator!: Iterator<Deno.DirEntry, undefined> | null;
|
|
|
|
#asyncIterator!: AsyncIterator<Deno.DirEntry, undefined> | null;
|
|
|
|
|
|
|
|
constructor(path: string | Uint8Array) {
|
|
|
|
if (!path) {
|
|
|
|
throw new ERR_MISSING_ARGS("path");
|
|
|
|
}
|
|
|
|
this.#dirPath = path;
|
|
|
|
}
|
|
|
|
|
|
|
|
get path(): string {
|
|
|
|
if (this.#dirPath instanceof Uint8Array) {
|
|
|
|
return new TextDecoder().decode(this.#dirPath);
|
|
|
|
}
|
|
|
|
return this.#dirPath;
|
|
|
|
}
|
|
|
|
|
|
|
|
// deno-lint-ignore no-explicit-any
|
|
|
|
read(callback?: (...args: any[]) => void): Promise<Dirent | null> {
|
|
|
|
return new Promise((resolve, reject) => {
|
|
|
|
if (!this.#asyncIterator) {
|
|
|
|
this.#asyncIterator = Deno.readDir(this.path)[Symbol.asyncIterator]();
|
|
|
|
}
|
|
|
|
assert(this.#asyncIterator);
|
|
|
|
this.#asyncIterator
|
|
|
|
.next()
|
|
|
|
.then((iteratorResult) => {
|
|
|
|
resolve(
|
|
|
|
iteratorResult.done ? null : new Dirent(iteratorResult.value),
|
|
|
|
);
|
|
|
|
if (callback) {
|
|
|
|
callback(
|
|
|
|
null,
|
|
|
|
iteratorResult.done ? null : new Dirent(iteratorResult.value),
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}, (err) => {
|
|
|
|
if (callback) {
|
|
|
|
callback(err);
|
|
|
|
}
|
|
|
|
reject(err);
|
|
|
|
});
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
readSync(): Dirent | null {
|
|
|
|
if (!this.#syncIterator) {
|
|
|
|
this.#syncIterator = Deno.readDirSync(this.path)![Symbol.iterator]();
|
|
|
|
}
|
|
|
|
|
|
|
|
const iteratorResult = this.#syncIterator.next();
|
|
|
|
if (iteratorResult.done) {
|
|
|
|
return null;
|
|
|
|
} else {
|
|
|
|
return new Dirent(iteratorResult.value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unlike Node, Deno does not require managing resource ids for reading
|
|
|
|
* directories, and therefore does not need to close directories when
|
|
|
|
* finished reading.
|
|
|
|
*/
|
|
|
|
// deno-lint-ignore no-explicit-any
|
|
|
|
close(callback?: (...args: any[]) => void): Promise<void> {
|
|
|
|
return new Promise((resolve) => {
|
|
|
|
if (callback) {
|
|
|
|
callback(null);
|
|
|
|
}
|
|
|
|
resolve();
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unlike Node, Deno does not require managing resource ids for reading
|
|
|
|
* directories, and therefore does not need to close directories when
|
|
|
|
* finished reading
|
|
|
|
*/
|
|
|
|
closeSync() {
|
|
|
|
//No op
|
|
|
|
}
|
|
|
|
|
|
|
|
async *[Symbol.asyncIterator](): AsyncIterableIterator<Dirent> {
|
|
|
|
try {
|
|
|
|
while (true) {
|
|
|
|
const dirent: Dirent | null = await this.read();
|
|
|
|
if (dirent === null) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
yield dirent;
|
|
|
|
}
|
|
|
|
} finally {
|
|
|
|
await this.close();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|