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

osskit's shareable config for Prettier
https://github.com/osskit/prettier-config

Last synced: 9 days ago
JSON representation

osskit's shareable config for Prettier

• Host: GitHub
• URL: https://github.com/osskit/prettier-config
• Owner: osskit
• License: mit
• Created: 2021-08-10T13:41:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-15T14:46:12.000Z (about 1 year ago)
• Last Synced: 2024-12-11T22:12:58.413Z (13 days ago)
• Language: JavaScript
• Size: 2.93 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @osskit/prettier-config [![NPM version](https://img.shields.io/npm/v/@osskit/prettier-config.svg)](https://www.npmjs.com/package/@osskit/prettier-config)

osskit's [shareable config](https://prettier.io/docs/en/configuration.html#sharing-configurations) for [Prettier](https://prettier.io/)

## Installation

Install Prettier and `@osskit/prettier-config`:

```

npm install --save-dev prettier @osskit/prettier-config

```

## Usage

osskit's Prettier rules come bundled in `@osskit/prettier-config`. To enable these rules, add a `prettier` property in your `package.json`. See the [Prettier configuration docs](https://prettier.io/docs/en/configuration.html) for more details.

```json

"prettier": "@osskit/prettier-config"

```

If you don't want to use `package.json`, you can use any of the supported extensions to export a string:

```jsonc

// `.prettierrc.json`

"@osskit/prettier-config"

```

```javascript

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

module.exports = '@osskit/prettier-config';

```

## Extending

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 use a `prettier.config.js` or `.prettierrc.js` file that exports an object:

```javascript

module.exports = {

    ...require('@osskit/prettier-config'),

    semi: false

};

```

## [LICENSE](LICENSE)