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

✨Coding Standards - Add settings.json and extensions.json to .vscode #716

Closed
6 tasks done
JackDevAU opened this issue Oct 27, 2021 · 1 comment · Fixed by #722
Closed
6 tasks done

✨Coding Standards - Add settings.json and extensions.json to .vscode #716

JackDevAU opened this issue Oct 27, 2021 · 1 comment · Fixed by #722

Comments

@JackDevAU
Copy link
Member

JackDevAU commented Oct 27, 2021

cc @adamcogan , @bradystroud and @pierssinclairssw
To Myself,

As per my conversation with @adamcogan , @bradystroud and @pierssinclairssw,

Pull Requests to SSW.Rules often fail due to linter errors. To mitigate this in the future I suggest adding the following files into the .vscode folder:

  • Settings.json – overrides settings for the current workspace (In this case it would set Prettier as the format on save option)
  • Extensions.json – Recommended plugins to download when working with the current workspace. (see below for the list of plugins that we will add initially)
  • .editorconfig (in the root directory) - Recommended to help maintain consistent coding styles across various editors and IDEs EditorConfig
  • Update Readme.md file
    • In the ”developer” section add a step to install the recommended plugins
    • In the “Definition of Done” section add a dotpoint to ensure people are using the recommended plugins

image
Figure: Adding the extensions.json file prompts the user to add the recommended VS Code plugins (whenever someone opens up the project in VS Code)

Formatting plugins

The below plugins will enforce the ESLint rules by overwriting certain VS Code settings ensuring “FormatOnSave” is turned on and the correct formatter is selected.

  • dbaeumer.vscode-eslint - ESLint (ESLint - Visual Studio Marketplace)
  • EditorConfig.EditorConfig - EditorConfig for VS Code (EditorConfig for VS Code - Visual Studio Marketplace)
  • esbenp.prettier-vscode - Prettier (Prettier - Code formatter - Visual Studio Marketplace)

GitLens plugin

The below plugin will ensure everyone is benefitting from using source control as per rule: Do you know the benefits of using source control?

  • eamodio.gitlens - GitLens (GitLens — Git supercharged - Visual Studio Marketplace)

Gitmoji plugin

The below plugin will ensure everyone is using the same emojis when committing and will keep commit messages short and to the point with a warning being displayed when over 50 characters.

  • vtrois.gitmoji-vscode – Gitmoji (Gitmoji - Visual Studio Marketplace)

AB#64835

@JackDevAU
Copy link
Member Author

Separated writing the rules into a a new PBI #2097

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant