Kaven-VSCode

Kaven-VSCode is a collection of practical VS Code utilities for everyday development. It provides text conversion, code cleanup, file header maintenance, path copying, version helpers, diagnostic fixes, and ANSI content previews in one extension.

The extension supports both desktop VS Code and VS Code for the Web. Every command is available from the Command Palette, while frequently used commands are also included in editor or Explorer context menus.

Requirements

• VS Code 1.103.0 or later
• Some commands require an open workspace, an active editor, or selected text
• Features related to cSpell, ESLint, TSLint, and markdownlint require their corresponding extensions

Installation and usage

Search for Kaven-VSCode in the VS Code Extensions view and install it. After installation:

1. Press Ctrl+Shift+P (Cmd+Shift+P on macOS) to open the Command Palette.
2. Enter Kaven: to browse the available commands.
3. Alternatively, right-click in an editor and use the Quick Action, Refactoring, or Sort submenu. File-related commands are available from the Explorer context menu.

Text conversion commands generally operate on the current selection. Commands that support document-wide processing use the entire document when there is no selection.

Feature highlights

Simplified and Traditional Chinese conversion

The extension uses OpenCC dictionaries for phrase-aware Chinese conversion. This allows characters with multiple possible mappings to be converted according to context instead of using simple character-by-character replacement.

• Kaven: To Traditional Chinese converts Simplified Chinese to OpenCC standard Traditional Chinese.
• Kaven: To Simplified Chinese converts Traditional Chinese to Mainland Simplified Chinese.

The commands convert the selected text, or the entire document when there is no selection.

Example:

汉字转换：头发与软件开发
漢字轉換：頭髮與軟件開發

File header generation and maintenance

The extension can create a consistent header for supported source files. Existing headers can be updated with the modification time, edit count, line count, project version, file path, and current copyright year.

• Kaven: Generate File Header creates or updates the header in the active file.
• Kaven: Generate File Headers for Git Changes processes staged, unstaged, untracked, and conflicted files reported by VS Code's built-in Git extension, then saves changed files.
• Kaven.generateFileHeader.autoGenerateWhenSave is enabled by default and maintains headers whenever supported files are saved.
• Header comment styles can be overridden by file extension. For example, Dart files can use a //-based header.

Variable names and text formatting

Kaven: Format Variable Name converts selected text into any of the following formats and remembers the most recently used format:

my_variable_name
myVariableName
MY_VARIABLE_NAME
MyVariableName
my variable name
My Variable Name
my-variable-name
[MyVariableName](#my-variable-name)
[My Variable Name](#my-variable-name)

For multiline assignments, the command attempts to convert only the variable name on the left side of the equals sign.

Code wrapping and automatic fixes

• Wrap selected code in a region, a try/catch block, or lint-disable comments.
• Configure try/catch templates per language and run formatting commands after wrapping.
• Run a configurable sequence of TSLint, ESLint, markdownlint, import organization, or other VS Code commands.

Commands

Text conversion

Sorting and cleanup

Code assistance

Files, versions, and dates

Preview and export

Configuration

Search for Kaven in VS Code Settings, or edit settings.json directly.

General settings

File header settings

The following Boolean settings control whether individual fields are included. They all default to true:

authorEnable, emailEnable, websiteEnable, fileEnable, createEnable,
modifyEnable, versionEnable, timesEnable, linesEnable, copyrightEnable,
descEnable, licenseEnable

Each complete setting name starts with Kaven.generateFileHeader..

Example:

{
    "Kaven.generateFileHeader.author": "Your Name",
    "Kaven.generateFileHeader.email": "you@example.com",
    "Kaven.generateFileHeader.projectName": "my-project",
    "Kaven.generateFileHeader.enableFileTypes": [
        ".ts",
        ".js",
        ".go",
        ".dart"
    ],
    "Kaven.generateFileHeader.excludeFiles": [
        "./node_modules",
        "./dist"
    ],
    "Kaven.generateFileHeader.override": [
        {
            "ext": ".dart",
            "firstLine": "////////////////////////////////////////////////////////////////////",
            "middleLinePrefix": "// @",
            "lastLine": "////////////////////////////////////////////////////////////////////"
        }
    ]
}

Automatic fix settings

The commands array in Kaven.autoFixAll describes the commands to run in order. Each item supports:

• command: the VS Code command ID.
• args: an array of arguments passed to the command.
• extension: optional extension ID; the command only runs when that extension is installed.
• source: optional diagnostic source; the extension repeats the fix until the problem count no longer decreases.
• checkExists: optionally check whether the command exists before running it.
• delay: optional delay in milliseconds before running the command.

{
    "Kaven.autoFixAll": {
        "commands": [
            {
                "extension": "dbaeumer.vscode-eslint",
                "source": "eslint",
                "command": "eslint.executeAutofix",
                "args": [],
                "checkExists": true
            },
            {
                "command": "editor.action.organizeImports",
                "args": [],
                "delay": 200
            }
        ]
    }
}

try/catch templates

Use Kaven.surroundWith.tryCatch to configure wrappers and follow-up commands for individual languages:

{
    "Kaven.surroundWith.tryCatch": [
        {
            "language": "typescript",
            "pre": ["try {"],
            "post": [
                "} catch (ex) {",
                "    console.error(ex);",
                "}"
            ],
            "commands": [
                {
                    "command": "editor.action.formatSelection",
                    "args": []
                }
            ]
        }
    ]
}

License

MIT