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.

Sign up for GitHub

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

Jump to bottom

fs should be optional in walkSync.Options #60

Merged
merged 1 commit into from
Jun 11, 2021
Merged

fs should be optional in walkSync.Options #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ import ensurePosix = require('ensure-posix-path');
import path = require('path');
import { IMinimatch, IOptions as MinimatchOptions, Minimatch } from 'minimatch';

type Optionalize<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>

function walkSync(baseDir: string, inputOptions?: Optionalize<walkSync.Options, 'fs'> | (string|IMinimatch)[]) {
function walkSync(baseDir: string, inputOptions?: walkSync.Options | (string|IMinimatch)[]) {
const options = handleOptions(inputOptions);

let mapFunct: (arg: walkSync.Entry) => string;
Expand All @@ -26,7 +24,7 @@ function walkSync(baseDir: string, inputOptions?: Optionalize<walkSync.Options,
}
export = walkSync;

function getStat(path: string, fs: walkSync.Options['fs']) {
function getStat(path: string, fs: walkSync.Options['fs'] = fsNode) {
try {
return fs.statSync(path);
} catch(error) {
Expand All @@ -49,7 +47,7 @@ namespace walkSync {
globs?: (string|IMinimatch)[],
ignore?: (string|IMinimatch)[],
directories?: boolean,
fs: typeof fsNode,
fs?: typeof fsNode,
globOptions?: MinimatchOptions,
}

Expand Down Expand Up @@ -82,17 +80,16 @@ function isDefined<T>(val: T | undefined) : val is T {
return typeof val !== 'undefined';
}

function handleOptions(_options?: Optionalize<walkSync.Options, 'fs'> | (string|IMinimatch)[]) : walkSync.Options {
let options: Optionalize<walkSync.Options, 'fs'> = {};
function handleOptions(_options?: walkSync.Options | (string|IMinimatch)[]) : walkSync.Options {
let options: walkSync.Options = {};

if (Array.isArray(_options)) {
options.globs = _options;
} else if (_options) {
options = _options;
}

if (!options.fs) options.fs = fsNode
return options as walkSync.Options;
return options;
}

function applyGlobOptions(globs: (string|IMinimatch)[] | undefined, options: MinimatchOptions) {
Expand Down Expand Up @@ -129,7 +126,7 @@ function lexicographically(a: walkSync.Entry, b: walkSync.Entry) {
}

function _walkSync(baseDir: string, options: walkSync.Options, _relativePath: string | null, visited: string[]) : walkSync.Entry[] {
const {fs} = options;
const fs = options.fs ?? fsNode;
// Inside this function, prefer string concatenation to the slower path.join
// https://github.com/joyent/node/pull/6929
const relativePath = handleRelativePath(_relativePath);
Expand Down