Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
f722d6a6
Commit
f722d6a6
authored
Feb 27, 2020
by
Igor Drozdov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add docs for code intelligence
Document code navigation features
parent
9affece7
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
53 additions
and
0 deletions
+53
-0
doc/user/project/code_intelligence.md
doc/user/project/code_intelligence.md
+52
-0
doc/user/project/img/code_intelligence_v13_1.png
doc/user/project/img/code_intelligence_v13_1.png
+0
-0
doc/user/project/index.md
doc/user/project/index.md
+1
-0
No files found.
doc/user/project/code_intelligence.md
0 → 100644
View file @
f722d6a6
---
type
:
reference
---
# Code Intelligence
> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/1576) in GitLab 13.1.
Code Intelligence adds code navigation features common to interactive
development environments (IDE), including:
-
Type signatures and symbol documentation.
-
Go-to definition
Code Intelligence is built into GitLab and powered by
[
LSIF
](
https://lsif.dev/
)
(Language Server Index Format), a file format for precomputed code
intelligence data.
## Configuration
Enable code intelligence for a project by adding a GitLab CI/CD job to the project's
`.gitlab-ci.yml`
which will generate the LSIF artifact:
```
yaml
code_navigation
:
script
:
-
go get github.com/sourcegraph/lsif-go/cmd/lsif-go
-
lsif-go
artifacts
:
reports
:
lsif
:
dump.lsif
```
The generated LSIF file must be less than 170MiB.
After the job succeeds, code intelligence data can be viewed while browsing the code:
![
Code intelligence
](
img/code_intelligence_v13_1.png
)
## Language support
Generating an LSIF file requires a language server indexer implementation for the
relevant language.
| Language | Implementation |
|---|---|
| Go |
[
sourcegraph/lsif-go
](
https://github.com/sourcegraph/lsif-go
)
|
| JavaScript |
[
sourcegraph/lsif-node
](
https://github.com/sourcegraph/lsif-node
)
|
| TypeScript |
[
sourcegraph/lsif-node
](
https://github.com/sourcegraph/lsif-node
)
|
View a complete list of
[
available LSIF indexers
](
https://lsif.dev/#implementations-server
)
on their website and
refer to their documentation to see how to generate an LSIF file for your specific language.
doc/user/project/img/code_intelligence_v13_1.png
0 → 100644
View file @
f722d6a6
81.7 KB
doc/user/project/index.md
View file @
f722d6a6
...
...
@@ -104,6 +104,7 @@ When you create a project in GitLab, you'll have access to a large number of
-
[
Dependency List
](
../application_security/dependency_list/index.md
)
: view project dependencies.
**(ULTIMATE)**
-
[
Requirements
](
requirements/index.md
)
: Requirements allow you to create criteria to check your products against.
**(ULTIMATE)**
-
[
Static Site Editor
](
static_site_editor/index.md
)
: quickly edit content on static websites without prior knowledge of the codebase or Git commands.
-
[
Code Intelligence
](
code_intelligence.md
)
: code navigation features.
### Project integrations
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment