Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Standard Prettier config file for all Toreda NPM package projects. Private internal repo but published publicly for use in our Open Source projects.
https://github.com/toreda/prettier-config

prettier standard-config tools toreda typed typescript

Last synced: 18 days ago
JSON representation

Standard Prettier config file for all Toreda NPM package projects. Private internal repo but published publicly for use in our Open Source projects.

Host: GitHub
URL: https://github.com/toreda/prettier-config
Owner: toreda
License: mit
Created: 2020-10-09T23:56:47.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-12-08T00:26:53.000Z (about 3 years ago)
Last Synced: 2024-04-25T01:41:38.007Z (9 months ago)
Topics: prettier, standard-config, tools, toreda, typed, typescript
Homepage:
Size: 5.86 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![Toreda](https://content.toreda.com/logo/toreda-logo.png)](https://www.toreda.com)

# `@toreda/prettier-config`

Toreda's official organization-wide `prettier-config` for TypeScript projects.

# Usage

## Install using yarn

```bash
$ yarn add @toreda/prettier-config --dev
```

## Install using npm
```bash
$ npm add @toreda/prettier-config --save-dev
```

# Add to Project
1. Navigate to your project's root folder.
2. Open `package.json`
3. Add a `prettier` key pointing to `@toreda/prettier-config`:

```jsonc
{
// ...
"prettier": "@toreda/prettier-config"
}
```

**Note: If your `package.json` already contains a `prettier` key, you will need to replace the value with the value shown above.**

# Examples

Here's a complete `package.json` example using the prettier key:

```json
{
"name": "sample-project-here",
"version": "1.5.3",
"description": "Sample project",
"main": "./dist/index",
"scripts": {
"test": "yarn jest --coverage"
},
"author": "Toreda, Inc.",
"license": "MIT",
"prettier": "@toreda/prettier-config"
}

```

# Legal

## License

https://www.toreda.com