Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

[bugfix] allow jsdoc author tag (#4849) #4854

Merged
merged 3 commits into from
Oct 5, 2019
Merged

[bugfix] allow jsdoc author tag (#4849) #4854

merged 3 commits into from
Oct 5, 2019

Conversation

petersandor
Copy link
Contributor

@petersandor petersandor commented Sep 11, 2019 •
edited by adidahiya
Loading

PR checklist

Overview of change:

Allows usage of JSDoc @author tag.

CHANGELOG.md entry:

[bugfix] no-redundant-jsdoc: allow @author tag

@palantirtech
Copy link
Member

Thanks for your interest in palantir/tslint, @petersandor! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Sep 17, 2019
View reviewed changes
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Code changes LGTM, including the devDependency version updates. Just want to confirm with @adidahiya first before merging. Thanks for this clean fix @petersandor!

adidahiya
adidahiya suggested changes Sep 30, 2019
View reviewed changes
yarn.lock
version "1.9.3"
resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.9.3.tgz#d7e4dd79245d85428c4d7e4822a79917954ca286"
integrity sha512-4krF8scpejhaOgqzBEcGM7yDIEfi0/8+8zDRZhNZZ2kjmHJ4hv3zCbQWxoJGz1iw5U0Jl0nma13xzHXcncMavQ==
version "1.10.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

we need to update "tslib" in the "dependencies" block as well, if we are testing against this version in development

Copy link
Contributor Author

@petersandor petersandor Oct 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I'm not sure if I understand, the usage of caret in version number ^1.x.x solves this, it is already being resolved to latest version which is 1.10.0.

Screenshot 2019-10-01 at 21 02 56

Copy link
Contributor

Choose a reason for hiding this comment

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

Sometimes features are added in typescript which require the latest version of the tslib library at runtime. So it's better to be safe and have tslint bump its minimum dependency to be "tslib": "^1.10.0"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 176e920

@petersandor
Copy link
Contributor Author

The build with typescript@next is now failing since it now uses the 3.7 beta that was released yesterday.

@JoshuaKGoldberg
Copy link
Contributor

We can ignore the typescript@next failures in this PR. They're unrelated: #4863.

@adidahiya
Copy link
Contributor

thanks for the PR @petersandor!

@adidahiya adidahiya merged commit e824f22 into palantir:master Oct 5, 2019
@petersandor petersandor deleted the fix/#4849-jsdoc-author-tag-support branch October 7, 2019 07:13
@adidahiya adidahiya mentioned this pull request Nov 3, 2019
Merged
@Zarel
Copy link

Zarel commented Nov 8, 2019

Can this be backported to 5.x?

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

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

@adidahiya adidahiya adidahiya 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.

@author tag not allowed at all by no-redundant-jsdoc
5 participants
@petersandor @palantirtech @JoshuaKGoldberg @adidahiya @Zarel