Package Exports

@sourcegraph/scip-typescript
@sourcegraph/scip-typescript/dist/src/main.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sourcegraph/scip-typescript) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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.

npm install # or yarn install
scip-typescript index --yarn-workspaces

Indexing in CI

Add the following run steps to your CI pipeline:

npm install -g @sourcegraph/scip-typescript
npm install # or yarn install
scip-typescript index
# From https://github.com/sourcegraph/src-cli/
curl -L https://sourcegraph.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src
# 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.

Contributing

See Development.md for docs on how to work on this project.

Contributors should follow the Sourcegraph Community Code of Conduct.