compiler-explorer.nvim - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #llm #golang #deep-learning #linux #nodejs #macos #kubernetes #awesome-list #security #open-source

compiler-explorer.nvim

(★ 195)

Run compilers and inspect assembly directly from Neovim with the help of https://godbolt.org

파일 탐색기

최종 버전 다운로드 (.zip)

- compiler-explorer.txt
- - alert.lua
  - async.lua
  - autocmd.lua
  - cache.lua
  - clientstate.lua
  - config.lua
  - health.lua
  - http.lua
  - init.lua
  - job.lua
  - lazy.lua
  - rest.lua
  - stderr.lua
  - util.lua
- compiler-explorer.lua
.gitignore
.luacheckrc
LICENSE
Makefile
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/krady21/compiler-explorer.nvim

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd compiler-explorer.nvim

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Make

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# compiler-explorer.nvim
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Compile your code and explore assembly from Neovim using the
[compiler-explorer](https://godbolt.org/) REST API. Supercharged by `vim.ui`,
`vim.notify` and `vim.diagnostic`.

[Features](#features) • [Dependencies](#dependencies) • [Install](#installation) • [Commands](#commands) • [Configuration](#configuration)

## Demo
![Preview](https://i.imgur.com/Dy7TnUd.gif)
This is what the interface looks like using the `vim.ui` provided
by [dressing.nvim](https://github.com/stevearc/dressing.nvim) with the
[fzf-lua](https://github.com/ibhagwan/fzf-lua) backend and the `vim.notify`
provided by [nvim-notify](https://github.com/rcarriga/nvim-notify).

## Features
- Compile code asynchronously using `vim.loop`.
- Select compiler interactively using `vim.ui.select` or pass it as a vim
  command parameter.
- Compile visual selections.
- Send compiler warnings and errors to the quickfix list.
- Highlight matching lines between source code and assembly.
- Show binary output (opcodes and address) using virtual text.
- Format code.
- Add libraries.
- Show tooltips about specific instructions.
- Jump to label definitions.
- Load example code.
- Open the website with the local state (source code and compilers).

## Dependencies
You can verify these dependencies by running `:checkhealth compiler-explorer`

- [Neovim](https://neovim.io/) >= 0.10
- [curl](https://curl.se/)

<details>
<summary>Recommended</summary>
<br>
<a href="https://github.com/stevearc/dressing.nvim">dressing.nvim</a> or another plugin that overrides <code>vim.ui</code>
</details>

<details>
<summary>Optional</summary>
<br>
<a href="https://github.com/rcarriga/nvim-notify">nvim-notify</a> or another plugin that overrides <code>vim.notify</code>
</details>

## Installation

[packer](https://github.com/wbthomason/packer.nvim)
```lua
require('packer').startup(function()
  use {'krady21/compiler-explorer.nvim'}
end
```

[paq](https://github.com/savq/paq-nvim)
```lua
require("paq") {
  {'krady21/compiler-explorer.nvim'};
}
```

[vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'krady21/compiler-explorer.nvim'
```

## Commands
The suggested way to use
[compiler-explorer.nvim](https://github.com/krady21/compiler-explorer.nvim) is
through the vim commands provided. You can refer to `:h
compiler-explorer-commands` or the table below:

| Command | Description | Called from |
| --- | --- | --- |
| `:CECompile` | Compile the source code in the current buffer and dump assembly output to a new window. Also accepts a visual selection. | source code buffer |
| `:CECompileLive` | Same as `:CECompile`, but it will also try to recompile the source code every time the buffer is saved. | source code buffer |
| `:CEFormat` | Format the source code. | source code buffer |
| `:CEAddLibrary` | Add a library to be used by future calls of `:CECompile`. | source code buffer |
| `:CELoadExample` | Load an existing code example to a new tab. | any buffer |
| `:CEOpenWebsite` | Open the website using the source code and compilers from previous `:CECompile` calls. | any buffer |
| `:CEDeleteCache` | Clear the json cache where the compilers and languages are stored. | any buffer |
| `:CEShowTooltip` | Show information about a specific instruction under cursor. | assembly buffer |
| `:CEGotoLabel` | Jump to the label definition under cursor. | assembly buffer |

<details>
<summary>Examples</summary>

- `:CECompile` will prompt the user to select the compiler and flags
  interactively using `vim.ui.select` and `vim.ui.input`.
- `:CECompile compiler=g121 flags=-O2\ -Wall` specify the
  compiler and flags as command arguments.
- `':<,'>CECompile` will compile a visual selection.
- `:CECompile!` will open the assembly output in a new window. Not adding
  bang (!) will reuse the last assembly window.
- `:CECompile inferLang=false` do not infer possible language (based on file
  extension). Will prompt user to select the language before selecting the
  compiler.
- `:CECompile binary=true` show binary opcodes and address using virtual text.
- `:CECompile intel=false` use AT&T syntax instead of intel.
- `:CECompileLive` creates an autcommand that runs `:CECompile` every time
  the buffer is saved (`BufWritePost`).

</details>

## Configuration
[compiler-explorer.nvim](https://github.com/krady21/compiler-explorer.nvim)
works out of the box without configuration. If you want to change some of its
options (like using a local instance of compiler-explorer), you can do so
through the `setup()` function.

<details>
<summary>Default options</summary>

```lua
require("compiler-explorer").setup({
  url = "https://godbolt.org",
  infer_lang = true, -- Try to infer possible language based on file extension.
  line_match = {
    highlight = false, -- highlight the matching line(s) in the other buffer.
    jump = false, -- move the cursor in the other buffer to the first matching line.
  },
  open_qflist = false, --  Open qflist after compilation if there are diagnostics.
  split = "split", -- How to split the window after the second compile (split/vsplit).
  compiler_flags = "", -- Default flags passed to the compiler.
  job_timeout_ms = 25000, -- Timeout for libuv job in milliseconds.
  languages = { -- Language specific default compiler/flags
    --c = {
    --  compiler = "g121",
    --  compiler_flags = "-O2 -Wall",
    --},
  },
})
```
</details>

## API Coverage:
- [x] `GET  /api/languages`
- [x] `GET  /api/compilers/<lang-id>`
- [x] `GET  /api/libraries/<lang-id>`
- [ ] `GET  /api/shortlinkinfo/<link-id>`
- [x] `POST /api/compiler/<compiler-id>/compile`
- [x] `GET  /api/formats`
- [x] `POST /api/format/<formatter>`
- [x] `GET  /api/asm/<instruction-set>/<instruction>`
- [x] `GET  /source/builtin/list`
- [x] `GET  /source/builtin/load/<lang-id>/<example-id>`
- [x] `GET  /clientstate/<base64>`

You can find the full API docs [here](https://github.com/compiler-explorer/compiler-explorer/blob/main/docs/API.md).

## Related projects
- [godbolt.nvim](https://github.com/p00f/godbolt.nvim)

## Inspiration
- The async.lua and alert.lua modules are inspired from [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) .