Skip to content

Recommend the CodeQL for VSCode extension #3354

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

Merged
merged 2 commits into from
Apr 27, 2020
Merged

Recommend the CodeQL for VSCode extension #3354

merged 2 commits into from
Apr 27, 2020

Conversation

dbartol
Copy link

@dbartol dbartol commented Apr 24, 2020

I've added a .vscode/extensions.json file that will automatically recommend the CodeQL for Visual Studio Code extension to anyone who opens the repo in VS Code (without the extension already installed).

I've added a `.vscode/extensions.json` file that will automatically recommend the CodeQL for Visual Studio Code extension to anyone who opens the repo in VS Code (without the extension already installed).
jcreedcmu
jcreedcmu previously approved these changes Apr 24, 2020
Copy link
Contributor

@jcreedcmu jcreedcmu left a comment

Choose a reason for hiding this comment

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

Assuming you've tested that it's acceptable to put json-with-javascript-esque comments here, this lgtm, but I'd feel a little safer with actual valid json, and documentation about what it's for being put in the commit message, which someone could still find in git history.

@dbartol
Copy link
Author

dbartol commented Apr 24, 2020

Those comments are what VS Code itself generates when you run the Configure Recommended Extensions command, and it puts similar comments in settings.json, launch.json, etc. I've just added a .gitattributes in that directory to tell GitHub to allow the comments. Note that I've only added the .gitattributes for the .vscode directory, so it won't affect JSON used in, say, the javascript tests.

@dbartol
Copy link
Author

dbartol commented Apr 24, 2020

(We already do the same thing at the root of vscode-codeql repo, because Rush likes to go overboard commenting its JSON configuration as well).

@jcreedcmu
Copy link
Contributor

Yeah, that's convincing. I've generally noticed vscode to be pretty tolerant of comments in json, I just wanted to be adequately paranoid.

@jcreedcmu jcreedcmu merged commit 12f264c into github:master Apr 27, 2020
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