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

My personal Prettier configuration
https://github.com/andrewmcodes/prettier-config

andrewmcodes prettier prettier-config

Last synced: about 1 month ago
JSON representation

My personal Prettier configuration

• Host: GitHub
• URL: https://github.com/andrewmcodes/prettier-config
• Owner: andrewmcodes
• License: mit
• Created: 2020-10-08T12:49:43.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-05-25T07:31:14.000Z (about 3 years ago)
• Last Synced: 2025-03-07T22:46:14.398Z (over 1 year ago)
• Topics: andrewmcodes, prettier, prettier-config
• Language: JavaScript
• Homepage:
• Size: 146 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @andrewmcodes/prettier-config

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

![npm](https://img.shields.io/npm/v/@andrewmcodes/prettier-config)

[![CI](https://github.com/andrewmcodes/prettier-config/actions/workflows/ci.yml/badge.svg)](https://github.com/andrewmcodes/prettier-config/actions/workflows/ci.yml)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

This is a shareable [Prettier](https://prettier.io/) configuration, which includes a set of preferred styling rules that can be easily extended.

## Installation

```shell

# npm

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

# yarn

yarn add -D @andrewmcodes/prettier-config

```

## Usage

You can use this a few different ways, but the recommended approach is to add it to your `package.json`:

```json

"prettier": "@andrewmcodes/prettier-config"

```

If you don’t want to use package.json, you can use any of the supported extensions to export a string, e.g. .prettierrc.json:

```json

"@andrewmcodes/prettier-config"

```

If you need to extend the configuration, you can use the .js extension and export an object:

```javascript

module.exports = {

  ...require("@andrewmcodes/prettier-config"),

  semi: false,

};

```

## Contributing

I'd love your help refining this package. Please don't hesitate to send a pull request.

### Code Style

Run `yarn format` before committing to ensure your changes comply with our coding style.

### Commit Messages

This project uses [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). Please make sure your commit messages follow this format.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).