Skip to content

docs(eslint-plugin): [ban-ts-comment] include descriptionFormat #5283

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
Merged
merged 1 commit into from
Jul 2, 2022
Merged

docs(eslint-plugin): [ban-ts-comment] include descriptionFormat #5283

merged 1 commit into from
Jul 2, 2022

Conversation

Josh-Cena
Copy link
Member

PR Checklist

Overview

Cover-up from #5026

@nx-cloud
Copy link

nx-cloud bot commented Jul 2, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9c3294e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @Josh-Cena!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@netlify
Copy link

netlify bot commented Jul 2, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 9c3294e
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/62bfb906d4fd2b000928ffed
😎 Deploy Preview https://deploy-preview-5283--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@codecov
Copy link

codecov bot commented Jul 2, 2022 •
edited
Loading

Codecov Report

Merging #5283 (9c3294e) into main (75a86d9) will increase coverage by 2.09%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #5283      +/-   ##
==========================================
+ Coverage   91.67%   93.76%   +2.09%     
==========================================
  Files         363      287      -76     
  Lines       12227     9871    -2356     
  Branches     3549     2954     -595     
==========================================
- Hits        11209     9256    -1953     
+ Misses        668      335     -333     
+ Partials      350      280      -70
Flag Coverage Δ
unittest 93.76% <ø> (+2.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...lugin-internal/src/rules/plugin-test-formatting.ts
packages/utils/src/ast-utils/helpers.ts
packages/utils/src/ts-eslint-scope/Reference.ts
...ckages/utils/src/eslint-utils/getParserServices.ts
...ript-estree/src/create-program/createSourceFile.ts
packages/utils/src/ts-eslint/RuleTester.ts
packages/visitor-keys/src/get-keys.ts
...estree/src/create-program/createIsolatedProgram.ts
...ges/typescript-estree/src/create-program/shared.ts
packages/type-utils/src/getSourceFileOfNode.ts
... and 66 more

@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Jul 2, 2022
bradzacher
bradzacher approved these changes Jul 2, 2022
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

thanks!

@bradzacher bradzacher changed the title docs: [ban-ts-comment] include descriptionFormat docs(eslint-plugin): [ban-ts-comment] include descriptionFormat Jul 2, 2022
@bradzacher bradzacher merged commit e5964cf into typescript-eslint:main Jul 2, 2022
@Josh-Cena Josh-Cena deleted the descriptionFormat-doc branch July 2, 2022 04:10
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: ban-ts-comment is missing description of a new descriptionFormat option
2 participants
@Josh-Cena @bradzacher