Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Docs: Use a URL shortener for links printed by code #9023

Copy link
Copy link
Open
@JoshuaKGoldberg

Description

@JoshuaKGoldberg
Issue body actions

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

We occasionally need to print long links in code. For example, when using a deprecated property, we'll print something like:

The 'typeParameters' property is deprecated on CallExpression nodes. Use 'typeArguments' instead. See https://typescript-eslint.io/linting/troubleshooting#the-key-property-is-deprecated-on-type-nodes-use-key-instead-warnings.

That link is long and unwieldy. Also, if we ever want to change the page path and/or hash link, we need to set up redirects. I'm working on #8926 right now and can already tell it's going to be lot of netlify.toml entries - and maybe even runtime code.

Proposal: how about we start using a URL shortener for smaller, more permanent links? A few options come to mind:

  • Same domain, verbose keys: https://typescript-eslint.io/link/key-is-deprecated
  • Same domain, short keys: https://typescript-eslint.io/link/abc123
  • Shorter domain, verbose keys: https://tseslint.io/key-is-deprecated
  • Shorter domain, short keys: https://tseslint.io/abc123

tseslint.dev and tseslint.io are both available...

Affected URL(s)

n/a

💖

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation ("docs") that needs adding/updatingDocumentation ("docs") that needs adding/updatingteam assignedA member of the typescript-eslint team should work on this.A member of the typescript-eslint team should work on this.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.