Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: modify type description #5615

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
Closed
wants to merge 1 commit into from
Closed

docs: modify type description #5615

wants to merge 1 commit into from

Conversation

XinChou16
Copy link

PR Checklist

Overview

fix docs type error

@nx-cloud
Copy link

nx-cloud bot commented Sep 8, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1aad257. 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, @XinChou16!

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 Sep 8, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 1aad257
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/63194211c7afa00009ff3100
😎 Deploy Preview https://deploy-preview-5615--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.

@XinChou16 XinChou16 marked this pull request as ready for review September 8, 2022 01:15
@codecov
Copy link

codecov bot commented Sep 8, 2022 •
edited
Loading

Codecov Report

Merging #5615 (1aad257) into main (8176fb1) will increase coverage by 0.88%.
The diff coverage is n/a.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5615      +/-   ##
==========================================
+ Coverage   91.63%   92.51%   +0.88%     
==========================================
  Files         134      308     +174     
  Lines        1506    10354    +8848     
  Branches      226     3123    +2897     
==========================================
+ Hits         1380     9579    +8199     
- Misses         62      486     +424     
- Partials       64      289     +225
Flag Coverage Δ
unittest 92.51% <ø> (+0.88%) ⬆️

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

Impacted Files Coverage Δ
...-plugin/src/rules/no-unnecessary-type-assertion.ts 94.66% <0.00%> (ø)
...plugin/src/rules/naming-convention-utils/shared.ts 100.00% <0.00%> (ø)
packages/type-utils/src/containsAllTypesByName.ts 0.00% <0.00%> (ø)
...src/configs/recommended-requiring-type-checking.ts 100.00% <0.00%> (ø)
...lugin/src/rules/indent-new-do-not-use/TokenInfo.ts 100.00% <0.00%> (ø)
...es/eslint-plugin/src/rules/no-loss-of-precision.ts 83.33% <0.00%> (ø)
...kages/eslint-plugin/src/rules/no-base-to-string.ts 98.41% <0.00%> (ø)
...s/eslint-plugin/src/rules/no-dupe-class-members.ts 87.50% <0.00%> (ø)
...t-plugin/src/rules/no-meaningless-void-operator.ts 100.00% <0.00%> (ø)
.../eslint-plugin/src/util/explicitReturnTypeUtils.ts 96.38% <0.00%> (ø)
... and 164 more

@JoshuaKGoldberg
Copy link
Member

The docs are correct. The property is program, not programs.

typescript-eslint/packages/types/src/parser-options.ts

Line 52 in 4de978d

program?: Program;

If you think you've identified an issue, please:

  • Make sure it's actually an issue...
  • If it is, provide supporting evidence. For this one, I'd want to see a case where programs is used

@JoshuaKGoldberg JoshuaKGoldberg added the please fill out the template we have the processes for good reasons 😔 label Sep 8, 2022
@XinChou16
Copy link
Author

look at this, https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/README.md#parseroptionsprograms

so there should be program ? @JoshuaKGoldberg

@JoshuaKGoldberg
Copy link
Member

Interesting - so we do have interface ParseAndGenerateServicesOptions extends ParseOptions inside the typescript-estree package, that contains a programs?: ts.Program[].

typescript-eslint/packages/typescript-estree/src/parser-options.ts

Lines 166 to 171 in efc147b

/**
* An array of one or more instances of TypeScript Program objects to be used for type information.
* This overrides any program or programs that would have been computed from the `project` option.
* All linted files must be part of the provided program(s).
*/
programs?: ts.Program[];

But, that's not the same as what the parser README is describing. I think this rolls up into #5090: this area of code isn't quite documented for end users.

@XinChou16
Copy link
Author

OK，I got it, thanks a lot.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
please fill out the template we have the processes for good reasons 😔
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@XinChou16 @JoshuaKGoldberg