vscode sample settings.json

[kaovilai]

Signed-off-by: Tiger Kaovilai tkaovila@redhat.com

Why the changes were made

How to test the changes made

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kaovilai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [kaovilai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mateusoliveira43]

this is IDE specific

I would not add this to the repo

whoever wants to work on this project does not need to use VSCode

[kaovilai]

what about

oadp-non-admin/.editorconfig

Lines 1 to 20 in 47e640d

	# https://EditorConfig.org
	root = true
	[*]
	indent_size = 4
	indent_style = space
	end_of_line = lf
	charset = utf-8
	trim_trailing_whitespace = true
	insert_final_newline = true
	[{*.go,go.mod,Makefile}]
	indent_style = unset
	[{*.{yaml,yml},PROJECT,OWNERS}]
	indent_size = 2
	[{*.md,LICENSE}]
	indent_size = unset

[kaovilai]

or readme? would that work better for you?

[kaovilai]

otherwise my IDE is throwing non matching linter errors due to newer golangci-lint picked up by IDE. I would still like to use IDE automatic linting integration with golangci-lint

[mateusoliveira43]

.editorconfig is not IDE specific, is the config file for ec executable

oadp-non-admin/Makefile

Lines 261 to 263 in 47e640d

	.PHONY: ec
	ec: editorconfig ## Run file formatter checks against all project's files.
	$(EC)

[kaovilai]

How about https://github.com/openshift/oadp-operator/blob/a6262b410c88be06226afebf1c1caf52bf0d20d2/docs/developer/testing/AttatchingIDEDebuggers.md?plain=1#L5 ?

[mpryc]

I don't think it's unreasonable to add .vscode/settings.json file to the project repository with some sensible defaults and at the same time ensure .gitignore contains this, so developers won't be adding their generated by the IDE changes. What I am wondering if it's possible to add it in a way it won't be pinning to a particular version (e.g. via the hack/) and use it in all the places, so we don't have to remember to bump the golangci binary every time. Here are few examples that already are within OpenShift org:

https://github.com/openshift/api/blob/635291d6fdf1c4f4cb2b94b460f8d4f9cc377571/.vscode/settings.json#L4

https://github.com/openshift/console/blob/e9d6ead6852600993cffef3d50cb9b122d64c068/frontend/.vscode/settings.json#L4

https://github.com/openshift/cluster-network-operator/blob/d09028dfda8c632e4c4730319b9f07f0ac92d82a/.vscode/settings.json#L3