@homestuck/prettier-config 1.5.1 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +71 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.6.0](https://github.com/homestuck/configs/compare/prettier-config@v1.5.2...prettier-config@v1.6.0) (2026-01-20)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* Adding README documents for all packages ([#50](https://github.com/homestuck/configs/issues/50)) ([71534f9](https://github.com/homestuck/configs/commit/71534f94200c6a908bd31ca1c3b9526e975124ad))
|
|
9
|
+
|
|
10
|
+
## [1.5.2](https://github.com/homestuck/configs/compare/prettier-config@v1.5.1...prettier-config@v1.5.2) (2026-01-20)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Miscellaneous Chores
|
|
14
|
+
|
|
15
|
+
* release 1.5.2 ([bb61c1a](https://github.com/homestuck/configs/commit/bb61c1a286fa30a194b75ff6cdea0cb9f20e33fc))
|
|
16
|
+
|
|
3
17
|
## [1.5.1](https://github.com/homestuck/configs/compare/prettier-config@v1.5.0...prettier-config@v1.5.1) (2026-01-20)
|
|
4
18
|
|
|
5
19
|
### Miscellaneous Chores
|
package/README.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<h1>@homestuck/prettier-config</h1>
|
|
3
|
+
|
|
4
|
+
A baseline Prettier configuration used and maintained by members of [@homestuck](https://github.com/homestuck).
|
|
5
|
+
|
|
6
|
+
[](https://www.npmjs.com/package/@homestuck/prettier-config)
|
|
7
|
+
[](https://opensource.org/licenses/MIT)
|
|
8
|
+
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
## 🚀 Quick Start
|
|
12
|
+
|
|
13
|
+
### 1. Install the package:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install --save-dev @homestuck/prettier-config
|
|
17
|
+
# or
|
|
18
|
+
pnpm add -D @homestuck/prettier-config
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### 2. Add to your project using one of the following supported methods:
|
|
22
|
+
|
|
23
|
+
#### Update your project's `package.json` file:
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"name": "your-project",
|
|
28
|
+
"prettier": "@homestuck/prettier-config"
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
#### Update/Create your project's Prettier configuration YAML or JSON file:
|
|
33
|
+
|
|
34
|
+
```yaml
|
|
35
|
+
# .prettierrc, .prettierrc.yml, .prettierrc.yaml, .prettierrc.json, or .prettierrc.json5
|
|
36
|
+
'@homestuck/prettier-config'
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
#### Update/Create your project's Prettier configuration JS (ESModule) file:
|
|
40
|
+
|
|
41
|
+
```js
|
|
42
|
+
// prettier.config.js, .prettierrc.js, prettier.config.mjs, or .prettierrc.mjs
|
|
43
|
+
import homestuckPrettierConfig from '@homestuck/prettier-config'
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* @see https://prettier.io/docs/configuration
|
|
47
|
+
* @type {import("prettier").Config}
|
|
48
|
+
*/
|
|
49
|
+
const config = {
|
|
50
|
+
...homestuckPrettierConfig,
|
|
51
|
+
// Optional config overrides can be set here.
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export default config
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Update/Create your project's Prettier configuration TS (ESModule) file:
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
// prettier.config.ts, .prettierrc.ts, prettier.config.mts, or .prettierrc.mts
|
|
61
|
+
import type { Config } from 'prettier'
|
|
62
|
+
|
|
63
|
+
import baseConfig from '@homestuck/prettier-config'
|
|
64
|
+
|
|
65
|
+
const config: Config = {
|
|
66
|
+
...baseConfig,
|
|
67
|
+
// Additional configs and overrides can optionally be set here.
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export default config
|
|
71
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@homestuck/prettier-config",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.6.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Baseline Prettier config used and maintained by Homestuck Inc., et al.",
|
|
6
6
|
"repository": {
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"@types/node": "^25.0.9",
|
|
21
21
|
"typescript": "^5.9.3",
|
|
22
|
-
"@homestuck/tsconfig": "1.
|
|
22
|
+
"@homestuck/tsconfig": "1.6.0"
|
|
23
23
|
},
|
|
24
24
|
"peerDependencies": {
|
|
25
25
|
"@ianvs/prettier-plugin-sort-imports": "^4.7.0",
|