Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove remnants from "LSIF Typed" #191

Merged
merged 2 commits into from
Oct 25, 2022
Merged

Remove remnants from "LSIF Typed" #191

merged 2 commits into from
Oct 25, 2022

Conversation

olafurpg
Copy link
Member

The codebase had a lot of outdated references to "LSIF Typed", which has been renamed to SCIP. This commit replaces these outdated references to avoid confusion for people who are reading the codebase for the first time.

Test plan

See the CI go green. This should be a pure refactoring, no functional difference.

The codebase had a lot of outdated references to "LSIF Typed", which has
been renamed to SCIP. This commit replaces these outdated references to
avoid confusion for people who are reading the codebase for the first
time.
@olafurpg
Copy link
Member Author

cc/ @mrnugget @valerybugakov who both asked about the usage of LSIF in scip-typescript

Comment on lines +3 to +6
type Descriptor = scip.scip.Descriptor
const Descriptor = scip.scip.Descriptor
type Suffix = scip.scip.Descriptor.Suffix
const Suffix = scip.scip.Descriptor.Suffix
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Can we somehow avoid this being scip.scip. It's not a big deal, but it looks a little gross lol.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's not nice and I'd +1 if we can solve it somehow. It's not a regression from this PR though, it was gross before as well

Copy link
Member Author

@olafurpg olafurpg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still copy-paste scip.ts from the sourcegraph/scip repo. It would be nice to publish the bindings to npm so that we can add a normal package.json dependency instead. We can do that later, however, this PR is already a big improvement.

@olafurpg
Copy link
Member Author

Any idea why the CI is not triggering?

import { Packages } from './Packages'
import { Range } from './Range'
import * as scip from './scip'
import { ScipSymbol } from './ScipSymbol'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Following JS/TS conventions, I think this should be called SCIPSymbol, similar to HTML and URL in browser APIs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recall seeing in relation to XMLHttpRequest that the convention is that only three-letter acronym should remain uppercase. I really dislike SCIPSymbol, it's easier IMO to read ScipSymbol so I prefer to keep it

@varungandhi-src
Copy link
Contributor

Nothing seems to have changed in the CI config, so I'm as confused as you are. Some transient GitHub issue? Maybe try pushing a dummy commit?

@olafurpg
Copy link
Member Author

Empty commit seems to have done the trick

@olafurpg olafurpg merged commit b3143f1 into main Oct 25, 2022
@olafurpg olafurpg deleted the olafurpg/goodbye-lsif branch October 25, 2022 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants