GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — fs: allow 'withFileTypes' to be used with globs · nodejs/node@7d7a762

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- fs.md
lib/internal/fs
- glob.js
- utils.js
test/parallel
- test-fs-glob.mjs

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/api/fs.md‎`

Copy file name to clipboardExpand all lines: doc/api/fs.md

+18Lines changed: 18 additions & 0 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -1073,6 +1073,10 @@ behavior is similar to `cp dir1/ dir2/`.
`1073`	`1073`
`1074`	`1074`	`<!-- YAML`
`1075`	`1075`	`added: v22.0.0`
	`1076`	`+changes:`
	`1077`	`+ - version: REPLACEME`
	`1078`	`+ pr-url: https://github.com/nodejs/node/pull/52837`
	`1079`	+ description: Add support for `withFileTypes` as an option.
`1076`	`1080`	`-->`
`1077`	`1081`
`1078`	`1082`	`> Stability: 1 - Experimental`
`@@ -1082,6 +1086,8 @@ added: v22.0.0`
`1082`	`1086`	* `cwd` {string} current working directory. Default: `process.cwd()`
`1083`	`1087`	* `exclude` {Function} Function to filter out files/directories. Return
`1084`	`1088`	`true` to exclude the item, `false` to include it. Default: `undefined`.
	`1089`	+ * `withFileTypes` {boolean} `true` if the glob should return paths as Dirents,
	`1090`	+ `false` otherwise. Default: `false`.
`1085`	`1091`	`* Returns: {AsyncIterator} An AsyncIterator that yields the paths of files`
`1086`	`1092`	`that match the pattern.`
`1087`	`1093`
@@ -3109,6 +3115,10 @@ descriptor. See [`fs.utimes()`][].
`3109`	`3115`
`3110`	`3116`	`<!-- YAML`
`3111`	`3117`	`added: v22.0.0`
	`3118`	`+changes:`
	`3119`	`+ - version: REPLACEME`
	`3120`	`+ pr-url: https://github.com/nodejs/node/pull/52837`
	`3121`	+ description: Add support for `withFileTypes` as an option.
`3112`	`3122`	`-->`
`3113`	`3123`
`3114`	`3124`	`> Stability: 1 - Experimental`
`@@ -3119,6 +3129,8 @@ added: v22.0.0`
`3119`	`3129`	* `cwd` {string} current working directory. Default: `process.cwd()`
`3120`	`3130`	* `exclude` {Function} Function to filter out files/directories. Return
`3121`	`3131`	`true` to exclude the item, `false` to include it. Default: `undefined`.
	`3132`	+ * `withFileTypes` {boolean} `true` if the glob should return paths as Dirents,
	`3133`	+ `false` otherwise. Default: `false`.
`3122`	`3134`
`3123`	`3135`	* `callback` {Function}
`3124`	`3136`	* `err` {Error}
@@ -5603,6 +5615,10 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
`5603`	`5615`
`5604`	`5616`	`<!-- YAML`
`5605`	`5617`	`added: v22.0.0`
	`5618`	`+changes:`
	`5619`	`+ - version: REPLACEME`
	`5620`	`+ pr-url: https://github.com/nodejs/node/pull/52837`
	`5621`	+ description: Add support for `withFileTypes` as an option.
`5606`	`5622`	`-->`
`5607`	`5623`
`5608`	`5624`	`> Stability: 1 - Experimental`
`@@ -5612,6 +5628,8 @@ added: v22.0.0`
`5612`	`5628`	* `cwd` {string} current working directory. Default: `process.cwd()`
`5613`	`5629`	* `exclude` {Function} Function to filter out files/directories. Return
`5614`	`5630`	`true` to exclude the item, `false` to include it. Default: `undefined`.
	`5631`	+ * `withFileTypes` {boolean} `true` if the glob should return paths as Dirents,
	`5632`	+ `false` otherwise. Default: `false`.
`5615`	`5633`	`* Returns: {string\[]} paths of files that match the pattern.`
`5616`	`5634`
`5617`	`5635`	```mjs

Collapse file

`‎lib/internal/fs/glob.js‎`

Copy file name to clipboardExpand all lines: lib/internal/fs/glob.js

+32-14Lines changed: 32 additions & 14 deletions

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ const {`
`16`	`16`
`17`	`17`	`const { lstatSync, readdirSync } = require('fs');`
`18`	`18`	`const { lstat, readdir } = require('fs/promises');`
`19`		`-const { join, resolve } = require('path');`
	`19`	`+const { join, resolve, basename, isAbsolute } = require('path');`
`20`	`20`
`21`	`21`	`const {`
`22`	`22`	`kEmptyObject,`
`@@ -27,6 +27,7 @@ const {`
`27`	`27`	`validateString,`
`28`	`28`	`validateStringArray,`
`29`	`29`	`} = require('internal/validators');`
	`30`	`+const { DirentFromStats } = require('internal/fs/utils');`
`30`	`31`
`31`	`32`	`let minimatch;`
`32`	`33`	`function lazyMinimatch() {`
`@@ -37,6 +38,14 @@ function lazyMinimatch() {`
`37`	`38`	`const isWindows = process.platform === 'win32';`
`38`	`39`	`const isOSX = process.platform === 'darwin';`
`39`	`40`
	`41`	`+async function getDirent(path) {`
	`42`	`+ return new DirentFromStats(basename(path), await lstat(path), path);`
	`43`	`+}`
	`44`	`+`
	`45`	`+function getDirentSync(path) {`
	`46`	`+ return new DirentFromStats(basename(path), lstatSync(path), path);`
	`47`	`+}`
	`48`	`+`
`40`	`49`	`class Cache {`
`41`	`50`	`#cache = new SafeMap();`
`42`	`51`	`#statsCache = new SafeMap();`
`@@ -47,7 +56,7 @@ class Cache {`
`47`	`56`	`if (cached) {`
`48`	`57`	`return cached;`
`49`	`58`	`}`
`50`		`- const promise = PromisePrototypeThen(lstat(path), null, () => null);`
	`59`	`+ const promise = PromisePrototypeThen(getDirent(path), null, () => null);`
`51`	`60`	`this.#statsCache.set(path, promise);`
`52`	`61`	`return promise;`
`53`	`62`	`}`
`@@ -58,7 +67,7 @@ class Cache {`
`58`	`67`	`}`
`59`	`68`	`let val;`
`60`	`69`	`try {`
`61`		`- val = lstatSync(path);`
	`70`	`+ val = getDirentSync(path);`
`62`	`71`	`} catch {`
`63`	`72`	`val = null;`
`64`	`73`	`}`
`@@ -175,14 +184,16 @@ class Glob {`
`175`	`184`	`#queue = [];`
`176`	`185`	`#subpatterns = new SafeMap();`
`177`	`186`	`#patterns;`
	`187`	`+ #withFileTypes;`
`178`	`188`	`constructor(pattern, options = kEmptyObject) {`
`179`	`189`	`validateObject(options, 'options');`
`180`		`- const { exclude, cwd } = options;`
	`190`	`+ const { exclude, cwd, withFileTypes } = options;`
`181`	`191`	`if (exclude != null) {`
`182`	`192`	`validateFunction(exclude, 'options.exclude');`
`183`	`193`	`}`
`184`	`194`	`this.#root = cwd ?? '.';`
`185`	`195`	`this.#exclude = exclude;`
	`196`	`+ this.#withFileTypes = !!withFileTypes;`
`186`	`197`	`let patterns;`
`187`	`198`	`if (typeof pattern === 'object') {`
`188`	`199`	`validateStringArray(pattern, 'patterns');`
`@@ -222,7 +233,14 @@ class Glob {`
`222`	`233`	`.forEach((patterns, path) => ArrayPrototypePush(this.#queue, { __proto__: null, path, patterns }));`
`223`	`234`	`this.#subpatterns.clear();`
`224`	`235`	`}`
`225`		`- return ArrayFrom(this.#results);`
	`236`	`+ return ArrayFrom(`
	`237`	`+ this.#results,`
	`238`	`+ this.#withFileTypes ? (path) => this.#cache.statSync(`
	`239`	`+ isAbsolute(path) ?`
	`240`	`+ path :`
	`241`	`+ join(this.#root, path),`
	`242`	`+ ) : undefined,`
	`243`	`+ );`
`226`	`244`	`}`
`227`	`245`	`#addSubpattern(path, pattern) {`
`228`	`246`	`if (!this.#subpatterns.has(path)) {`
`@@ -317,7 +335,7 @@ class Glob {`
`317`	`335`	`const fromSymlink = pattern.symlinks.has(index);`
`318`	`336`
`319`	`337`	`if (current === lazyMinimatch().GLOBSTAR) {`
`320`		`- if (entry.name[0] === '.' \|\| (this.#exclude && this.#exclude(entry.name))) {`
	`338`	`+ if (entry.name[0] === '.' \|\| (this.#exclude && this.#exclude(this.#withFileTypes ? entry : entry.name))) {`
`321`	`339`	`continue;`
`322`	`340`	`}`
`323`	`341`	`if (!fromSymlink && entry.isDirectory()) {`
`@@ -460,7 +478,7 @@ class Glob {`
`460`	`478`	`const result = join(path, p);`
`461`	`479`	`if (!this.#results.has(result)) {`
`462`	`480`	`this.#results.add(result);`
`463`		`- yield result;`
	`481`	`+ yield this.#withFileTypes ? stat : result;`
`464`	`482`	`}`
`465`	`483`	`}`
`466`	`484`	`if (pattern.indexes.size === 1 && pattern.indexes.has(last)) {`
`@@ -472,7 +490,7 @@ class Glob {`
`472`	`490`	`// if path is ".", add it only if pattern starts with "." or pattern is exactly "**"`
`473`	`491`	`if (!this.#results.has(path)) {`
`474`	`492`	`this.#results.add(path);`
`475`		`- yield path;`
	`493`	`+ yield this.#withFileTypes ? stat : path;`
`476`	`494`	`}`
`477`	`495`	`}`
`478`	`496`
`@@ -522,7 +540,7 @@ class Glob {`
`522`	`540`	`// If ** is last, add to results`
`523`	`541`	`if (!this.#results.has(entryPath)) {`
`524`	`542`	`this.#results.add(entryPath);`
`525`		`- yield entryPath;`
	`543`	`+ yield this.#withFileTypes ? entry : entryPath;`
`526`	`544`	`}`
`527`	`545`	`}`
`528`	`546`
`@@ -533,7 +551,7 @@ class Glob {`
`533`	`551`	`// If next pattern is the last one, add to results`
`534`	`552`	`if (!this.#results.has(entryPath)) {`
`535`	`553`	`this.#results.add(entryPath);`
`536`		`- yield entryPath;`
	`554`	`+ yield this.#withFileTypes ? entry : entryPath;`
`537`	`555`	`}`
`538`	`556`	`} else if (nextMatches && entry.isDirectory()) {`
`539`	`557`	`// Pattern mached, meaning two patterns forward`
`@@ -569,14 +587,14 @@ class Glob {`
`569`	`587`	`this.#cache.add(path, pattern.child(new SafeSet().add(nextIndex)));`
`570`	`588`	`if (!this.#results.has(path)) {`
`571`	`589`	`this.#results.add(path);`
`572`		`- yield path;`
	`590`	`+ yield this.#withFileTypes ? this.#cache.statSync(fullpath) : path;`
`573`	`591`	`}`
`574`	`592`	`}`
`575`	`593`	`if (!this.#cache.seen(path, pattern, nextIndex) \|\| !this.#cache.seen(parent, pattern, nextIndex)) {`
`576`	`594`	`this.#cache.add(parent, pattern.child(new SafeSet().add(nextIndex)));`
`577`	`595`	`if (!this.#results.has(parent)) {`
`578`	`596`	`this.#results.add(parent);`
`579`		`- yield parent;`
	`597`	`+ yield this.#withFileTypes ? this.#cache.statSync(join(this.#root, parent)) : parent;`
`580`	`598`	`}`
`581`	`599`	`}`
`582`	`600`	`}`
`@@ -592,7 +610,7 @@ class Glob {`
`592`	`610`	`if (nextIndex === last) {`
`593`	`611`	`if (!this.#results.has(entryPath)) {`
`594`	`612`	`this.#results.add(entryPath);`
`595`		`- yield entryPath;`
	`613`	`+ yield this.#withFileTypes ? entry : entryPath;`
`596`	`614`	`}`
`597`	`615`	`} else {`
`598`	`616`	`subPatterns.add(nextIndex + 1);`
`@@ -605,7 +623,7 @@ class Glob {`
`605`	`623`	`if (index === last) {`
`606`	`624`	`if (!this.#results.has(entryPath)) {`
`607`	`625`	`this.#results.add(entryPath);`
`608`		`- yield entryPath;`
	`626`	`+ yield this.#withFileTypes ? entry : entryPath;`
`609`	`627`	`}`
`610`	`628`	`} else if (entry.isDirectory()) {`
`611`	`629`	`subPatterns.add(nextIndex);`

Collapse file

`‎lib/internal/fs/utils.js‎`

Copy file name to clipboardExpand all lines: lib/internal/fs/utils.js

+1Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -961,6 +961,7 @@ module.exports = {`
`961`	`961`	`BigIntStats, // for testing`
`962`	`962`	`copyObject,`
`963`	`963`	`Dirent,`
	`964`	`+ DirentFromStats,`
`964`	`965`	`emitRecursiveRmdirWarning,`
`965`	`966`	`getDirent,`
`966`	`967`	`getDirents,`

Collapse file

`‎test/parallel/test-fs-glob.mjs‎`

Copy file name to clipboardExpand all lines: test/parallel/test-fs-glob.mjs

+41-2Lines changed: 41 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,16 @@`
`1`	`1`	`import * as common from '../common/index.mjs';`
`2`	`2`	`import tmpdir from '../common/tmpdir.js';`
`3`		`-import { resolve, dirname, sep } from 'node:path';`
	`3`	`+import { resolve, dirname, sep, basename } from 'node:path';`
`4`	`4`	`import { mkdir, writeFile, symlink, glob as asyncGlob } from 'node:fs/promises';`
`5`		`-import { glob, globSync } from 'node:fs';`
	`5`	`+import { glob, globSync, Dirent } from 'node:fs';`
`6`	`6`	`import { test, describe } from 'node:test';`
`7`	`7`	`import { promisify } from 'node:util';`
`8`	`8`	`import assert from 'node:assert';`
`9`	`9`
	`10`	`+function assertDirents(dirents) {`
	`11`	`+ assert.ok(dirents.every((dirent) => dirent instanceof Dirent));`
	`12`	`+}`
	`13`	`+`
`10`	`14`	`tmpdir.refresh();`
`11`	`15`
`12`	`16`	`const fixtureDir = tmpdir.resolve('fixtures');`
`@@ -333,3 +337,38 @@ describe('fsPromises glob', function() {`
`333`	`337`	`});`
`334`	`338`	`}`
`335`	`339`	`});`
	`340`	`+`
	`341`	`+describe('glob - withFileTypes', function() {`
	`342`	`+ const promisified = promisify(glob);`
	`343`	`+ for (const [pattern, expected] of Object.entries(patterns)) {`
	`344`	`+ test(pattern, async () => {`
	`345`	`+ const actual = await promisified(pattern, { cwd: fixtureDir, withFileTypes: true });`
	`346`	`+ assertDirents(actual);`
	`347`	`+ const normalized = expected.filter(Boolean).map((item) => basename(item)).sort();`
	`348`	`+ assert.deepStrictEqual(actual.map((dirent) => dirent.name).sort(), normalized.sort());`
	`349`	`+ });`
	`350`	`+ }`
	`351`	`+});`
	`352`	`+`
	`353`	`+describe('globSync - withFileTypes', function() {`
	`354`	`+ for (const [pattern, expected] of Object.entries(patterns)) {`
	`355`	`+ test(pattern, () => {`
	`356`	`+ const actual = globSync(pattern, { cwd: fixtureDir, withFileTypes: true });`
	`357`	`+ assertDirents(actual);`
	`358`	`+ const normalized = expected.filter(Boolean).map((item) => basename(item)).sort();`
	`359`	`+ assert.deepStrictEqual(actual.map((dirent) => dirent.name).sort(), normalized.sort());`
	`360`	`+ });`
	`361`	`+ }`
	`362`	`+});`
	`363`	`+`
	`364`	`+describe('fsPromises glob - withFileTypes', function() {`
	`365`	`+ for (const [pattern, expected] of Object.entries(patterns)) {`
	`366`	`+ test(pattern, async () => {`
	`367`	`+ const actual = [];`
	`368`	`+ for await (const item of asyncGlob(pattern, { cwd: fixtureDir, withFileTypes: true })) actual.push(item);`
	`369`	`+ assertDirents(actual);`
	`370`	`+ const normalized = expected.filter(Boolean).map((item) => basename(item)).sort();`
	`371`	`+ assert.deepStrictEqual(actual.map((dirent) => dirent.name).sort(), normalized.sort());`
	`372`	`+ });`
	`373`	`+ }`
	`374`	`+});`

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.