Open
Conversation
|
@jxson @peterbe @tyankatsu0105 what do you think about this PR? It looks like the current TypeScript types are broken: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

General
The
front-mattermodule uses themodule.exports = fm-pattern to expose the library.Currently the type-declaration doesn't represent this correctly and instead asserts an
export default fm.This contradicts with each other and causes typescript to not work correctly.
This PR fixes the type-declarations accordingly.
The Solution
The solution is to move every existing component (such as
FrontMatterOptions,FMetc.) into a namespace which merges with thefm-function:front-matter/index.d.ts
Lines 1 to 23 in d367565
Afterwards the
fm-function can be exported the same way it is exported in the actual source-file (which is using anexport = fm-expression):front-matter/index.d.ts
Line 24 in d367565
Merging this PR fixes issue #76