CONTRIBUTING.md

Code Formatter

This project uses Prettier to format its code.

Please, use the library along with the rules added to this project, following the code format pattern.

Configuration Guide Examples:

VSCode

Install the official extension. Then, add this to your settings:

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

If you psqs-transport, add the following configuration to format your conde on save:

{
  "editor.formatOnSave": true,
}

For more options see their repository.

Jetbrains

Follow the official documentation, selecting the option:

Tools -> Actions on Save -> Run Prettier.

Also, certifies that the IDE is using the Prettier rules defined by this project.

Emacs

Install prettier package through MELPA. Then add this hook, to your . emacs file, to format your changes on save:

(add-hook 'after-init-hook #'global-prettier-mode)

For more IDE configuration guides, see prettier official documentation and install the proper plugin for your IDE.

Troubleshooting

If you had any trouble configuring prettier - after you make your changes - run the following command to apply the code formatter:

npm run prettier

Or

Feel free to open an Issue.