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

Updates to vscode workspace settings #2814

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"hashicorp.terraform",
"ms-azuretools.vscode-docker",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
"esbenp.prettier-vscode",
"redhat.vscode-yaml"
]
}
Comment on lines 4 to 10
Copy link
Member

Choose a reason for hiding this comment

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

A few other extensions that might be nice to include here:

  • bpruitt-goddard.mermaid-markdown-syntax-highlighting (link): Mermaid is recommended in our ADR docs, and is used in ADR 1, so syntax highlighting support seems useful.
  • bierner.markdown-mermaid (link): Similar to above, being able to preview mermaid diagrams feels all but necessary to effectively create a mermaid diagram.
  • github.vscode-github-actions (link): Super useful for editing our GitHub automations.
  • mikestead.dotenv (link): Helpful for folks who are less familiar with editing dotenv files.

2 changes: 1 addition & 1 deletion packages/client/.editorconfig
Copy link
Member

Choose a reason for hiding this comment

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

Should this file be moved to the root directory?

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[*.{js,jsx,ts,tsx,vue}]
[*.{js,jsx,ts,tsx,vue,json,yaml,yml,tf,tfvars}]
indent_style = space
indent_size = 2
end_of_line = lf
Expand Down
80 changes: 50 additions & 30 deletions usdr-gost.code-workspace
Copy link
Member

Choose a reason for hiding this comment

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

My two cents: we should...

  1. Ditch the workspace setup, or keep it in a pared-down version if folks actually do find it super useful (I don't, personally).
  2. Move the settings section of this file to .vscode/settings.json.

Original file line number Diff line number Diff line change
@@ -1,31 +1,51 @@
{
"folders": [
{
"name": "✨ usdr-gost",
"path": "."
},
{
"name": "📦 client",
"path": "packages/client"
},
{
"name": "📦 server",
"path": "packages/server"
}
],
"settings": {
"window.zoomLevel": 0,
"diffEditor.ignoreTrimWhitespace": false,
"editor.columnSelection": false,
"editor.find.cursorMoveOnType": true,
"javascript.format.enable": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
// We need to explicitly turn this off at the worksplace level to avoid
// competing user settings and workplace settings. We use VSCode's "codeActionsOnSave"
// to manage linting/fixing, but users can have other settings via "formatOnSave".
// If both are on, the editor can "fix" things that are immediately flagged as lint failures.
"editor.formatOnSave": false,
}
}
"folders": [
{
"name": "✨ usdr-gost",
"path": "."
},
{
"name": "📦 client",
"path": "packages/client"
},
{
"name": "📦 server",
"path": "packages/server"
}
],
"settings": {
"window.zoomLevel": 0,
"diffEditor.ignoreTrimWhitespace": false,
"editor.columnSelection": false,
"editor.find.cursorMoveOnType": true,
"javascript.format.enable": false,
"files.trimTrailingWhitespace": true,
"files.insertFinalNewline": true,
"files.eol": "\n",
"editor.detectIndentation": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.sortImports": "explicit",
"source.formatAll.terraform": "explicit",
},
// We need to explicitly turn this off at the worksplace level to avoid
// competing user settings and workplace settings. We use VSCode's "codeActionsOnSave"
// to manage linting/fixing, but users can have other settings via "formatOnSave".
// If both are on, the editor can "fix" things that are immediately flagged as lint failures.
"editor.formatOnSave": false,
"[yaml]": {
"editor.defaultFormatter": "redhat.vscode-yaml",
"editor.formatOnSave": true,
},
"[json][jsonc][jsonl]": {
"editor.defaultFormatter": "vscode.json-language-features",
"editor.formatOnSave": true,
},
"[terraform]": {
"editor.defaultFormatter": "hashicorp.terraform",
},
"[terraform-vars]": {
"editor.defaultFormatter": "hashicorp.terraform",
}
}
}
Loading