Add types

[Rokt33r]

I think type VFileCompatible = VFile | VFileOptions | VFileContents should be in here. So after this pr is merged, I'll make another pr to discard it from unified.

[wooorm]

Nice! 👍

As the previous two type additions (vfile-message, unified) caused some of the ecosystem to break, I’d first like to figure out how to prevent that from happening before adding this.

[Rokt33r]

Absolutely!

[wooorm]

This looks good, but:

• I’d first like unist-util-stringify-position to receive types as well
• And maybe we need to change some other things in a major as well?

[ChristianMurphy]

maybe we need to change some other things in a major as well?

What do you have in mind @wooorm?

[wooorm]

@ChristianMurphy Nothing really? I think VFile works pretty well. We could look at adding a “base” instead of a “cwd“, similar to Gulp (vfile/ideas#4), tho?

I do know that adding types to an API surfaces some weirdness, so if @Rokt33r finds things that are weird or hard to handle, we could change them now.

[Rokt33r]

I do know that adding types to an API surfaces some weirdness, so if @Rokt33r finds things that are weird or hard to handle, we could change them now.

I don't' have any critical issues. But I sometimes thought it would be nice to have .freeze() method or immutable-vfile module.

[wooorm]

This PR is good to go but unist-util-stringify-position needs to be updated with types first!

[wooorm]

Released! I’d like to add types to the rest of the vfile packages next, before we move on to unified and other things.

Here’s my proposed order (taking dependencies into account, for the needed major bumps):

zero deep:

• vfile-statistics
• vfile-location
• to-vfile
• vfile-sort
• vfile-is
• vfile-reporter-folder-json
• vfile-reporter-json

one deep:

• vfile-to-eslint (vfile-statistics)
• vfile-reporter (vfile-statistics)
• vfile-find-up (to-vfile)
• vfile-find-down (to-vfile)

two deep:

• vfile-reporter-pretty (vfile-to-eslint)