Skip to content

Fix types #27

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
Open
oBusk wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix types #27

oBusk wants to merge 3 commits into from

Conversation

@oBusk
Copy link

@oBusk oBusk commented Jun 22, 2022 •
edited
Loading

The type export is malformed and gives errors in current versions of typescript

image

node_modules/gitdiff-parser/index.d.ts(36,16): error TS2714: The expression of an export assignment must be an identifier or qualified name in an ambient context.
node_modules/gitdiff-parser/index.d.ts(37,34): error TS1005: '{' expected.

This also does not work if you want to use gitDiffParser globally (not importing). Since the index.js exports as a UMD, I followed the example https://devblogs.microsoft.com/typescript/writing-dts-files-for-types/

With this type, all the following works

// Reference for `<script>`-imported library
/// <reference path="gitdiff-parser" />

gitDiffParser.parse(gitContent);
import { parse } from "gitdiff-parser";

parse(gitContent);
import gitDiffParser from "gitdiff-parser";

gitDiffParser.parse(gitContent);

As a bonus I added exports for FileType and ChangeType.

This was referenced Jun 22, 2022
Closed
Closed
@ciaran1344
Copy link

ciaran1344 commented Jan 5, 2023

Any update here? Am running into the same compilation warnings on typescript@4.9.4

@kaiyoma kaiyoma mentioned this pull request Mar 13, 2023
Open
@oBusk
Copy link
Author

oBusk commented Apr 12, 2023

There was some improvements to the type surrounding the ChangeType and FileType, but the default export is still the same, so I've rebased this PR let's see if we can get it in 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@leelasn leelasn leelasn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@oBusk @ciaran1344 @leelasn