Skip to content

Commit 2acebe0

Browse files
Use the name scip-typescript. (#2)
1 parent ef6e030 commit 2acebe0

13 files changed

+36
-36
lines changed

.github/workflows/lsif-typescript.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66

77
jobs:
88
upload-index:
9-
if: github.repository == 'sourcegraph/lsif-typescript'
9+
if: github.repository == 'sourcegraph/scip-typescript'
1010
runs-on: ubuntu-latest
1111
steps:
1212
- uses: actions/checkout@v3
@@ -16,7 +16,7 @@ jobs:
1616
run: |
1717
curl -L https://sourcegraph.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
1818
chmod +x /usr/local/bin/src
19-
- name: Run lsif-typescript
19+
- name: Run scip-typescript
2020
run: ./node_modules/.bin/ts-node src/main.ts index --no-progress-bar
2121
- name: Upload index
2222
run: src lsif upload -github-token='${{ secrets.GITHUB_TOKEN }}' -no-progress

.github/workflows/release.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ jobs:
3535
with:
3636
push: true
3737
tags: |
38-
sourcegraph/lsif-typescript:latest
39-
sourcegraph/lsif-typescript:${{ env.PATCH }}
40-
sourcegraph/lsif-typescript:${{ env.MINOR }}
41-
sourcegraph/lsif-typescript:${{ env.MAJOR }}
38+
sourcegraph/scip-typescript:latest
39+
sourcegraph/scip-typescript:${{ env.PATCH }}
40+
sourcegraph/scip-typescript:${{ env.MINOR }}
41+
sourcegraph/scip-typescript:${{ env.MAJOR }}
4242
- name: Build and push
4343
id: docker_build_autoindex
4444
uses: docker/build-push-action@v2
4545
with:
4646
file: Dockerfile.autoindex
4747
push: true
48-
tags: sourcegraph/lsif-typescript:autoindex
48+
tags: sourcegraph/scip-typescript:autoindex

Development.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Developing lsif-typescript
1+
# Developing scip-typescript
22

33
## References
44

@@ -24,7 +24,7 @@ Generate snapshots and update.
2424

2525
```sh
2626
cd /path/to/dir
27-
DIR=/path/to/lsif-typescript "$DIR/node_modules/.bin/ts-node" "$DIR/src/main.ts" index # add --yarn-workspaces if applicable
27+
DIR=/path/to/scip-typescript "$DIR/node_modules/.bin/ts-node" "$DIR/src/main.ts" index # add --yarn-workspaces if applicable
2828
lsif-typed dump.lsif-typed > dump.lsif # from github.com/sourcegraph/sourcegraph/lib/codeintel/tools/lsif-typed
2929
lsif-java snapshot-lsif # from github.com/sourcegraph/lsif-java
3030
```
@@ -45,5 +45,5 @@ lsif-java snapshot-lsif # from github.com/sourcegraph/lsif-java
4545
git push v<version>
4646
```
4747
A GitHub Action should be triggered by the push; it will publish:
48-
- A new version of lsif-typescript to npm.
49-
- A Docker image to Docker hub, using the new version of lsif-typescript.
48+
- A new version of scip-typescript to npm.
49+
- A Docker image to Docker hub, using the new version of scip-typescript.

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ RUN apk add --no-cache git
99

1010
COPY --from=src-cli /usr/bin/src /usr/bin
1111

12-
RUN npm install -g @sourcegraph/lsif-typescript@${TAG}
12+
RUN npm install -g @sourcegraph/scip-typescript@${TAG}
1313

1414
CMD ["/bin/sh"]

Dockerfile.autoindex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ COPY --from=src-cli /usr/bin/src /usr/bin
1111

1212
RUN curl -Lo /usr/bin/lsif-typed https://github.com/sourcegraph/lsif-typescript/releases/download/v0.1.13/lsif-typed && chmod +x /usr/bin/lsif-typed
1313

14-
RUN echo 'lsif-typescript "$@" --no-progress-bar && lsif-typed dump.lsif-typed > dump.lsif' > /usr/bin/lsif-typescript-autoindex && chmod +x /usr/bin/lsif-typescript-autoindex
14+
RUN echo 'scip-typescript "$@" --no-progress-bar && lsif-typed dump.lsif-typed > dump.lsif' > /usr/bin/scip-typescript-autoindex && chmod +x /usr/bin/scip-typescript-autoindex
1515

16-
RUN npm install --global n@latest @sourcegraph/lsif-typescript@latest
16+
RUN npm install --global n@latest @sourcegraph/scip-typescript@latest
1717

1818
CMD ["/bin/sh"]

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# lsif-typescript
1+
# scip-typescript
22

3-
LSIF indexer for TypeScript and JavaScript.
3+
SCIP indexer for TypeScript and JavaScript.
44

55
## Quick start
66

77
### Installation
88

99
```sh
10-
npm install -g @sourcegraph/lsif-typescript
10+
npm install -g @sourcegraph/scip-typescript
1111
```
1212

1313
Currently, Node v14, Node v16 and Node v18 are supported. <!-- Source of truth: .github/workflows/ci.yml -->
@@ -18,7 +18,7 @@ Navigate to the project root, containing `tsconfig.json`.
1818

1919
```sh
2020
npm install # or yarn install
21-
lsif-typescript index
21+
scip-typescript index
2222
```
2323

2424
### Indexing a JavaScript project
@@ -27,7 +27,7 @@ Navigate to the project root, containing `package.json`.
2727

2828
```sh
2929
npm install # or yarn install
30-
lsif-typescript index --infer-tsconfig
30+
scip-typescript index --infer-tsconfig
3131
```
3232

3333
To improve the quality of indexing results for JavaScript,
@@ -39,17 +39,17 @@ Navigate to the project root, containing `package.json`.
3939

4040
```sh
4141
npm install # or yarn install
42-
lsif-typescript index --yarn-workspaces
42+
scip-typescript index --yarn-workspaces
4343
```
4444

4545
### Indexing in CI
4646

4747
Add the following run steps to your CI pipeline:
4848

4949
```sh
50-
npm install -g @sourcegraph/lsif-typescript
50+
npm install -g @sourcegraph/scip-typescript
5151
npm install # or yarn install
52-
lsif-typescript index
52+
scip-typescript index
5353
# From https://github.com/sourcegraph/src-cli/
5454
curl -L https://sourcegraph.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
5555
chmod +x /usr/local/bin/src

dev/bump-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ fi
1515
echo "Updating package.json."
1616
yarn version --no-git-tag-version --new-version $1
1717
echo "Updating CHANGELOG.md."
18-
npx github-changes --only-pulls --branch main --owner sourcegraph --repository lsif-typescript --title "LSIF Typescript" --tag-name "v$1" --token "$GITHUB_TOKEN"
18+
npx github-changes --only-pulls --branch main --owner sourcegraph --repository scip-typescript --title "LSIF Typescript" --tag-name "v$1" --token "$GITHUB_TOKEN"
1919
yarn run prettier
2020
git add .
2121
TITLE="Update ChangeLog and bump version for releasing $1."

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@sourcegraph/lsif-typescript",
2+
"name": "@sourcegraph/scip-typescript",
33
"version": "0.1.17",
4-
"description": "LSIF indexer for TypeScript and JavaScript",
4+
"description": "SCIP indexer for TypeScript and JavaScript",
55
"publisher": "sourcegraph",
66
"bin": "dist/src/main.js",
77
"main": "./dist/src/main.js",
@@ -17,10 +17,10 @@
1717
},
1818
"repository": {
1919
"type": "git",
20-
"url": "git+https://github.com/sourcegraph/lsif-typescript.git"
20+
"url": "git+https://github.com/sourcegraph/scip-typescript.git"
2121
},
2222
"keywords": [
23-
"lsif",
23+
"scip",
2424
"typescript",
2525
"compiler",
2626
"javascript",
@@ -29,9 +29,9 @@
2929
"author": "Code Intelligence at Sourcegraph",
3030
"license": "Apache-2.0",
3131
"bugs": {
32-
"url": "https://github.com/sourcegraph/lsif-typescript/issues"
32+
"url": "https://github.com/sourcegraph/scip-typescript/issues"
3333
},
34-
"homepage": "https://github.com/sourcegraph/lsif-typescript#readme",
34+
"homepage": "https://github.com/sourcegraph/scip-typescript#readme",
3535
"dependencies": {
3636
"commander": "^9.2.0",
3737
"google-protobuf": "^3.20.0",

src/CommandLineOptions.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ function checkIndexParser(
1010
): void {
1111
test(args.join(' '), () => {
1212
let isAssertionTriggered = false
13-
const actualArguments = ['node', 'lsif-typescript.js', 'index', ...args]
13+
const actualArguments = ['node', 'scip-typescript.js', 'index', ...args]
1414
mainCommand((projects, options) => {
1515
assert.equal(options, { ...options, ...expectedOptions })
1616
if (expectedProjects) {

src/CommandLineOptions.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ export function mainCommand(
2626
): Command {
2727
const command = new Command()
2828
command
29-
.name('lsif-typescript')
29+
.name('scip-typescript')
3030
.version(packageJson.version)
3131
.description(
32-
'LSIF indexer for TypeScript and JavaScript\nFor usage examples, see https://github.com/sourcegraph/lsif-typescript/blob/main/README.md'
32+
'LSIF indexer for TypeScript and JavaScript\nFor usage examples, see https://github.com/sourcegraph/scip-typescript/blob/main/README.md'
3333
)
3434
command
3535
.command('index')

0 commit comments

Comments
 (0)