Skip to content
This repository has been archived by the owner on Mar 8, 2024. It is now read-only.

Latest commit

 

History

History
66 lines (39 loc) · 3.04 KB

README.md

File metadata and controls

66 lines (39 loc) · 3.04 KB
Raw

@ontario-digital-service/prettier-config-ontario

This package provides the Prettier configuration adhering to the Ontario Frontend JavaScript style guide, which will be released in the future. This configuration aims to ensure consistency and readability in Ontario Frontend projects.

Features

  • Print Width: Limits lines to 80 characters to enhance readability across various devices and editors, ensuring code does not stretch too far horizontally.

  • Tab Width: Utilizes 2 spaces for indentation, promoting a clean and consistent visual structure across the codebase.

  • Semicolons: Enforces the use of semicolons at the end of statements, reducing the potential for parsing errors and improving code clarity.

  • Single Quotes: Prefers single quotes for strings to maintain consistency and readability, except where overridden by specific file type configurations.

  • Trailing Commas: Requires trailing commas in multi-line objects, arrays, function parameters, etc., facilitating easier version control diffs and cleaner code addition or removal.

  • Bracket Spacing: Ensures spaces are present inside object literal braces, {}, improving readability by visually separating blocks of code.

  • Bracket Same Line: Configures the closing angle bracket of elements to be placed on the same line as the last prop, aligning with common formatting practices.

  • Arrow Parens: Always requires parentheses around arrow function parameters, ensuring clarity and consistency, especially in functions with single parameters.

  • Overrides for Markdown: Specifically for .md files, double quotes are allowed, acknowledging the different stylistic and functional requirements of markdown content.

Installation

To integrate the Ontario Prettier configuration into your project, choose one of the following methods based on your package manager:

NPM

npm install @ontario-digital-service/prettier-config-ontario --save-dev

YARN

yarn add @ontario-digital-service/prettier-config-ontario --dev

Usage

Basic Configuration

To quickly apply the Ontario Prettier configuration, create a .prettierrc file in your project's root directory and specify the name of the package as its value:

"prettier-config-ontario"

Customizing Configuration

For projects that require customization beyond the base configuration, you can extend and override specific settings. Create a .prettierrc.js file in your project's root directory, import the Ontario configuration, and then add your modifications:

module.exports = {
  ...require('@ontario-digital-service/prettier-config-ontario'),
  printWidth: 120,
};

This approach allows you to maintain the foundational style guide while tweaking aspects that are project-specific or according to your team's preferences.

Contributing

We welcome contributions to improve the prettier-config-ontario package. Please feel free to submit a pull request or open an issue on our GitHub repository.