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.

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

docs(eslint-plugin): improve docs [parameter-properties] #4879

Merged
merged 1 commit into from
Apr 29, 2022
Merged

docs(eslint-plugin): improve docs [parameter-properties] #4879

merged 1 commit into from
Apr 29, 2022

Conversation

miZyind
Copy link
Contributor

@miZyind miZyind commented Apr 29, 2022 •
edited
Loading

PR Checklist

Overview

I got this error when I first try this new rule by following the example on the document:

Configuration for rule "@typescript-eslint/parameter-properties" is invalid:
Value "parameter-properties" should be equal to one of the allowed values.

and here is my config:

"@typescript-eslint/parameter-properties": [
  "error",
  {
    "prefer": "parameter-properties"
  }
]

I checked the source code.
And found that the correct values of the prefer option should be: class-property, parameter-property.
However, the document shows class-properties and parameter-properties.

According to the schema of the source code, the allows option should be corrected to allow as well.

@nx-cloud
Copy link

nx-cloud bot commented Apr 29, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 78757fd. 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 43 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @miZyind!

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 Apr 29, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 78757fd
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/626b92b6de20cc0008bea680
😎 Deploy Preview https://deploy-preview-4879--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 Apr 29, 2022 •
edited
Loading

Codecov Report

Merging #4879 (78757fd) into main (f3cf87b) will increase coverage by 2.48%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4879      +/-   ##
==========================================
+ Coverage   91.77%   94.25%   +2.48%     
==========================================
  Files         227      153      -74     
  Lines       10611     8305    -2306     
  Branches     3283     2703     -580     
==========================================
- Hits         9738     7828    -1910     
+ Misses        591      263     -328     
+ Partials      282      214      -68
Flag Coverage Δ
unittest 94.25% <100.00%> (+2.48%) ⬆️

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

Impacted Files Coverage Δ
packages/eslint-plugin/src/configs/all.ts 100.00% <ø> (ø)
packages/eslint-plugin/src/rules/comma-spacing.ts 100.00% <100.00%> (ø)
...slint-plugin/src/rules/no-duplicate-enum-values.ts 100.00% <100.00%> (ø)
packages/utils/src/ts-eslint/Linter.ts
packages/typescript-estree/src/node-utils.ts
packages/typescript-estree/src/ast-converter.ts
packages/type-utils/src/getContextualType.ts
...estree/src/create-program/createIsolatedProgram.ts
packages/utils/src/ts-eslint-scope/index.ts
...internal/src/rules/no-typescript-default-import.ts
... and 68 more

JoshuaKGoldberg
JoshuaKGoldberg approved these changes Apr 29, 2022
View reviewed changes
Copy link
Member

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

D'oh, thanks!

@JoshuaKGoldberg JoshuaKGoldberg changed the title docs(eslint-plugin): improve docs [no-parameter-properties] docs(eslint-plugin): improve docs [parameter-properties] Apr 29, 2022
@JoshuaKGoldberg JoshuaKGoldberg merged commit b53de9b into typescript-eslint:main Apr 29, 2022
@miZyind miZyind deleted the docs/parameter-properties branch April 30, 2022 06:08
@miZyind miZyind mentioned this pull request May 9, 2022
Merged
3 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

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

Docs: correct example of parameter-properties
2 participants
@miZyind @JoshuaKGoldberg