README.md

@sngular/prettier-config

Sharable prettier config enforcing SNGULAR style guidelines.

Getting started

npm install --save-dev @sngular/prettier-config
echo "module.exports = require(\"@sngular/prettier-config\");" > prettier.config.cjs

Once you have it installed and configured you can add the following script into your package.json:

{
	"scripts": {
		"lint": "npm run lint:prettier",
		"lint:prettier": "prettier --check .",
		"format": "npm run format:prettier",
		"format:prettier": "npm run lint:prettier -- --write"
	}
}

Now you can run npm format for formatting all your project code or npm lint to check project code formatting.

Rules

Indent

We decide to use tabs instead of spaces that recommends eslint.

Reasons:

• logical: that's what they're used for.
• file size: tab is just 1 character.
• accessibility: you can customize your own indentation width.

VSCode recommendations

Install Prettier VSCode extension, and set Prettier as default formatter in your VSCode settings.json with:

"editor.defaultFormatter": "esbenp.prettier-vscode"

If you prefer to automate Prettier execution, you can add this configuration and it will be executed every time you save a file.

"editor.formatOnSave": true