-
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.
feat: create prettier-config package
- Loading branch information
Showing
6 changed files
with
129 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@phi.school/prettier-config': minor | ||
--- | ||
|
||
Initial release. |
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 |
---|---|---|
@@ -0,0 +1,90 @@ | ||
<a name="readme-top"></a> | ||
|
||
<br/> | ||
|
||
<div align="center"> | ||
|
||
<h1>@phi.school/prettier-config</h1> | ||
|
||
<p> | ||
A Prettier configuration to enforce phi school's code style preferences. | ||
</p> | ||
|
||
<!-- Quick Project Links --> | ||
|
||
[Changelog][changelog-link] · [Report Bug][github-issues-link] · [Request Feature][github-issues-link] | ||
|
||
<!-- Shield Group --> | ||
|
||
[![NPM Package Badge][npm-shield]][npm-link] | ||
|
||
</div> | ||
|
||
<br/> | ||
|
||
## Table of Contents | ||
|
||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
## Installation | ||
|
||
```sh | ||
pnpm i -D @phi.school/prettier-config | ||
``` | ||
|
||
<div align="right"> | ||
|
||
[![Back to Top Badge][back-to-top]](#readme-top) | ||
|
||
</div> | ||
|
||
## Usage | ||
|
||
Extend this package in your local prettier config or `package.json`: | ||
|
||
**Prettier config:** | ||
|
||
```json | ||
// .prettierrc.json | ||
"@phi.school/prettier-config" | ||
``` | ||
|
||
**package.json:** | ||
|
||
```json | ||
{ | ||
"prettier": "@phi.school/prettier-config" | ||
} | ||
``` | ||
|
||
<div align="right"> | ||
|
||
[![Back to Top Badge][back-to-top]](#readme-top) | ||
|
||
</div> | ||
|
||
## Contributing | ||
|
||
We welcome contributions! For a detailed guide on how to contribute, please refer to the [Contributing](../../README.md#contributing) section in the main README of the repository. | ||
|
||
## License | ||
|
||
Released under the [MIT](./LICENSE) License. © 2023-Present [phi school](https://phi.school) | ||
|
||
<div align="right"> | ||
|
||
[![Back to Top Badge][back-to-top]](#readme-top) | ||
|
||
</div> | ||
|
||
<!-- Link Group --> | ||
|
||
[back-to-top]: https://img.shields.io/badge/-⇧_Back_To_Top-black?style=flat-square | ||
[changelog-link]: ./CHANGELOG.md | ||
[github-issues-link]: https://github.com/phi-school/config/issues | ||
[license]: ./LICENSE | ||
[npm-link]: https://www.npmjs.com/package/@phi.school/prettier-config | ||
[npm-shield]: https://img.shields.io/npm/v/@phi.school/prettier-config?color=black&style=for-the-badge |
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"name": "@phi.school/prettier-config", | ||
"version": "0.0.0", | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"main": "src/index.json", | ||
"scripts": { | ||
"lint": "eslint --cache ." | ||
} | ||
} |
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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"printWidth": 80, | ||
"semi": false, | ||
"singleQuote": true, | ||
"tabWidth": 2, | ||
"useTabs": true, | ||
"overrides": [ | ||
{ | ||
"files": "*.{md,yaml,yml}", | ||
"options": { | ||
"useTabs": false | ||
} | ||
} | ||
] | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.