Skip to content

remove .vscode directory #872

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 3 commits into from
Aug 21, 2019
Merged

Conversation

Batalex
Copy link
Contributor

@Batalex Batalex commented Aug 16, 2019

Contributor Checklist

We could also use this PR to discuss the addition of a .editorconfig file. The homepage shows a nice example of an editor configuration file for both Python & JS.

@byronz
Copy link
Contributor

byronz commented Aug 20, 2019

I'm fine to remove the vscode settings, and like the idea of a generic editorconfig across different IDEs. a customized version would look like this

# EditorConfig is awesome: https://EditorConfig.org

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf

# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8

# 4 space indentation
[*.py]
indent_style = space
indent_size = 4
insert_final_newline = true

# Tab indentation (no size specified)
[Makefile]
indent_style = tab

# Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.circleci/config.yml}]
indent_style = space
indent_size = 2

@alexcjohnson @Marc-Andre-Rivet

@alexcjohnson
Copy link
Collaborator

Sounds good to me, and this config looks like a good starting point except that our js source uses 4-space indentation just like the py source.

@Batalex
Copy link
Contributor Author

Batalex commented Aug 20, 2019

A shorter version would be

# EditorConfig is awesome: https://EditorConfig.org

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8
indent_style = space
indent_size = 4

# Matches the exact files either package.json or .travis.yml
[{package.json,.circleci/config.yml}]
indent_style = space
indent_size = 2

Is this ok?
The editors support is listed here. Pycharm users would instantly benefit from it whereas Sublime/Atom/VSCode would need to install a dedicated plugin.

@byronz
Copy link
Contributor

byronz commented Aug 20, 2019

@alexcjohnson is this valid for js file ?
insert_final_newline = true

@alexcjohnson
Copy link
Collaborator

Currently I have my editor set to include a trailing newline on all files, regardless of type. So yes, definitely valid for js

Copy link
Contributor

@byronz byronz left a comment

Choose a reason for hiding this comment

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

💃 thanks for @Batalex

@byronz byronz merged commit f0b6be9 into plotly:dev Aug 21, 2019
@Batalex Batalex deleted the support/remove-vsc-config branch August 21, 2019 14:32
HammadTheOne pushed a commit to HammadTheOne/dash that referenced this pull request May 28, 2021
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.

Remove editor configuration from repo
3 participants