@cprussin/prettier-config v2.1.0
@cprussin/prettier-config - v2.1.0
This package contains a prettier config. It's empty right now, and only exists to be a convenient place to add configs in the future if I ever need to such that I'll apply them consistently across my projects.
Installing
Use the package manager of your choice to install:
- npm:
npm install --save-dev @cprussin/prettier-config
- pnpm:
pnpm add -D @cprussin/prettier-config
- yarn:
yarn add -D @cprussin/prettier-config
Usage
Just export the config from your prettier config file. For example, in
prettier.config.js
:
export { base as default } from "@cprussin/prettier-config";
If you want to combine configs or take the base config and extend it you use
mergeConfigs
, like so:
import { base, tailwind, mergeConfigs } from "@cprussin/prettier-config";
export default mergeConfigs([
base,
tailwind('./tailwind.config.js'),
{ someSetting: "some-value" }
]);
Table of contents
Variables
Functions
Variables
base
• Const
base: Config
= {}
The base config. It's literally just an empty object currently. If I ever want to update my format preferences across all my projects, I'll do it here.
Defined in
Functions
mergeConfigs
▸ mergeConfigs(configs
): Config
A simple utility to merge an array of configs together. Later configs in the array override earlier configs in the case of conflicting values. Plugins and overrides are concatenated together.
Parameters
Name | Type | Description |
---|---|---|
configs | Config [] | an array of Prettier config objects to merge |
Returns
Config
a merged Prettier config
Defined in
tailwind
▸ tailwind(tailwindConfig
): Config
& Partial
\<PluginOptions
>
Construct a config for projects using Tailwind. Adds the tailwind plugin and sets up some common tailwind options.
Parameters
Name | Type | Description |
---|---|---|
tailwindConfig | string | the path to the project's tailwind config file |
Returns
Config
& Partial
\<PluginOptions
>
the Prettier config