Skip to content

Ktsierra/prettier-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@ktsierra/prettier-config

My personal Prettier configuration for consistent code formatting across projects.

Installation

npm install -D @ktsierra/prettier-config prettier

Usage

To use this shared configuration in your project, create a prettier.config.mjs (or prettier.config.cjs) file at the root of your repository:

Note: It's important to use the .mjs extension for ESM configurations so that Node.js correctly interprets the file as an ES Module. Using .js will not work.

For ESM (.mjs)

import config from '@ktsierra/prettier-config';

export default config;

For CommonJS (`.cjs`)

module.exports = require('@ktsierra/prettier-config');

What's Included

  • No semicolons (`semi: false`)
  • Single quotes (`singleQuote: true`)
  • 2-space indentation (`tabWidth: 2`)
  • Trailing commas where valid in ES5 (`trailingComma: 'es5'`)
  • Bracket spacing enabled (`bracketSpacing: true`)
  • Brackets on new lines for JSX (`bracketSameLine: false`)
  • Line width set to 80 characters (`printWidth: 120`)

Example Configuration

/** @type {import("prettier").Config} */
export default {
  semi: false,
  singleQuote: true,
  tabWidth: 2,
  trailingComma: 'es5',
  bracketSpacing: true,
  bracketSameLine: false,
  printWidth: 120,
};

Extending or Overriding

If you want to customize the configuration further, you can extend it in your own `prettier.config.js`:

import baseConfig from '@ktsierra/prettier-config';

export default {
  ...baseConfig,
  // Your custom overrides
  printWidth: 100,
};

Why Use This?

  • Consistency: Enforces the same formatting rules across all your projects.
  • Simplicity: One shared config, easy to update and maintain.
  • Editor/CI Friendly: Works seamlessly with editors (like Neovim with prettierd) and CI pipelines.

Requirements

  • Prettier (added as a peer dependency)
  • Node.js 14 or newer

Feel free to open issues or PRs if you want to suggest improvements!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •