Skip to content
This repository has been archived by the owner on Jan 7, 2019. It is now read-only.

Latest commit

 

History

History
114 lines (64 loc) · 3.55 KB

boost-up-my-code-editor.s.md

File metadata and controls

114 lines (64 loc) · 3.55 KB

[Standard] Boost up my code editor

Why ?

As a developer my code editor is my main working tool. I need to be able to configure it properly and use it efficiently.

Checks

My editor allows me to:

🐞 Properly Debug: so that I can quickly identify the responsibility of an unexpected behaviour

What ?
  • Setup break points
  • Inspect current context variables
How ?

🎨 Automatically Format my Code: so that I can follow my team syntactic standards and ease up code review and maintanability

What ?
  • Real time or On save formatting
  • Share configuration with team mates

How ?

🔍 Quickly Spot Syntactic Errors: so that I don't need to run my linter/type checker commands after each modification

What ?
  • Linter
  • Type checking (flow, typescript)

How ?

☁️ Visualize my git diff: so that I can see what I changed since the last time it worked

What ?
  • See the git diff
  • Revert changes on a file

How ?

  • for VSCode: Build in Source Control tab

🛠 Create & use snippets: so that I can create basic files in a flash

What ?
  • Create snippets for components, containers, tests, redux files ...
  • Share your snippets with your team to ensure consistency

How ?

🔮 Use Autocompletion: so that I can avoid typos and code faster

What ?
  • Variables & function names
  • Relative and absolute paths

How ?

⛵️ Navigate throughout the code in a click: so that I don't waste time fumbling through a complex tree view

What ?
  • Variables, Functions, Classes definition
  • Variables, Functions, Classes documentation
  • Variables, Functions, Classes typing
  • Show file location

How ?

📦 Identify Outdated packages: so that I can upgrade them rapidly after a new release

What ?
  • See the latest stable version of each package

How ?

Good Examples

🛠 Need help to setup your editor to comply with these standards ?

Bad Examples

Your current editor 😜