Skip to content

Commit

Permalink
dotnet doc update (#397)
Browse files Browse the repository at this point in the history
Summary: Pull Request resolved: #397

Reviewed By: simonmar

Differential Revision: D51518900

Pulled By: donsbot

fbshipit-source-id: 10f2f34095c47d8e757c7dc2fe09e97a2bba8330
  • Loading branch information
TiwariAbhishek23 authored and facebook-github-bot committed Nov 22, 2023
1 parent ade39b4 commit 1c7abf4
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ We also support the [SCIP](https://github.com/sourcegraph/scip) or [LSIF](https:
* [TypeScript](https://glean.software/docs/indexer/lsif-typescript)
* [Java](https://glean.software/docs/indexer/lsif-java)
* [Python](https://glean.software/docs/indexer/scip-python)
* [Dotnet](https://glean.software/docs/indexer/scip-dotnet)

Custom indexers for these languages exist but aren't in the open source release
yet; we hope to make these available in the future:
Expand Down
45 changes: 45 additions & 0 deletions glean/website/docs/indexer/dotnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
id: scip-dotnet
title: Dotnet
sidebar_label: Dotnet
---

import {OssOnly, FbInternalOnly} from 'internaldocs-fb-helpers';
import {SrcFile,SrcFileLink} from '@site/utils';

To index [Dotnet](https://dotnet.microsoft.com/) we use SourceGraph's [SCIP indexer for dotnet](https://github.com/sourcegraph/scip-dotnet). [SCIP](https://about.sourcegraph.com/blog/announcing-scip) is a new format for tools to share information about code. Releases of [scip-dotnet](https://github.com/sourcegraph/scip-dotnet) can be installed with `dotnet tools` and used as indexers for SCIP, which Glean will accept. The indexer itself requires a [dotnet](https://dotnet.microsoft.com/) runtime environment.

## Run the indexer

The indexer is run via the main `glean` CLI tool.

```
> cabal build exe:glean
```

And index your Dotnet repository with:
```
glean index dotnet-scip DIR --db NAME/INSTANCE
```

where

* `DIR` is the root directory containing the Dotnet project
* `name/hash` is the name of the repository to create

Provide the usual `--db-root` and `--schema` or `--service` arguments
to `glean`

## In the shell

Dotnet source can also be indexed directly from the Glean shell:

```
:index dotnet-scip DIR
```

The shell will pick a DB name and hash for you based on `DIR`.

## Schema

The schema is in <SrcFile file="glean/schema/source/scip.angle" />
1 change: 1 addition & 0 deletions glean/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ module.exports = {
'indexer/lsif-rust',
'indexer/lsif-java',
'indexer/scip-python',
'indexer/scip-dotnet',

],
},
Expand Down

0 comments on commit 1c7abf4

Please sign in to comment.