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

Suggest adding a .vscode/settings.json #325

Open
kim-em opened this issue Sep 17, 2023 · 2 comments
Open

Suggest adding a .vscode/settings.json #325

kim-em opened this issue Sep 17, 2023 · 2 comments
Labels
low priority RFC Request for comments

Comments

@kim-em
Copy link
Contributor

kim-em commented Sep 17, 2023

Many Lean projects have a .vscode/settings.json:

{
  "editor.insertSpaces": true,
  "editor.tabSize": 2,
  "editor.rulers" : [100],
  "files.encoding": "utf8",
  "files.eol": "\n",
  "files.insertFinalNewline": true,
  "files.trimFinalNewlines": true,
  "files.trimTrailingWhitespace": true,
}

These do some basic file normalization that makes life easier in git, and encourages basic stylistic compatibility with other Lean projects.

Could the VSCode extension notice that a project doesn't have this file, and suggest adding this one?

@kim-em kim-em added the RFC Request for comments label Sep 17, 2023
@mhuisi
Copy link
Collaborator

mhuisi commented Sep 18, 2023

It could. I'm not sure whether a suggestion is the best way to go about this though - I usually find these very annoying in other extensions.

For a first step, we could generate it when creating a new project using the corresponding VSCode command that will be added for #61 and give users access to generate a sensible default config using a separate VSCode command.

@kim-em
Copy link
Contributor Author

kim-em commented Sep 20, 2023

Agree the suggestion could be annoying. But without a suggestion it probably won't get that much uptake. Low priority then, unless we find this is a persistent problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
low priority RFC Request for comments
Projects
None yet
Development

No branches or pull requests

2 participants