@samislam/prettier-config

A custom Prettier configuration for consistent code formatting across projects.

Installation

🚧❗ IMPORTANT: THIS PACKAGE ONLY WORKS WITH PRETTIER VERSION 3.0.3!!!

To install samislamPrettierConfig as a dependency in your project, run:

$ npm install @samislam/prettier-config prettier@3.0.3 prettier-plugin-jsdoc prettier-plugin-tailwindcss --save-dev

Or if you're using Yarn:

$ yarn add @samislam/prettier-config prettier@3.0.3 prettier-plugin-jsdoc prettier-plugin-tailwindcss --dev

Or with pnpm:

$ pnpm add -D @samislam/prettier-config prettier@3.0.3 prettier-plugin-jsdoc prettier-plugin-tailwindcss

To use this Prettier configuration, add the following line in your project's package.json:

{
  "prettier": "@samislam/prettier-config"
}

Or, you can create a .prettierrc.js file in the root of your project with:

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

default configuration

Semi-colons: Disabled (semi: false)
Tab Width: 2 spaces (tabWidth: 2).
Print Width: 100 characters (printWidth: 100).
Single Quotes: Enabled (singleQuote: true).
Trailing Commas: Enabled for ES5-compatible features (trailingComma: "es5").
JSdoc Plugin: Integrates prettier-plugin-jsdoc for formatting JSDoc comments.

nextjs/react configuration

same as the default configurations.
integrations with the prettier-plugin-tailwindcss plugin to automatically sort tailwindcss classes.

You can use this configuration by including it in your package.json as follows:

{
  "prettier": "@samislam/prettier-config/next.js"
}

Or if you're using .prettierrc.js you can directly import it:

module.exports = require("@samislam/prettier-config/next");

MIT