/vscode-comment-queries

Primary LanguageTypeScriptMIT LicenseMIT

vscode-comment-queries README

通过注释语法与内嵌提示展示你的代码中的变量类型。

演示

type T = {
  a: string
  c?: boolean
  d: 'some desc\n\\n'
  e: {
    f: string
    g: true
  }
  fff: 'fier'
}

//   _?
type T0 = T['a']
//   ^?

type T2 = T['e']['f']
//   ^?
//           ^x2?
//               ^x3?

// @4,4?

功能

  • 支持多语言

    • TypeScript
    • Python
    • Golang
  • 相对文件行列 query 查询

    • 上下文件行
    //   _x2?
    //   _?
    type T = 1 | 2
    //   ^?
    //   ^x2?
    • 左右文件列
    type /*>?*/ T /*<?*/ = 1 | 2
  • 绝对文件行列 query 查询

    • 当前文件指定行列

      // @114,514?
      // @[114, 514]?
    • 跨文件指定行列查询

      • 相对路径支持

        // @./foo.ts:114:514?
      • 绝对路径支持

        // @/users/xxx/codes/foo.ts:114:514?

插件配置

  • 移除提示消息的前缀

Q&A

  • Q: 在顶行上行查询或者底行下行查询会报错(可能)
  • A: 我没做校验,先不做

Release Notes