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.

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

Prepare v0.5.0 breaking changes #441

Merged
merged 2 commits into from
May 12, 2020
Merged

Prepare v0.5.0 breaking changes #441

merged 2 commits into from
May 12, 2020

Conversation

bdistin
Copy link
Owner

@bdistin bdistin commented May 12, 2020

This PR implements the following changes:

  1. [BREAKING] The library no longer re-exports fs promises. This allows wider compatibility with newer versions of node's fs, without locking out lower versions by having to import/export newly added fs promise methods.
  2. [FEATURE] The library now exports all types used for underlying nextra interfaces.
  3. [BREAKING] The scan function is now updated to use the new openDir function from node v12.12.0's fs. This should be more performant than the previous implementation, however, instead of providing a Map<path, Stats>, a Map<path, Dirent> is returned. Dirent has most of the same methods as Stats (so your filter functions probably will work the same), but it is missing some finer details you get with Stats. Please note the new implementation will error if you try to scan on a file, unlike the previous implementation. This also fixes some weird behavior around the limit option.
  4. [BREAKING] Because we are using something added in node v12.12.0, the minimum engine is now that version.
  5. [N/A] Aliases are now exported from within the files they are aliasing.
  6. [PATCH] This fixes a couple of functions that weren't exported correctly.

After some settling time, this version will be promoted to v1.0.0

…e scan

fix ci

fix broken test

fix other tests

more tests fixed

fix more tests

fix scan behavior

fix targz?

fix levels getting too deep too fast

actually, it has to be this way

limit off by one

old limit was off by one too
@bdistin bdistin changed the title export all type interfaces, update index, remove fsp re-export, updat… Prepare v0.5.0 breaking changes May 12, 2020
@bdistin bdistin merged commit ab93500 into master May 12, 2020
@bdistin bdistin deleted the 0.5.0-dev branch May 12, 2020 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant