Introduction about project

This project contains prettier configuration for nodejs project.

If you don't know what prettier is then probably, you should first learn about that. Click here to know more about prettier.

Why ?

Each company has team that follows different convention. This is for our team and shared in different projects.

We use prettier with visual studio code and it usually takes code formatting, following coding style guideline out of regular application coding. So that we can focus more on project and not on fixing the coding styles.

Disclaimer

This repository is supposed to be updated frequently.

Usage

Two steps.

1. add this package as dev dependency to your project.

npm i -D appsynth-prettier-config

2. Include in package.json

{
  "name": "@company/awesome-project",
  "version": "1.0.0",
  "description": "Your awesome project",
  "prettier": "appsynth-prettier-config",  // configuration added here
  ...
}

3. Try making some changes to verify your configuration for prettier.

Tips and tricks

Prettier plays very well with visual studio code. You can configure visual studio code to format on save. So, everytime you write code and save visual studio code will format your source code.

It will take time to get used to with eslint/tslint configuration. Don't just give up. Keep writing clean code.

If you find some issue. Please open PR, create issues. They are always welcome.

Npm repository

npm package