coc-tsserver 开源项目教程

coc-tsserver 开源项目教程

coc-tsserverTsserver extension for coc.nvim that provide rich features like VSCode for javascript & typescript项目地址:https://gitcode.com/gh_mirrors/co/coc-tsserver

1. 项目的目录结构及介绍

coc-tsserver 是一个用于提供 TypeScript 和 JavaScript 语言支持的插件，它是基于 coc.nvim 的扩展。以下是该项目的目录结构及其介绍：

coc-tsserver/
├── autoload/
│   └── coc.vim
├── doc/
│   └── coc-tsserver.txt
├── package.json
├── README.md
├── src/
│   ├── completion.ts
│   ├── config.ts
│   ├── index.ts
│   ├── language-client.ts
│   ├── logger.ts
│   ├── server.ts
│   └── util.ts
├── tsconfig.json
└── yarn.lock

• autoload/: 包含自动加载的 Vim 脚本文件。
• doc/: 包含项目的文档文件。
• package.json: 项目的 npm 配置文件，定义了项目的依赖和脚本。
• README.md: 项目的介绍和使用说明。
• src/: 包含项目的源代码文件。
  • completion.ts: 提供代码补全功能。
  • config.ts: 处理配置相关逻辑。
  • index.ts: 项目的主入口文件。
  • language-client.ts: 语言客户端的实现。
  • logger.ts: 日志记录功能。
  • server.ts: 服务器相关逻辑。
  • util.ts: 工具函数。
• tsconfig.json: TypeScript 的配置文件。
• yarn.lock: 锁定依赖版本的文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。这个文件是整个插件的入口点，负责初始化插件并启动 TypeScript 语言服务器。以下是 src/index.ts 的主要内容：

import { ExtensionContext, services, workspace } from 'coc.nvim';
import { LanguageClient } from './language-client';
import { Logger } from './logger';

export async function activate(context: ExtensionContext): Promise<void> {
  const logger = new Logger();
  logger.info('coc-tsserver activated');

  const client = new LanguageClient(logger);
  context.subscriptions.push(
    services.registLanguageClient(client),
    workspace.registerKeymap(
      ['n'],
      'tsserver-reload',
      async () => {
        await client.reload();
      },
      { silent: true, sync: false }
    )
  );
}

• activate 函数是插件的激活函数，当插件被加载时会调用这个函数。
• Logger 类用于记录日志。
• LanguageClient 类是语言客户端的实现，负责与 TypeScript 语言服务器进行通信。

3. 项目的配置文件介绍

项目的配置文件是 package.json。这个文件定义了项目的依赖、脚本和其他元数据。以下是 package.json 的主要内容：

{
  "name": "coc-tsserver",
  "version": "1.0.0",
  "description": "TypeScript language server extension for coc.nvim",
  "main": "lib/index.js",
  "scripts": {
    "build": "tsc -p .",
    "watch": "tsc -p . -w",
    "prepublish": "npm run build"
  },
  "keywords": [
    "coc.nvim",
    "TypeScript",
    "language-server"
  ],
  "author": "neoclide",
  "license": "MIT",
  "engines": {
    "coc": "^0.0.80"
  },
  "dependencies": {
    "coc.nvim": "^0.0.80",
    "typescript-language-server": "^0.5.0"
  },
  "devDependencies": {
    "@types/node": "^14.14.22",
    "typescript": "^4.1.3"
  }
}

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• `main

coc-tsserverTsserver extension for coc.nvim that provide rich features like VSCode for javascript & typescript项目地址:https://gitcode.com/gh_mirrors/co/coc-tsserver