Skip to content

JanSzewczyk/prettier-config

Repository files navigation

@szum-tech/prettier-config

GitHub release (latest by date) GitHub pull requests GitHub issues GitHub Repo stars

released

npm npm

Conventional Commits license


Prettier shareable configuration.

Table of contents

Features

Technologies

GitHub package.json dependency version (prod) GitHub package.json dependency version (prod)

GitHub package.json dependency version (prod) GitHub package.json dependency version (prod)

I also used my packages:

GitHub package.json dependency version (prod)

Usage

Installation

@szum-tech/prettier-config is available as an npm package.

npm:

npm install -D prettier @szum-tech/prettier-config

yarn:

yarn add -D prettier @szum-tech/prettier-config

Set configuration

Full documentation on how to create a Prettier configuration can be found here.

Below are the recommended ways to add it:

1. Create config file

First create prettier.config.js file in root project directory. Then:

module.exports = require("@szum-tech/prettier-config");

2. Add to package.json file

{
  "prettier": "@szum-tech/prettier-config"
}

Note You can ignore files by adding it to .prettierignore.

Add scripts

Optional, can add scripts to package.json file :

{
  "scripts": {
    "prettier:check": "prettier --check .",
    "prettier:write": "prettier --write ."
  }
}

Changelog

The changelog is regularly updated to reflect what's changed in each new release.

License

This project is licensed under the terms of the MIT license.