@sourcefield/lsif-typescript
v0.2.9
Published
LSIF indexer for TypeScript and JavaScript
Downloads
44
Maintainers
Readme
scip-typescript
SCIP indexer for TypeScript and JavaScript.
Quick start
Installation
npm install -g @sourcegraph/scip-typescript
Currently, Node v14, Node v16 and Node v18 are supported.
Indexing a TypeScript project
Navigate to the project root, containing tsconfig.json
.
npm install # or yarn install
scip-typescript index
Indexing a JavaScript project
Navigate to the project root, containing package.json
.
npm install # or yarn install
scip-typescript index --infer-tsconfig
To improve the quality of indexing results for JavaScript,
consider adding @types/*
packages as devDependencies
in package.json
.
Index a TypeScript project using Yarn workspaces
Navigate to the project root, containing package.json
.
yarn install
scip-typescript index --yarn-workspaces # For Yarn v2
scip-typescript index --yarn-berry-workspaces # For Yarn v3 (Berry)
Indexing in CI
Add the following run steps to your CI pipeline:
npm install -g @sourcegraph/scip-typescript @sourcegraph/src
npm install # or yarn install
scip-typescript index
# Upload index with any necessary tokens (shown here using GitHub workflow syntax)
src lsif upload -github-token='${{ secrets.GITHUB_TOKEN }}' -no-progress
For more examples, see the Sourcegraph docs.
Migrating from lsif-node
Before creating scip-typescript, we used another TypeScript indexer called lsif-node. We recommend migrating to scip-typescript if you are using lsif-node.
Follow the steps below to migrate from lsif-node to scip-typescript:
- Replace usages of the
lsif-tsc -p ARGUMENTS
command withscip-typescript index ARGUMENTS
. - Upgrade to the latest version of the
src
command-line interface, which you can install viayarn global add @sourcegraph/src
. It’s okay if the version of yoursrc
command-line interface does not match the version of your Sourcegraph instance.
Contributing
See Development.md for docs on how to work on this project.
Contributors should follow the Sourcegraph Community Code of Conduct.