Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.37 KB

quickstart.md

File metadata and controls

25 lines (18 loc) · 1.37 KB

CodeGeeX Extenstion Development Guidance

This is a simple guidance for developping CodeGeeX extenstion (for VS Code), you can add customizable features to CodeGeeX.

  • Clone Source Code

    • git clone git@github.com:CodeGeeX/codegeex-vscode-extension.git
    • cd codegeex-vscode-extension
  • Install Requirements

    • Use npm install to install packages required in package.json.
  • Modify Configuration

    • Set your own ApiKey and ApiSecret in src/localconfig.ts. ApiKey and ApiSecret can be applied in Tianqi API Platform.
    • If you want to enable a statistics collection, you need to set the server address for statsHerf;If disabled,just set enableStats=false
  • Run and Debug

    • Enter "Run and Debug" mode in the left Activity Bar in VS Code,and click on Run Extension to launch the extenstion to debug.
    • If the source code is modified, press cmd+R to reload the extension。
  • Generate VSIX Package

    • Use npm install -g vsce to install
    • Use vsce package to generate package in .vsix format.
    • In VS Code Extension settings, choose Install from VSIX to install the generated package.

If you have suggestions or developped cool features for CodeGeeX, please raise issues and pull requests. Contact us: codegeex@aminer.cn.