Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Require config by default #896
Consider the following sequence of events:
I love Prettier. As someone who introduces developers to Prettier all the time, it's frustrating when they run into (4). Because of this, every time I recommend developers install this extension, I have to immediately recommend that they go into settings and turn on the "Require prettierconfig" setting.
This means that I can't just drop this extension into a list of extensions that I recommend people install, because it by default will modify code that the user may not have written.
I think that this setting should just be on by default -- it will make me feel more comfortable introducing Prettier to more people, since it reduces the damage that I'm liable for.
Also, just to be clear, here are the steps to reproduce this behavior:
To answer some questions that might come up -- Prettier is a tool I would like to recommend to beginning developers. These developers might not have the perfect Git setup yet, and they might be learning about 10 other plugins at the same time, so it's also understandable that they might forget which plugin is suddenly causing their code to change.
If this plugin doesn't want to cater to these users, that's fine -- my hope is that with this setting turned on by default, we can cater to these users with no negative impact on anyone else. If Prettier is a formatter that "just works", hopefully this extension can also be one where no settings need to be adjusted after installation.
IMO, the benefits of this are outweighed by the negatives. By requiring prettier to be configured by default the flow a new user is completely interrupted. They would install the new extension and then nothing happens.
Are there other extensions that are disabled by default? I don't recall seeing this pattern.
Thanks for your quick reply!
Those are good points. I'd like a flow that I can recommend to people who want to get set up with a particular project, without having it interrupt their flow in other projects.
I'll throw some ideas out there:
Let me know how these ideas sound! Once I have some sense of the general approach we should use, I'm happy to put in more work to make this happen.