-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also: change @csquare-ai to @csquare
- Loading branch information
Mathieu Bour
committed
Apr 13, 2021
1 parent
6bf6e8f
commit 1fc9a64
Showing
5 changed files
with
68 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,32 @@ | ||
# `@csquare-ai/prettier-config` | ||
# `@csquare/prettier-config` | ||
|
||
[csquare-ai](gttps://github.com/csquare-ai)'s official [Prettier](https://prettier.io) configuration. | ||
[csquare-ai](https://github.com/csquare-ai)'s official [Prettier](https://prettier.io) configuration. | ||
|
||
Proudly maintained by: | ||
|
||
- Mathieu Bour <[mathieu@csquare.ai](mailto:mathieu@csquare.ai)> | ||
- Clarisse Tarrou <[clarisse@csquare.ai](mailto:clarisse@csquare.ai)> | ||
|
||
## Installation | ||
|
||
After the private NPM registry setup of the [@csquare-ai organization](https://github.com/csquare-ai/engineering/blob/main/docs/node-js.md#authentication-against-github-packages), simply run: | ||
|
||
```bash | ||
npm install --dev @csquare-ai/prettier-config | ||
npm install --dev @csquare/prettier-config | ||
``` | ||
|
||
Then, ensure that your `package.json` file contains the entry: | ||
|
||
```json | ||
{ | ||
"prettier": "@csquare-ai/prettier-config" | ||
"prettier": "@csquare/prettier-config" | ||
} | ||
``` | ||
|
||
## Plugins | ||
|
||
In addition to the Prettier default rules, we also use the following plugins: | ||
|
||
- [@trivago/prettier-plugin-sort-imports](https://github.com/trivago/prettier-plugin-sort-imports) | ||
|
||
## References | ||
|
||
- [Prettier - Sharing configurations](https://prettier.io/docs/en/configuration.html#sharing-configurations) | ||
- [Engineering - Code style](https://github.com/csquare-ai/engineering/blob/main/docs/code-style.md) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters