Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add VSCode command of generating verible.filelist at the root folder #2277

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions verilog/tools/ls/vscode/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ node_modules
package-lock.json
README.html
dist/
bin/
.vscode/
10 changes: 10 additions & 0 deletions verilog/tools/ls/vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Verible Language Server Extension

## Quick Start
The extension provides support for Verible Language Serve in Visual Studio Code.

Before enjoying the privilige of modern language server features, you need to take the following instructions.

1. Install the Verible Language Server. This is described in the `Prerequisite on your machine` section below.
2. Generate the `verible.filelist` at the root directory. You can execute the `Verible: Generate File List` command in VSCode to achive it.
3. If you add new source files into your project, you'll need to generate the `verible.filelist` again to include them.
> New to VSCode and have no idea how to execute a VSCode command? Try hitting `Ctrl+Shift+P` (for Windows) or `Command+Shift+P` (for MacOS) and type `Verible: Generate File List`, then press `Enter`.

## Features
The language server provides a couple of features from the [Verible SystemVerilog productivity suite](https://github.com/chipsalliance/verible) right in the editor.

Expand Down
20 changes: 17 additions & 3 deletions verilog/tools/ls/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@
]
}
],
"commands": [
{
"command": "verible.generateFileList",
"title": "Verible: Generate File List"
}
],
"configuration": {
"type": "object",
"title": "verible",
Expand All @@ -45,6 +51,14 @@
"type": "string"
},
"description": "Arguments for verible-verilog-ls server."
},
"verible.includedFileExts": {
"type": "array",
"default": [".v", ".sv", ".vh", ".svh"],
"items": {
"type": "string"
},
"description": "Included files when generating verible.filelist."
}
}
}
Expand Down Expand Up @@ -72,12 +86,12 @@
"vsix": "vsce package -o verible.vsix"
},
"devDependencies": {
"@types/decompress": "^4.2.4",
"@types/follow-redirects": "^1.14.1",
"@types/glob": "^7.1.4",
"@types/mocha": "^9.0.0",
"@types/node": "14.x",
"@types/vscode": "^1.61.0",
"@types/decompress": "^4.2.4",
"@types/follow-redirects": "^1.14.1",
"@typescript-eslint/eslint-plugin": "^4.31.1",
"@typescript-eslint/parser": "^4.31.1",
"@vscode/test-electron": "^1.6.2",
Expand All @@ -87,7 +101,7 @@
"ts-loader": "^9.2.5",
"typescript": "^4.4.3",
"vsce": "^1.100.1",
"webpack": "^5.52.1",
"webpack": "^5.95.0",
"webpack-cli": "^4.10.0"
},
"dependencies": {
Expand Down
113 changes: 113 additions & 0 deletions verilog/tools/ls/vscode/src/download-ls.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions verilog/tools/ls/vscode/src/download-ls.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

98 changes: 98 additions & 0 deletions verilog/tools/ls/vscode/src/extension.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions verilog/tools/ls/vscode/src/extension.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading