https://github.com/morellodev/prettier-config

A shareable configuration for projects using Prettier.
https://github.com/morellodev/prettier-config

Last synced: 24 days ago
JSON representation

A shareable configuration for projects using Prettier.

• Host: GitHub
• URL: https://github.com/morellodev/prettier-config
• Owner: morellodev
• License: bsd-3-clause
• Created: 2021-05-10T12:36:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-28T10:30:59.000Z (about 3 years ago)
• Last Synced: 2024-09-26T09:10:54.688Z (about 1 month ago)
• Homepage:
• Size: 73.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# prettier-config-morellodev

A [shareable configuration](https://prettier.io/docs/en/configuration.html#sharing-configurations)

for projects using **[Prettier](https://prettier.io/)**.

## Installation

```sh

npm install --save-dev prettier-config-morellodev

```

_This is only a shareable configuration. It does not install Prettier,

ESLint, or any other part of the tool chain._

## Usage

Reference it in `package.json` using the `prettier` property:

```json

{

  "name": "my-project-name",

  "prettier": "prettier-config-morellodev",

  "devDependencies": {

    "prettier-config-morellodev": "^1.0.0"

  }

}

```

If you don't want to use `package.json`, you can use any of the supported

extensions to export a string:

```jsonc

// `.prettierrc.json`

"prettier-config-morellodev"

```

```javascript

// `prettier.config.js` or `.prettierrc.js`

module.exports = "prettier-config-morellodev";

```

## Extending Shared Configurations

This configuration is not intended to be changed, but if you have a setup where

modification is required, it is possible. Prettier does not offer an "extends"

mechanism as you might be familiar from tools such as ESLint.

To extend a configuration you will need to:

1. Import/Require this sharable config from within your own configuration. This

   means you must be using a JavaScript version of a Prettier configuration

   file.

2. Extend your modification on top of the shared config using something like

   **[Object destructuring](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment)**,

   **[Object.assign()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)**,

   or **[lodash.merge()](https://lodash.com/docs/4.17.11#merge)**

3. Export the modified configuration

> Prettier uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for

> configuration file support. This means you can configure prettier via:

>

> - A `.prettierrc` file, written in YAML or JSON, with optional extensions: `.yaml/.yml/.json`.

> - A `.prettierrc.toml` file, written in TOML (the `.toml` extension is _required_).

> - A `prettier.config.js` or `.prettierrc.js` file that exports an object.

> - A `"prettier"` key in your `package.json` file.

For example, if you need to change it so that semicolons are removed:

```javascript

// `prettier.config.js` or `.prettierrc.js`

const morellodevPrettierConfig = require("prettier-config-morellodev");

const merge = require("lodash.merge");

const modifiedConfig = merge({}, morellodevPrettierConfig, {

  semi: false,

  // ... other modified settings here

});

module.exports = modifiedConfig;

```