@under-io/prettier

@under-io/prettier

A Prettier Config designed to help efficiently scaffold Under Engineering projects.

Report Bug · Request Feature

Table of Contents

1. Implementation
2. Getting Started
   • Installation
   • Choose a Profile
3. License

Implementation

By leveraging this shared configuration, developers across various projects can ensure uniform code styling and formatting, eliminating the need for individual configurations and reducing inconsistencies between codebases. This unified approach not only saves time previously spent on adjusting and maintaining Prettier settings but also minimizes the chances of divergent formatting choices across projects, fostering a more cohesive and standardized codebase. With this shared Prettier configuration package, our team can focus more on actual code development, rather than concerning themselves with the intricacies of code formatting, ultimately boosting productivity and facilitating seamless collaboration within our engineering ecosystem.

Getting Started

Implementing the ruleset into your project is an easy and straightforward process. Start by installing the package, then proceed to generate an .prettierrc.js configuration file in the root and import the appropriate profile.

Installation

To install the package, do this:

$ cd your-project-folder

$ npm install --save-dev prettier @under-io/prettier

Choose a Profile

The ruleset currently offers support for two distinct "profile" strings. These profiles allow you to choose the appropriate set of lint rules tailored to your specific project needs.

• @under-io/prettier/with-tailwind - This profile is specifically tailored to accommodate and optimize code formatting for projects utilizing TailwindCSS, ensuring the Prettier settings align with Tailwind's specific styling requirements.

• @under-io/prettier/without-tailwind - This profile does all of the above but does not include the Tailwind-specific rules.

  Opt for the with-tailwind profile if your project integrates TailwindCSS on the frontend.

After choosing a profile, create an .prettierrc.js config file at the root of your project that imports the appropriate profile, as shown below:

.prettierrc.js

module.exports = require('@under-io/prettier/without-tailwind');

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

@under-io/prettier is part of the Under family of projects.