sourcegraph / sourcegraph-code-discussions

Sourcegraph Code Discussions — discuss code contextually, review code continuously.

Sourcegraph code discussions

⚠️ Deprecation notice

Sourcegraph extensions have been deprecated with the September 2022 Sourcegraph release. Learn more.

The repo and the docs below are kept to support older Sourcegraph versions.

Description

Discuss code contextually, review code continuously.

• 🖥️ Write comments on code while browsing on Sourcegraph.com.
• 🧠 Discover discussions and existing knowledge on GitHub & Sourcegraph while browsing code.
• 🤔 Review code continuously, not just in Pull Requests.
• 🤲 Share knowledge & help unblock team members.

⚡ Experimental warning

Code discussions is an experiment by Sourcegraph. It is not yet ready for widespread production use.

If you're as excited about improving how code is discussed as much as we are, then please try it out, give us feedback and file issues, and reach out to us ([email protected]). We'd love to hear from you!

GitHub integration

This shows how you can view previously created discussions on GitHub.com while browsing code:

Note: Clicking them will bring you to Sourcegraph, it is not yet possible to create or reply to discussions on GitHub itself. We hope to support this soon.

Getting started

1. Set up a Sourcegraph server (soon you will be able to use this on open source repositories via Sourcegraph.com).
2. Visit the extensions page (link in the top right / navbar of Sourcegraph) and enable this extension.
3. Visit any file in any repository, select a line by clicking it and then create a discussion by clicking the chat icon that appears.

For the GitHub integration:

1. Install Sourcegraph for Chrome or Sourcegraph for Firefox
2. Open the Sourcegraph for Chrome/Firefox extension options page (by clicking the Sourcegraph icon in the browser toolbar)
3. Check the box labeled Use Sourcegraph extensions (required while this feature is in alpha)

Coming soon: Visual Studio Code integration

This shows how you can view, create, and reply to discussions right from your editor:

Note: This integration is not yet released. See sourcegraph/sourcegraph-vscode#15 for tracking this integration.

sourcegraph-code-discussions's Issues

Dependency Dashboard

This issue contains a list of Renovate updates and their statuses.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Pin dependency @types/date-fns to 2.6.0
• Update dependency @sourcegraph/tsconfig to ^4.0.1
• Update dependency date-fns to ^1.30.1
• Update dependency get-graphql-schema to ^2.1.2
• Update dependency gql2ts to ^1.10.1
• Update dependency typescript to ^3.9.7
• Update dependency @sourcegraph/tslint-config to v13
• Update dependency date-fns to v2
• Update dependency mkdirp to v1
• Update dependency sourcegraph to v24
• Update dependency tslint to v6
• Update dependency typescript to v4
• Update prettier (major) (@sourcegraph/prettierrc, prettier)
• Check this option to rebase all the above open PRs at once

---

• Check this box to trigger a request for Renovate to run again on this repository

Gutter icons would be more effective than inline discussions

Inline discussions are functionally just a link to the full discussion, but they need to be toggled on first and I don't find them to be visually appealing.

I think it would be better if "inline discussions" were removed and there was just a persistent gutter icon (ideally on by default) for existing discussions on the file. Would greatly help discoverability of existing discussions and would not disrupt the code reading experience.

Uncaught (in promise) AggregateError: repository not found

This error gets printed a lot by the code discussion extension, which obscures other errors

errors.ts:37 Uncaught (in promise) AggregateError: repository not found
    at Object.exports.createAggregateError (https://sourcegraph.com/-/static/extension/2451-sourcegraph-code-discussions.js?brwwtfuexma0--sourcegraph-code-discussions:327:601)
    at Object.<anonymous> (https://sourcegraph.com/-/static/extension/2451-sourcegraph-code-discussions.js?brwwtfuexma0--sourcegraph-code-discussions:329:4832)
    at https://sourcegraph.com/-/static/extension/2451-sourcegraph-code-discussions.js?brwwtfuexma0--sourcegraph-code-discussions:329:1272
    at Object.next (https://sourcegraph.com/-/static/extension/2451-sourcegraph-code-discussions.js?brwwtfuexma0--sourcegraph-code-discussions:329:1377)
    at o (https://sourcegraph.com/-/static/extension/2451-sourcegraph-code-discussions.js?brwwtfuexma0--sourcegraph-code-discussions:329:123)

Error creating thread: json: cannot unmarshal object into Go value of type bool

Here's how I encountered this:

• Visit https://sourcegraph.sgdev.org/github.com/sourcegraph/website/-/blob/STYLEGUIDE.md?view=code#L15%3A2=&tab=discussions&createThread=true

The discussions extension is not disabled in my user settings or client settings. Is anyone else able to repro? If not, what might be different between our accounts?

cc @slimsag

Rename to sourcegraph-discussions

Other extensions (sourcegraph-{codecov,basic-code-intel,hello-world,logdna,lightstep}) don’t have the “-extension” in their name. And VS Code/Atom/Sublime extensions are usually just $EDITOR-whatever.

Curious: what made you want to include “-extension”?

Markdown incorrectly displayed on Sourcegraph website

It looks like when README.md of this repository is displayed on it's corresponding sourcegraph.com page, the Markdown displays incorrectly. The <em>, </sub> and <br/> tags are displayed in plain text instead of parsed by markdown.

Seen in:
Browser: Chrome 70
OS: MacOS High Sierra

Hyperlink of discussion navigates to localhost

Issue

After created an inline code discussion, the link from copy link or under discussion tab navigates back to http://127.0.0.1:7080/<repo>/-/blob/behat.yml#tab=discussions&threadID=<threadID>&commentID=<commentID> (localhost) and requires login. As a result, the user cannot reach the discussion via the hyperlink.

• Version: sourcegraph 2.12.0 (Docker)
• Environment: AWS ECS task

"Inline discussions" toggle doesn't indicate current state

It is also unclear what it does. A more descriptive tooltip would help. Toggling it doesn't help find out what it does unless there is already a discussion visible in the current viewport.

Inline discussions overlaps blame

1. Go to https://sourcegraph.com/github.com/sourcegraph/about/-/blob/projects/code-discussions-future.md?view=code#L18 (i.e. select a line that will have an inline discussion)
2. Toggle inline discussions on (if not already on).

You will see them overlap

Link to create a github issue from discussion

Occasionally someone will start a code discussion that should be an issue because there is an action item (Example).

It would be great if you could very easily turn the discussion into an issue without going back and forth copy/pasting. Fortunately GitHub allows pre-filling the form from query parameters:

https://github.com/{owner}/{repo}/issues/new?title=foo&body=bar will open up the new issue form with "foo" as the title and "bar" as the body.

Use new pressed property

The discussions button in the toolbar is a toggle, so it should use the pressed property so it is styled properly when activated/deactivated.

Example:

https://github.com/sourcegraph/sourcegraph-typescript/blob/2a8d094a2cb01263df69b216d288685c15a1d378/package.json#L39

repo not found: name="ourcegraph/..."

Repro:

1. Go to https://sourcegraph.sgdev.org/github.com/sourcegraph/javascript-typescript-buildserver/-/blob/.gitignore
2. Browse around to a few files

Eventually, I see this error in the JS console:

It doesn't seem to be breaking anything, but it definitely looks like a bug (given that the first s of the repo name is chopped off.