Skip to content
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.

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

style(): fix generated header comment linting #855

Merged
merged 2 commits into from
Mar 17, 2021
Merged

style(): fix generated header comment linting #855

merged 2 commits into from
Mar 17, 2021

Conversation

LMFinney
Copy link
Contributor

@LMFinney LMFinney commented May 8, 2020

Tweak the format of the generated header comment so that it doesn't conflict with https://palantir.github.io/tslint/rules/jsdoc-format/.

The file has tslint disabled, but this comment is above the disabling, so it can still report a problem.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[X] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

The header comment for generated files does not follow tsdoc conventions.

Issue Number: N/A

What is the new behavior?

The header comment for generated files does follow tsdoc conventions.

Does this PR introduce a breaking change?

[X] Yes
[ ] No

Other information

Tweak the format of the generated header comment so that it doesn't conflict with https://palantir.github.io/tslint/rules/jsdoc-format/.

The file has tslint disabled, but this comment is above the disabling, so it can still report a problem.
@kamilmysliwiec
Copy link
Member

Can you update the integration tests too?

Add a dash to the header for consistency
@LMFinney
Copy link
Contributor Author

@kamilmysliwiec Thanks for pointing that out. I've updated the integration tests.
I also added a dash to the first line of the header to match the last line.

I added it as a separate commit - I don't know if this project would have preferred an amend or squash.

@kamilmysliwiec kamilmysliwiec changed the base branch from master to 8.0.0 March 17, 2021 12:29
@kamilmysliwiec kamilmysliwiec merged commit 115b0af into nestjs:8.0.0 Mar 17, 2021
@kamilmysliwiec
Copy link
Member

This will be added in 8.0.0 release

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

Successfully merging this pull request may close these issues.

None yet

2 participants