https://github.com/zchrissirhcz/vscode-cmake-highlight

Syntax highlighting for CMake in Visual Studio Code
https://github.com/zchrissirhcz/vscode-cmake-highlight

cmake syntax-highlighting vscode vscode-extension

Last synced: about 1 month ago
JSON representation

Syntax highlighting for CMake in Visual Studio Code

• Host: GitHub
• URL: https://github.com/zchrissirhcz/vscode-cmake-highlight
• Owner: zchrissirhcz
• License: mit
• Created: 2022-08-16T02:02:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-24T05:57:25.000Z (over 1 year ago)
• Last Synced: 2025-04-11T21:13:50.818Z (about 1 month ago)
• Topics: cmake, syntax-highlighting, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 7.96 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VSCode CMake Highlight

This extension provides [CMake](http://www.cmake.org/) syntax highlighting for [Visual Studio Code](https://code.visualstudio.com/).

## Install

Search and install **`cmake-highlight`** in VSCode extension marketplace:

![search-and-install](images/search-and-install.png)

![screencast](images/cmake1.gif)

## Features

- Colorization

- Completion Lists

![completion](images/cmake2.gif)

- Code comments

![comment](images/cmake3.gif)

- Snippets

![find_package](images/cmake5.gif)

![include](images/cmake6.gif)

- Quick Help

![tooltip](images/cmake4.gif)

- Access To Online Help

## Options

The following Visual Studio Code settings are available for the Cmake extension. These can be set in user preferences (cmd+,) or workspace settings (.vscode/settings.json).

```json

{

    "cmake.cmakePath": "/path/to/cmake"

}

```

## Commands

- `CMake: Online Help` to go to the CMake online documentation (according to the current cmake version).

## Local build

Install nodejs LTS from  (instead of `apt` due to version too old):

```bash

node --version # v20.8.1

npm --vresion # 10.1.0

```

```bash

git clone https://github.com/zchrissirhcz/vscode-cmake-highlight.git

cd vscode-cmake-highlight

npm install -g @vscode/vsce

npm install typescript -g

npm install

...

vsce package # generate the .vsix file

# if your ~/.npmrc contains `prefix=~/.npm-global`, then use the following command

# ~/.npm-global/bin/vsce package

```

Change `index.d.ts` (`node_modules/@types/node/index.d.ts:20:1`)

```js

```

to

```js

```

## Acknowledgements

This extension is based on [CMake For VisualStudio Code](https://github.com/twxs/vs.language.cmake).

## License

[MIT](LICENSE)