TJS for Visual Studio Code

日本語版のREADMEはこちらにあります。

Adds TJS language support for Visual Studio Code. If you needs KAG/KAGEX support, check kagex-vscode.

Features

• Full syntax highlighting including type specifiers on Kirikiri Z
• Ctags support
• Snippets such as class, function and for loop
• The codes between "//#region" and "//#endregion" can be folded
• The Reference search pallet to open API references

Supported environments

Syntax highlighting, language configuration, snippets, document colors, and reference search are available in local, remote, Virtual Workspace, and VS Code for the Web environments.

Ctags requires a trusted workspace whose files are accessible to an external process. It is unavailable in Virtual Workspaces such as GitHub Repositories and in browser-only environments such as vscode.dev and github.dev. When using Remote SSH, WSL, a Dev Container, Codespaces, or a Remote Tunnel, install ctags on the remote side.

Reference search palette

You can open API references with your browser by following the steps

1. Push Ctrl+Shift+P to open the Command Pallet.
2. Execute the command "TJS: Open reference search palette".
3. Input class name to open the reference. "Ctrl+Shift+Alt+R" is default shortcut key to open reference search palette.

Configuration

You can choose references to search by following configuration. By default, TJS reference and kirikiriZ reference is enabled.

  "tjs.referencePalletEnable": {
    "tjs": true, // TJS reference
    "krkrZ": true, // kirikiriZ reference
    "krkr2": false, // kirikiri2 reference
    "dll": false // some dll reference
  }

Optional: Ctags support

You must install ctags to use code navigation features such as "Go to Definition and "Peek definition".

Installation

1. Install ctags and put it in your system path. I recommend Exuberant Ctags.
2. Install ctagsx to Visual Studio Code.

Update index file

1. Open the directory which contains tjs files with Visual Studio Code.
2. Push Ctrl+Shift+P to open command palette.
3. Execute the command "TJS: Update Ctags File".

Now ".tags" file is created in your directory and you can use ctagsx features.

Configuration

You can change ctags behavior by the following configuration.

  "tjs.ctagsProcess": [
    {
      "tagFilePath": ".tags", // Path to Ctags' index file
      "searchPath": "", // Path to the directory where ctags search tjs files
      "searchRecursive": true, // Whether search tjs files recursively
      "runOnSave": false, // Whether recreate the index file automatically when tjs file is saved
      "fileExtensions": [ // File extensions to be searched as tjs file
        ".tjs"
      ],
      "extraArgs": [ // One Ctags argument per item (optional)
        "--exclude=node_modules"
      ],
      "timeoutMs": 120000 // 0 disables the timeout
    }
  ]

If you want to generate multiple index files, define multiple settings in tjs.ctagsProcess.

Below is the example to generate index files in src and out directory.

  "tjs.ctagsProcess": [
    // Search tjs files in src directory and generate "src/.tags"
    {
      "tagFilePath": "src/.tags",
      "searchPath": "src/",
      "searchRecursive": true,
      "runOnSave": true,
    },
    // Search tjs files in out directory and generate "out/.tags"
    {
      "tagFilePath": "out/.tags",
      "searchPath": "out/",
      "searchRecursive": true,
      "runOnSave": true,
    }
  ]

Issues

Submit the issues if you find any bug or have any suggestion.