Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 5.83 KB

vscode.md

File metadata and controls

108 lines (66 loc) · 5.83 KB

Recommended VSCode Configurations

Ruby And Typescript Recipes

This VSCode configuration is designed to help developers who work with Ruby and Typescript maximize productivity by:

  1. Provide real time feedback about spelling, styling, linting, testing errors, shorten code / test cycle.
  2. Automate as much as possible, such as auto linter fix, formatting, auto space/tab style switching.

This will allow the developer to focus on what is important, and leave the less important work to the machine.

Setup

To use these VSCode config presets, simply put the following files in the project directory:

Features

Spell Checker

Don't wait until your reviewer to point out your spelling errors. Let VSCode help you catch all the spelling errors before they show up on your PR.

spell-checker

RuboCop Lint Issue Highlighting

Don't wait for 30 minutes and have CI tell you that you didn't pass linting. This plugin points out any rubocop linting issues directly in your code.

Screen Shot 2022-12-07 at 4 53 59 PM

ESLInt Issue Highlighting and Fixing

Unless you like waiting for CI, let the machine help you catch the errors right inside your editor.

Screen Shot 2022-12-07 at 4 56 05 PM

Auto Fix / Format for Ruby & TypeScript

Just hit save, and your code is formatted according to company guidelines, all fixable errors are auto fixed. You just focus on what important, let the machine worry about boring stuff such as formatting your code.

auto-fix

Integrated Test View

Have all your test cases organized in one place, click a button to run one or all tests.

test-explorer

Apollo Plugin

Syntax highlight and Intellisense for GraphQL. No more guesswork or flipping through docs.

apollo

GitLens

Unless you are a git ninja, you will love Inline blame, git history viewer, Git Visualizer.

gitlens

Plugins

  • Code Spell Checker - Highlights misspelling and suggest words.
  • EditorConfig - Standardize project specific formatting such as space vs tabs, tab sizes, etc. Supports many many editors.
  • GitLens - Lots of useful git related features, such as inline blame, etc.
  • Apollo GraphQL - Official Apollo GraphQL plugin.
  • Ruby Solargraph - A Ruby language server featuring code completion, intellisense, and inline documentation.
  • Ruby Test Explorer - Run and Export Ruby Specs directly in VSCode.
  • Rubocop - Rubocop Linter Integration. Shows linting issues. Auto fix on save.
  • Ruby - Offical Ruby Plugin.
  • ESLint - ESLint plugin. Shows linting issues. Configured to auto fix on save.
  • Jest - Offical Jest Plugin. Run and explore Jest tests inside VSCode.

Terraform Recipes

This VSCode configuration is designed to help DevOps and Developers working with Terraform.

TL;DR:

Download the preset:

curl \
  --create-dirs \
  -O https://gist.githubusercontent.com/aq1018/89b26864e96305a80821d6aa506394dd/raw/extensions.json \
  -O https://gist.githubusercontent.com/aq1018/89b26864e96305a80821d6aa506394dd/raw/settings.json \
  --output-dir .vscode;

curl \
  -O https://gist.githubusercontent.com/aq1018/89b26864e96305a80821d6aa506394dd/raw/.editorconfig \
  -O https://gist.githubusercontent.com/aq1018/89b26864e96305a80821d6aa506394dd/raw/cspell.json

What's included?

  • HashiCorp Terraform - Official Terraform Plugin, many features, see link for more details.
  • Terraform Format On Save - Focus on meaningful work, let the computer do the formatting.
  • Code Spell Checker - Highlights misspelling and suggest words.
  • EditorConfig - Standardize project specific formatting such as space vs tabs, tab sizes, etc. Supports many many editors.
  • GitLens - Lots of useful git related features, such as inline blame, etc.