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

chore(vscode): associate .gno files with Go syntax #832

Closed
wants to merge 2 commits into from
Closed

chore(vscode): associate .gno files with Go syntax #832

wants to merge 2 commits into from

Conversation

qdm12
Copy link
Contributor

@qdm12 qdm12 commented May 19, 2023

Description

  1. Associate *.gno files with Go for syntax highlighting purposes in VSCode, through a repository-committed .vscode/settings.json.
  2. Git ignore all files in the .vscode directory EXCEPT .vscode/settings.json

Contributors Checklist

  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests

Maintainers Checklist

  • Checked that the author followed the guidelines in CONTRIBUTING.md
  • Checked the conventional-commit (especially PR title and verb, presence of BREAKING CHANGE: in the body)
  • Ensured that this PR is not a significant change or confirmed that the review/consideration process was appropriate for the change

@qdm12 qdm12 requested a review from a team as a code owner May 19, 2023 08:55
@thehowl
Copy link
Member

thehowl commented May 19, 2023

I'm personally against having IDEs/text editor configurations inside code repos as I think they pollute the repository and create precedent for adding more in the future, but that's just my 2c.

Are you already using the Gno vs code extension? :)

@qdm12
Copy link
Contributor Author

qdm12 commented May 19, 2023

I'm personally against having IDEs/text editor configurations inside code repos as I think they pollute the repository and create precedent for adding more in the future, but that's just my 2c.

Agreed, although it's nice to have a base specific to the repo I think 🤔 You can limit additions with PR review. Or we can close this, I just thought about sharing this.

Are you already using the Gno vs code extension

No, shame on me, I'll try it! Maybe worth adding to that settings.json file instead of the syntax highlighting then?

@moul
Copy link
Member

moul commented May 19, 2023

Let's prioritize updating CONTRIBUTING.md with instructions or creating configuration defaults in the tools/ folder. It's important to maintain a clean and focused repository root with only essential content.

@qdm12
Copy link
Contributor Author

qdm12 commented Jun 14, 2023

I changed .vscode/settings.json -> .vscode/extensions.json with:

{
  "recommendations": [
    "harry-hov.gno"
  ]
}

I would say this is nice since it doesn't conflict really with user specific vscode configuration like .vscode/settings.json does.

Back to that tools/ folder, I don't think it exists, what did you have in mind for this? 🤔

@thehowl
Copy link
Member

thehowl commented Jul 20, 2023

@moul What do we want to do about this?

No config files and we just have suggestions for editors in CONTRIBUTING? => close this PR?

@thehowl
Copy link
Member

thehowl commented Aug 24, 2023

Thank you again for your contribution. After discussing this internally, we've decided not to include editor/ide-specific linters within our project. Relating to what @moul said, we already have the vs code extension as a suggestion in the CONTRIBUTING.md file, so I'll be closing this.

Possibly related discussion: #453 -- one thing that would be interesting to have is non-editor specific tools, eg. editorconfig. Thank you again for your time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants