We use formatting and linting tools to help write consistent and clean code. You still need to take our clean coding principles to heart, but these tools help with git diffs and preventing some bugs.

Presentation about code consistency

Code Consistency Presentation.key

Code Consistency Presentation.pptx

Shared config

We have a shared prettier and eslint config here: https://github.com/IGNE-Agency/code-consistency

These configs are exposed as npm packages and should eventually be used by all our projects.

NPM links:

• https://www.npmjs.com/package/@igne-agency/prettier
• https://www.npmjs.com/package/@igne-agency/eslint-config-igne

Configuring your editor (VSCode)

Install the required plugins:

• Prettier esbenp.prettier-vscode
• ESLint dbaeumer.vscode-eslint

Settings

• Press cmnd + , to open settings

• Then click this icon in the top right:

  

• Alternatively press cmnd + shift + P, type user setings and choose Preferences: Open user settings (JSON).

Prettier settings

{
	"editor.defaultFormatter": "esbenp.prettier-vscode",
}

// Optional, but recommended:
{
	"editor.formatOnPaste": true,
  "editor.formatOnSave": true,
}