feat: add prettier-plugin-packagejson plugin to configuration

Author: JanSzewczyk

.github/workflows/publish.yml

@@ -29,4 +29,4 @@ jobs:
         run: yarn semantic-release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -1,12 +1,13 @@
 <!-- markdownlint-disable --><!-- textlint-disable -->
+
 # 📓 Changelog
+
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 # 1.0.0 (2023-03-06)
 
-
 ### Features
 
-* **prettier:** create `prettier` configuration ([b60a66d](https://github.com/JanSzewczyk/prettier-config/commit/b60a66d4a66a98b2d00c33e627596d727ef400cf))
-* **semantic-release:** add `semantic-release` configuration ([edafa98](https://github.com/JanSzewczyk/prettier-config/commit/edafa984e6ba1c7ce2ba02b5320befcce25aa562))
+- **prettier:** create `prettier` configuration ([b60a66d](https://github.com/JanSzewczyk/prettier-config/commit/b60a66d4a66a98b2d00c33e627596d727ef400cf))
+- **semantic-release:** add `semantic-release` configuration ([edafa98](https://github.com/JanSzewczyk/prettier-config/commit/edafa984e6ba1c7ce2ba02b5320befcce25aa562))

README.md

@@ -1,5 +1,108 @@
 # @szum-tech/prettier-config
 
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/JanSzewczyk/prettier-config)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/JanSzewczyk/prettier-config)](https://github.com/JanSzewczyk/prettier-config/pulls)
+[![GitHub issues](https://img.shields.io/github/issues/JanSzewczyk/prettier-config)](https://github.com/JanSzewczyk/prettier-config/issues)
+![GitHub Repo stars](https://img.shields.io/github/stars/JanSzewczyk/prettier-config?style=social)
+
+[![released](https://github.com/JanSzewczyk/prettier-config/actions/workflows/publish.yml/badge.svg?branch=main)](https://github.com/JanSzewczyk/prettier-config/actions/workflows/publish.yml)
+
+[![npm](https://img.shields.io/npm/v/@szum-tech/prettier-config)](https://www.npmjs.com/package/@szum-tech/prettier-config)
+![npm](https://img.shields.io/npm/dm/@szum-tech/prettier-config)
+
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/JanSzewczyk/prettier-config/blob/main/LICENSE)
+
 ---
 
 [Prettier](https://prettier.io/) shareable configuration.
+
+# Table of contents
+
+- [Features](#features)
+- [Technologies](#technologies)
+- [Usage](#usage)
+  - [Installation](#installation)
+  - [Set configuration](#set-configuration)
+  - [Add scripts](#add-scripts)
+- [Changelog](#changelog)
+- [License](#license)
+
+# Features
+
+- [Opinionated code formatter with support for: JavaScript, Typescript, JSX, ...](https://prettier.io/)
+- [Sort the keys of a `package.json` file](https://github.com/matzkoh/prettier-plugin-packagejson#readme)
+
+# Technologies
+
+![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/JanSzewczyk/prettier-config/prettier-plugin-packagejson)
+
+![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/JanSzewczyk/prettier-config/dev/prettier)
+![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/JanSzewczyk/prettier-config/dev/semantic-release)
+
+I also used my packages:
+
+![GitHub package.json dependency version (prod)](https://img.shields.io/github/package-json/dependency-version/JanSzewczyk/prettier-config/dev/@szum-tech/semantic-release-preset)
+
+# Usage
+
+## Installation
+
+[@szum-tech/prettier-config](https://www.npmjs.com/package/@szum-tech/prettier-config) is available as an [npm package](https://www.npmjs.com/package/@szum-tech/prettier-config).
+
+**npm:**
+
+```shell
+npm install -D prettier @szum-tech/prettier-config
+```
+
+**yarn:**
+
+```shell
+yarn add -D prettier @szum-tech/prettier-config
+```
+
+## Set configuration
+
+Full documentation on how to create a Prettier configuration can be found [here](https://prettier.io/docs/en/configuration.html). 
+
+Below are the recommended ways to add it:
+
+### 1. Create config file
+
+First create `prettier.config.js` file in root project directory. Then:
+
+```js
+module.exports = require("@szum-tech/prettier-config");
+```
+
+### 2. Add to `package.json` file
+
+```json
+{
+  "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 :
+
+```json
+{
+  "scripts": {
+    "prettier:check": "prettier --check .",
+    "prettier:write": "prettier --write ."
+  }
+}
+```
+
+# Changelog
+
+The [changelog](https://github.com/JanSzewczyk/prettier-config/blob/main/CHANGELOG.md) is regularly updated to reflect what's changed in each new release.
+
+# License
+
+This project is licensed under the terms of the [MIT license](https://github.com/JanSzewczyk/prettier-config/blob/main/LICENCE).

index.js

@@ -7,5 +7,6 @@ module.exports = {
   trailingComma: "none",
   bracketSpacing: true,
   bracketSameLine: false,
-  printWidth: 100
+  printWidth: 100,
+  plugins: ["prettier-plugin-packagejson"]
 };

release.config.js

@@ -2,4 +2,4 @@
 module.exports = {
   branches: ["main"],
   extends: "@szum-tech/semantic-release-preset"
-};
+};