@samislam/prettier-config

A custom Prettier configuration for consistent code formatting across projects.

Installation

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

$ npm install --save-dev --save-exact @samislam/prettier-config [email protected] @homer0/prettier-plugin-jsdoc prettier-plugin-tailwindcss

Or if you're using Yarn:

$ yarn add --dev --exact @samislam/prettier-config [email protected] @homer0/prettier-plugin-jsdoc prettier-plugin-tailwindcss

Or with pnpm:

$ pnpm add -D -E @samislam/prettier-config [email protected] @homer0/prettier-plugin-jsdoc prettier-plugin-tailwindcss

Or with bun:

$ bun add -D -E @samislam/prettier-config [email protected] @homer0/prettier-plugin-jsdoc prettier-plugin-tailwindcss

Usage

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')

Available configurations:

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 @homer0/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')

License

MIT