An open API service for providing issue and pull request metadata for open source projects.

GitHub / typescript-eslint/typescript-eslint issues and pull requests

Labelled with: documentation

#11724 - Docs: Dead link in Migrating to defineConfig(...) docs

Issue - State: open - Opened by JLHwung about 1 month ago - 1 comment
Labels: good first issue, documentation, accepting prs

#11685 - Docs: Inconsistency with ESLint verbiage

Issue - State: open - Opened by Zamiell about 2 months ago - 4 comments
Labels: triage, documentation

#11681 - Docs: [consistent-type-imports] Revise recommended usage

Issue - State: open - Opened by aaronadamsCA about 2 months ago - 2 comments
Labels: triage, documentation

#11619 - Docs: Improve config deprecation message

Issue - State: open - Opened by darcyrush 2 months ago
Labels: triage, documentation

#11572 - Docs: Add blog post explaining the deprecation of typedef

Issue - State: open - Opened by JoshuaKGoldberg 3 months ago
Labels: triage, documentation

#11532 - Docs: Add a snippet to the parser`tsconfigRootDir` option docs

Issue - State: open - Opened by JoshuaKGoldberg 3 months ago
Labels: triage, documentation

#11514 - Docs: "Projects With Type Checking" missing `parserOptions`

Issue - State: closed - Opened by thernstig 3 months ago - 6 comments
Labels: documentation, accepting prs

#11492 - Docs: release notes link to netlify.app

Issue - State: open - Opened by jendrikw 3 months ago
Labels: triage, documentation

#11461 - Docs: Not all reported problems of `no-redeclare` are covered by TypeScript

Issue - State: open - Opened by ulrichstark 4 months ago
Labels: triage, documentation

#11450 - Docs: LocalTimeOfRelease does not handle daylight savings

Issue - State: closed - Opened by matt-blanchette 4 months ago - 1 comment
Labels: documentation, accepting prs

#11420 - Docs: [no-base-to-string] erroneously refers to regular expressions

Issue - State: closed - Opened by tyilo 4 months ago - 8 comments
Labels: package: eslint-plugin, documentation, accepting prs

#11416 - Docs: Establish and document expectations around use of AI in contributions

Issue - State: open - Opened by kirkwaiblinger 4 months ago
Labels: triage, documentation

#11378 - Docs: [no-unnecessary-condition] list of checked expressions is stale

Issue - State: closed - Opened by kirkwaiblinger 5 months ago - 1 comment
Labels: documentation, accepting prs

#11373 - Docs: Detail how to get typescript-eslint to lint files from your tsconfig.json `include` list

Issue - State: closed - Opened by cefn 5 months ago - 1 comment
Labels: triage, documentation

#11349 - Docs: Typed linting warning appears in a weird spot

Issue - State: open - Opened by kirkwaiblinger 5 months ago
Labels: triage, documentation

#11344 - Docs: [only-throw-error] default value of `allowRethrowing` is wrong

Issue - State: closed - Opened by zanminkian 5 months ago - 2 comments
Labels: documentation, accepting prs

#11314 - Docs: Remove legacy notes about CJS config file extensions and `__dirname_`

Issue - State: open - Opened by JoshuaKGoldberg 5 months ago
Labels: triage, documentation

#11313 - Docs: Mention ESLint's `defineConfig` (until `tseslint.config` is deprecated)

Issue - State: closed - Opened by JoshuaKGoldberg 5 months ago
Labels: documentation, team assigned, locked due to age

#11224 - Docs: changelog isnt viewable in github anymore

Issue - State: open - Opened by ImLunaHey 7 months ago
Labels: triage, documentation

#11220 - Docs: Clarify how the `config()` helper handles rule merging in flat config

Issue - State: closed - Opened by wujekbogdan 7 months ago - 1 comment
Labels: triage, documentation

#11210 - Docs: Mention jsdoc/no-undefined-types & similar in no-unused-vars docs page

Issue - State: open - Opened by JoshuaKGoldberg 7 months ago
Labels: triage, documentation

#11188 - Docs: provide additional clarity for the "Linting with type information" page

Issue - State: closed - Opened by TheSisb 7 months ago - 5 comments
Labels: triage, documentation, locked due to age

#11187 - Docs: Mark typedef as deprecated / feature frozen

Issue - State: open - Opened by JoshuaKGoldberg 7 months ago
Labels: triage, documentation

#11184 - Docs: Homepage overhaul

Issue - State: open - Opened by JoshuaKGoldberg 7 months ago
Labels: triage, documentation

#11173 - Docs: [only-throw-error] give explanation of options

Issue - State: open - Opened by kirkwaiblinger 7 months ago
Labels: triage, documentation

#11117 - Docs: simplify array type declarations on rule pages

Issue - State: closed - Opened by kirkwaiblinger 7 months ago - 1 comment
Labels: documentation, accepting prs

#11107 - Docs: The configuration item "extends" has been deprecated

Issue - State: closed - Opened by heyingjiee 7 months ago - 2 comments
Labels: triage, documentation

#11102 - Docs: <a short description of my proposal>

Issue - State: open - Opened by RobertStanyon 7 months ago
Labels: triage, documentation

#11063 - Docs: Add explainer around `any` alternatives with no-explicit-any

Issue - State: open - Opened by JoshuaKGoldberg 8 months ago
Labels: triage, documentation

#11062 - Docs: Broken links to source code

Issue - State: closed - Opened by aleclarson 8 months ago - 1 comment
Labels: documentation, accepting prs

#11056 - Docs: Blog post / guide on 'evaluating community engagement' rules

Issue - State: open - Opened by JoshuaKGoldberg 8 months ago
Labels: documentation, team assigned

#11016 - Docs: Mention sourceType in parser/parserOptions

Issue - State: open - Opened by JoshuaKGoldberg 8 months ago - 2 comments
Labels: documentation, team assigned

#10970 - Docs: [no-unnecessary-condition mention subtleties of primitives' assignability

Issue - State: open - Opened by kirkwaiblinger 8 months ago
Labels: triage, documentation

#10935 - Docs: Mention defineConfig(); remove mention of tseslint.config()

Issue - State: closed - Opened by nzakas 9 months ago - 42 comments
Labels: documentation, team assigned

#10920 - Docs: Mention how to ban top-level-await

Issue - State: open - Opened by kirkwaiblinger 9 months ago
Labels: triage, documentation

#10914 - Docs: fix example `disable-type-checked`

Issue - State: closed - Opened by dartess 9 months ago - 2 comments
Labels: triage, documentation, awaiting response, please fill out the template

#10905 - Docs: Mention that the `eslint-plugin` and the `parser` packages aren't needed with ESLint 9

Issue - State: closed - Opened by MariaSolOs 9 months ago - 10 comments
Labels: documentation, accepting prs

#10876 - Docs: Explain differences between Record and index keys somewhere

Issue - State: open - Opened by JoshuaKGoldberg 9 months ago
Labels: triage, documentation

#10856 - Docs: Mention differences between `tseslint.config`'s `extends` and ESLint core's

Issue - State: open - Opened by JoshuaKGoldberg 9 months ago
Labels: triage, documentation

#10830 - Docs: [prefer-optional-chain] Correct/incorrect examples for multiple options are identical

Issue - State: closed - Opened by alythobani 10 months ago - 1 comment
Labels: documentation, accepting prs

#10826 - Docs: Explain how `tsconfigRootDir` interacts with `projectService`

Issue - State: open - Opened by MariaSolOs 10 months ago
Labels: triage, documentation

#10819 - Docs: Add FAQs around typed rule development

Issue - State: open - Opened by JoshuaKGoldberg 10 months ago
Labels: triage, documentation

#10759 - Docs: Remove the generally unused roles system

Issue - State: closed - Opened by JoshuaKGoldberg 10 months ago
Labels: documentation, accepting prs

#10758 - Docs: Getting Started - invalid eslint.config.mjs example

Issue - State: open - Opened by hidarikani 10 months ago
Labels: triage, documentation

#10705 - Docs: Mention JSX conditional rendering with no-unnecessary-condition

Issue - State: open - Opened by JoshuaKGoldberg 10 months ago
Labels: triage, documentation

#10683 - docs: use consistent verbiage around authoring pull requests in contributor tiers docs

Pull Request - State: closed - Opened by kirkwaiblinger 10 months ago - 3 comments
Labels: documentation, 1 approval

#10683 - docs: use consistent verbiage around authoring pull requests in contributor tiers docs

Pull Request - State: closed - Opened by kirkwaiblinger 10 months ago - 3 comments
Labels: documentation, 1 approval

#10669 - Docs: mark rules that are frozen on rules index page

Issue - State: open - Opened by rakleed 11 months ago - 3 comments
Labels: documentation, accepting prs

#10663 - Docs: No sure the point of @typescript-eslint/consistent-type-exports

Issue - State: closed - Opened by GuichiZhao 11 months ago - 3 comments
Labels: documentation, awaiting response

#10622 - docs(typescript-eslint): Inconsistent description on the usage of config helper function

Issue - State: closed - Opened by ebarooni 11 months ago - 1 comment
Labels: documentation, accepting prs

#10621 - Docs: `Toggle word wrap` and `Copy` buttons in code examples almost invisible

Issue - State: closed - Opened by rakleed 11 months ago - 2 comments
Labels: triage, documentation

#10615 - Docs: Add `simpleTraverse` function docs

Issue - State: closed - Opened by aleclarson 11 months ago - 3 comments
Labels: documentation, awaiting response

#10605 - Docs: How to use in JS-only projects?

Issue - State: open - Opened by rakleed 11 months ago - 3 comments
Labels: triage, documentation

#10588 - docs: add FAQ and docs around `verbatimModuleSyntax` and similar options

Pull Request - State: closed - Opened by kirkwaiblinger 11 months ago - 4 comments
Labels: documentation, 1 approval

#10588 - docs: add FAQ and docs around `verbatimModuleSyntax` and similar options

Pull Request - State: closed - Opened by kirkwaiblinger 11 months ago - 4 comments
Labels: documentation, 1 approval

#10580 - Website: TSConfig errors are not shown in playground

Issue - State: open - Opened by ronami 11 months ago
Labels: triage, documentation

#10570 - Website: TSConfig isolatedDeclarations errors not reported

Issue - State: open - Opened by JoshuaKGoldberg 11 months ago
Labels: triage, documentation

#10568 - Docs: Mention `verbatimModuleSyntax` in docs for rules that encourage ESM import syntax

Issue - State: closed - Opened by kirkwaiblinger 11 months ago - 3 comments
Labels: documentation, accepting prs

#10566 - Docs: [prefer-nullish-coalescing] streamline code examples

Issue - State: open - Opened by kirkwaiblinger 11 months ago
Labels: triage, documentation

#10562 - Docs: standardize name-preficiation

Issue - State: open - Opened by lishaduck 11 months ago
Labels: triage, documentation

#10558 - Docs: Deprecate `no-for-in-array`

Issue - State: closed - Opened by kirkwaiblinger 11 months ago - 4 comments
Labels: wontfix, triage, documentation

#10501 - Docs: Add Bluesky social icons for team members

Issue - State: closed - Opened by JoshuaKGoldberg 12 months ago
Labels: documentation, team assigned, locked due to age

#10483 - Docs: link to docs for previous major versions, with the appropriate caveats

Issue - State: closed - Opened by That-Guy977 12 months ago - 8 comments
Labels: documentation, team assigned

#10466 - Docs: Make sure all extension rules explain why they override base rules

Issue - State: closed - Opened by JoshuaKGoldberg 12 months ago - 1 comment
Labels: documentation, accepting prs

#10465 - Docs: Automate including a link to core rules in extension rule pages

Issue - State: closed - Opened by JoshuaKGoldberg 12 months ago - 1 comment
Labels: documentation, accepting prs

#10423 - Docs: return-await doc page should say the rule is in the strict-type-checked ruleset, not recommended

Issue - State: closed - Opened by kirkwaiblinger 12 months ago
Labels: documentation, accepting prs

#10388 - Docs: Blog post or other explainer on improving test coverage in RuleTester tests

Issue - State: open - Opened by JoshuaKGoldberg about 1 year ago
Labels: triage, documentation

#10379 - Docs: add a description of how to disable a file / single line with comments

Issue - State: closed - Opened by githorse about 1 year ago - 3 comments
Labels: triage, documentation

#10364 - Docs: Add blog post about history and usage of TypeScript's isTypeAssignableTo API

Issue - State: open - Opened by JoshuaKGoldberg about 1 year ago
Labels: triage, documentation

#10335 - Docs: [no-confusing-void-expression] missing default for option "ignoreVoidReturningFunctions"

Issue - State: closed - Opened by danielrentz about 1 year ago
Labels: documentation, accepting prs

#10280 - Docs: Update project license to explicitly say BSD-2-Clause

Issue - State: closed - Opened by bryan-yager about 1 year ago - 5 comments
Labels: good first issue, documentation, accepting prs

#10273 - Docs: Add a troubleshooting section for out-of-memory errors

Issue - State: open - Opened by JoshuaKGoldberg about 1 year ago
Labels: triage, documentation

#10264 - Docs: settings in Quick Start run in quirks mode currently which behave different Legacy ESLint Setup

Issue - State: open - Opened by me1ting about 1 year ago
Labels: triage, documentation

#10237 - Docs: enable `respectPrefersColorScheme` in docusaurus `themeConfig`

Issue - State: closed - Opened by hyoban about 1 year ago - 2 comments
Labels: documentation, accepting prs, locked due to age

#10202 - Docs: Highlight performance issues with type-aware rules

Issue - State: open - Opened by nzakas about 1 year ago
Labels: triage, documentation

#10180 - docs: fix the Dependency Versions lists

Pull Request - State: closed - Opened by developer-bandi about 1 year ago - 3 comments
Labels: documentation

#10180 - docs: fix the Dependency Versions lists

Pull Request - State: closed - Opened by developer-bandi about 1 year ago - 3 comments
Labels: documentation

#10170 - Docs: Dependency Versions lists ESLint support as v9, but we still support v8

Issue - State: closed - Opened by JoshuaKGoldberg about 1 year ago
Labels: documentation, accepting prs

#10166 - Docs: Update FAQ for Javascript files using Flat config

Issue - State: closed - Opened by ankitprahladsoni about 1 year ago - 2 comments
Labels: documentation, accepting prs

#10118 - Docs: The Prettier example has type errors

Issue - State: closed - Opened by robcresswell about 1 year ago - 2 comments
Labels: documentation, awaiting response

#10113 - Docs: Separate typescript package installation in getting started page

Issue - State: closed - Opened by rchandu about 1 year ago - 5 comments
Labels: triage, documentation

#10102 - Docs: Update the State of the `order` Rule Alternative

Issue - State: closed - Opened by manuth about 1 year ago - 4 comments
Labels: good first issue, documentation, accepting prs

#10075 - Docs: Write blog post about our enum rules

Issue - State: open - Opened by kirkwaiblinger about 1 year ago
Labels: triage, documentation

#10047 - Docs: broken link about typed linting

Issue - State: closed - Opened by markH5 about 1 year ago - 1 comment
Labels: good first issue, documentation, accepting prs

#10041 - Docs: Clarify that no-duplicate-type-constituents does not conflict with `exactOptionalPropertyTypes`

Issue - State: closed - Opened by justmoon about 1 year ago - 1 comment
Labels: documentation, accepting prs

#10034 - Docs: [prefer-literal-enum-member] Ensure invalid examples are invalid and remove TS errors as examples

Issue - State: closed - Opened by kirkwaiblinger about 1 year ago - 1 comment
Labels: triage, documentation, accepting prs

#10029 - docs: [no-unsafe-enum-comparison] clarify motivation and applicability

Pull Request - State: closed - Opened by kirkwaiblinger about 1 year ago - 4 comments
Labels: documentation, 1 approval

#10022 - Docs: Blog post on the benefits of typed linting

Issue - State: closed - Opened by JoshuaKGoldberg about 1 year ago
Labels: documentation, team assigned

#10000 - Docs: Add a rick roll somewhere in the docs

Issue - State: open - Opened by JoshuaKGoldberg about 1 year ago - 3 comments
Labels: documentation, team assigned

#9993 - Docs: customizing recommended rules with flat config

Issue - State: open - Opened by altano about 1 year ago
Labels: triage, documentation

#9975 - docs: [no-unnecessary-type-parameters] add FAQ section

Pull Request - State: closed - Opened by kirkwaiblinger about 1 year ago - 5 comments
Labels: documentation

#9975 - docs: [no-unnecessary-type-parameters] add FAQ section

Pull Request - State: closed - Opened by kirkwaiblinger about 1 year ago - 5 comments
Labels: documentation

#9947 - Docs: [no-floating-promises] voiding Promise doesn't make it handled

Issue - State: closed - Opened by alexandercerutti about 1 year ago - 3 comments
Labels: documentation, accepting prs

#9928 - Docs: ```json code snippets not highlighted in docs

Issue - State: open - Opened by JoshuaKGoldberg about 1 year ago
Labels: bug, triage, documentation, package: website

#9913 - Docs: Mark allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing options as deprecated

Issue - State: closed - Opened by JoshuaKGoldberg about 1 year ago
Labels: documentation, accepting prs

#9908 - Docs: should there be a guide JSDoc set up?

Issue - State: open - Opened by johnnyreilly about 1 year ago
Labels: triage, documentation

#9890 - Bug: [no-unnecessary-type-parameters] Generic required for curried function params

Issue - State: closed - Opened by eranhirsch over 1 year ago - 12 comments
Labels: package: eslint-plugin, documentation

#9873 - docs: add website-eslint README.md

Pull Request - State: closed - Opened by JoshuaKGoldberg over 1 year ago - 4 comments
Labels: documentation, 1 approval