microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.67k stars 131 forks source link

Pipe character rendered when using @link url alias #340

Closed StephenSHorton closed 1 year ago

StephenSHorton commented 1 year ago

Expected image

Actual image

Code

/**
 * A nominal type that we use to links objects together in a way stronger than primitive types will
 *
 * @remarks
 * Found this convention {@link https://michalzalecki.com/nominal-typing-in-typescript/ | here}
 */
type NominalUID = string & { readonly __uid: unique symbol }

My .eslintrc.json

{
  "env": {
    "browser": true,
    "es2021": true,
    "node": true
  },
  "extends": [
    "eslint:recommended",
    "plugin:react/recommended",
    "plugin:@typescript-eslint/recommended"
  ],
  "overrides": [],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": "latest",
    "sourceType": "module"
  },
  "plugins": ["react", "@typescript-eslint", "eslint-plugin-tsdoc"],
  "rules": {
    "tsdoc/syntax": "warn",
    "react/react-in-jsx-scope": "off",
    "@typescript-eslint/no-empty-interface": "off",
    "no-console": "warn"
  }
}

Using this version of the eslint-plugin-tsdoc package

"eslint-plugin-tsdoc": "^0.2.17"

My editor is Visual Studio Code v1.74.3

StephenSHorton commented 1 year ago

I apologize I realize this is likely unrelated to tsdoc and probably more relevant to my editor.