Skip to content

fix(types): rename licence to license#17

Merged
pi0 merged 1 commit into
unjs:mainfrom
Cansiny0320:main
Jul 29, 2022
Merged

fix(types): rename licence to license#17
pi0 merged 1 commit into
unjs:mainfrom
Cansiny0320:main

Conversation

@Cansiny0320

@Cansiny0320 Cansiny0320 commented Jul 29, 2022

Copy link
Copy Markdown
Contributor

No description provided.

danielroe
danielroe approved these changes Jul 29, 2022
View reviewed changes

@danielroe danielroe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! For future reference: https://docs.npmjs.com/cli/v8/configuring-npm/package-json#license.

@danielroe

danielroe commented Jul 29, 2022

Copy link
Copy Markdown
Member

Might be worth keeping old spelling as deprecated.

@danielroe danielroe changed the title chore: typo fix(types): rename licence -> license Jul 29, 2022
@Cansiny0320

Cansiny0320 commented Jul 29, 2022

Copy link
Copy Markdown
Contributor Author

Might be worth keeping old spelling as deprecated.

i think licence is a wrong use,should not be marked as deprecated

@danielroe

danielroe commented Jul 29, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

The fact that we have [key: string]: any type signature means tthat users will simply have their .licence typed as any, rather than being prompted to change the spelling.

pkg-types/src/types/packagejson.ts

Line 156 in 453d375

[key: string]: any

@pi0

pi0 commented Jul 29, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

The fact that we have [key: string]: any type signature means that users will have their .licence typed as any, rather than being prompted to change the spelling.

This fix is only for type support. We do not have any runtime logic that reflects to deprecating and renaming this field. This is more of a generic issue that we allow artibrary keys to be same as package.json...

@pi0 pi0 changed the title fix(types): rename licence -> license fix(types): rename licence to license Jul 29, 2022
@pi0 pi0 merged commit ddda0b5 into unjs:main Jul 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danielroe danielroe danielroe approved these changes

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

@Cansiny0320 @danielroe @pi0