Shopify
Add code example of how one can enable ruby formatter in VS Code
Motivation
Since I was instructed to open a PR in this repo in https://github.com/Shopify/vscode-shopify-ruby/pull/595, doing so now. cc: @vinistock
https://github.com/Shopify/vscode-shopify-ruby/issues/443
It's easier to glance over the line that says to add rubocop or syntax_tree gem in Gemfile. Adding a concrete code example makes it find the solution.
I've seen few people ask about this in support issues in the repo as well.
Implementation
Just the readme update.
Automated Tests
NA
Manual Tests
NA
@bibstha since these instructions aren't specific to VS Code, we should add them to the main README instead. I'd suggest adding a new section, e.g. 'Formatting and Linting'. Once added, we can add a link to it from the VS Code README to help people find it.
Hi @bibstha, are you able to continue on this?
After discussing with @vinistock, we think it could be better to have an explicit statement like “Using globally installed formatters or linters is not supported, they must in your Gemfile or gemspec”. Then there is not any need for the sample code.