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

Troubleshooting guidelines #240

Open
sir-galahad opened this issue Jun 12, 2024 · 2 comments
Open

Troubleshooting guidelines #240

sir-galahad opened this issue Jun 12, 2024 · 2 comments
Labels
Enhancement support Request for direct support

Comments

@sir-galahad
Copy link

I would greatly appreciate it if the documentation came with some troubleshooting guidelines.

As it is I have installed the vim-editorconfig ubuntu package on ubuntu, I can see the editorconfig script being sourced if i run vim -V, but i can't get editorconfig to do anything as far as either applying settings from .editorconfig files or even producing any sort of debug information and it would be great to have a resource to go to to know what my next steps should be.

@mscheper
Copy link

mscheper commented Dec 1, 2024

@sir-galahad: Have you found any documentation at all? I want to know where to put the .editorconfig file. It seems intuitive to put it in my home directory, but I'm working on multiple projects that have slightly varying formatting standards, so I want another solution. Will it work if it's in the directory I start Vim from? Can I point to it with an environment variable? If I open a file with :edit and there's an .editorconfig in the same directory, will it load it? Or do I need to type a command in Vim to get it to load at all?

Update: Okay, so that's answered in the generic editorconfig docs here, but there should ought to be documentation specific to this plugin. e.g. It's still not clear what order the configuration happens in. If there are different settings in $VIM/after/ftplugin, will those win, or will they get overridden? And since Vim resolves symlinks, I guess that means the plugin traverses the file's absolute directory tree, and not the symlinked tree? Maybe I'm missing it, but have you found any plugin-specific documentation to answer questions like these?

@cxw42 cxw42 added Enhancement support Request for direct support labels Dec 12, 2024
@cxw42
Copy link
Member

cxw42 commented Dec 12, 2024

Those seem like reasonable requests to me :) .

For troubleshooting, the first thing to do is

:let g:EditorConfig_verbose=1

and then open your file. If the plugin prints a message, you'll at least know it did something :) .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement support Request for direct support
Projects
None yet
Development

No branches or pull requests

3 participants