fix(#201): typings

[KillerCodeMonkey]

fix:

• return type of readdirp
• type of filter options
• enum for type option, with fallback for old string type option

fix #201

[paulmillr]

maybe try const enum instead. We also can't do breaking changes really

[KillerCodeMonkey]

why no breaking changes? just release a new major version?

[KillerCodeMonkey]

i mean all the not working typings are "breaking" changes...

[paulmillr]

just release a new major version

no. I do rare releases. Releasing v5 one month after v4 is unnecessary.

i mean all the not working typings are "breaking" changes...

Yes, so this is a bug fixing, and is OK. For users who did not use readdirpPromise we should not break stuff.

[KillerCodeMonkey]

thanks for the fast response :)

if i had more time, i would get the unit tests up and running again

[paulmillr]

@KillerCodeMonkey I have resolved the issue with backwards compat, check out c44446d

[KillerCodeMonkey]

sorry some changes are missing there readdirP should return EntryInfo[] and not Path[] what is just a string[].

And in the ReaddirpOptions the root should be optional

[KillerCodeMonkey]

but if i log the result of readdirp it gives me a list of EntryInfo[]... and not a list of strings

So i guess, it should be

export function readdirpPromise(
  root: Path,
  options: Partial<ReaddirpOptions> = {}
): Promise<EntryInfo[]> {
  return new Promise<EntryInfo[]>((resolve, reject) => {
    const files: EntryInfo[] = [];
    readdirp(root, options)
      .on('data', (entry) => files.push(entry))
      .on('end', () => resolve(files))
      .on('error', (error) => reject(error));
  });
}

and the interface for the options, should mark the root option as optional

export type ReaddirpOptions = {
  root?: string;
  fileFilter?: Predicate;
  directoryFilter?: Predicate;
  type?: EntryType;
  lstat?: boolean;
  depth?: number;
  alwaysStat?: boolean;
  highWaterMark?: number;
};

[paulmillr]

e658127

[KillerCodeMonkey]

nice and now just mark the root option in ReaddirOptions as optional

[paulmillr]

Partial<something> makes all fields of something optional.

[KillerCodeMonkey]

yes

[paulmillr]

So it's already there: options: Partial<ReaddirpOptions> = {}

[KillerCodeMonkey]

ah then i missed that, sorry

[KillerCodeMonkey]

so then i guess it is ready to ship :).

if you like to release a beta version, let me know. I am here to tests it for my purposes with the promise function

[paulmillr]

This is not a huge issue, so I will wait for a month or so before doing 4.0.2 with other fixes.

There is no need to release beta. 1. Users can build their own readdirp from github source. 2. Users can override types using @ts-ignore and similar stuff for now.

[paulmillr]

I follow rare release schedule for supply chain security, it makes it easier for users to verify ocassional releases of my software. If, instead, I was spamming "weekly release", it would have been harder to reason about.

[KillerCodeMonkey]

yes yes. it was just an idea.

[KillerCodeMonkey]

thanks again :)