Skip to content

Commit 7e752aa

Browse files
feat: Clarify Prettier incompatibility
1 parent 8dfaba4 commit 7e752aa

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
Refer to full documentation at https://oliversalzburg.github.io/node-scripts-docs/
66

7+
> [!WARNING]
8+
> This module is incompatible with Prettier beyond version 3.3.3, due to Prettier no longer aligning with the CommonMark specification. Markdown documents processed by Prettier are no longer valid Markdown documents, unless only a limited set of Markdown is used.
9+
710
## Release Process
811

912
```

package.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@
3535
"preversion": "yarn run lint && yarn run build && yarn run test",
3636
"postversion": "git push"
3737
},
38+
"resolutions": {
39+
"prettier": "3.3.3"
40+
},
3841
"dependencies": {
3942
"@oliversalzburg/js-utils": "0.2.2",
4043
"elapsed-time": "0.0.1",
@@ -43,6 +46,14 @@
4346
"minimist": "1.2.8",
4447
"tslib": "2.8.1"
4548
},
49+
"peerDependencies": {
50+
"prettier": "<=3.3.3"
51+
},
52+
"peerDependenciesMeta": {
53+
"prettier": {
54+
"optional": true
55+
}
56+
},
4657
"devDependencies": {
4758
"@eslint/js": "9.17.0",
4859
"@oliversalzburg/eslint-config": "1.2.0",

yarn.lock

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3863,6 +3863,11 @@ __metadata:
38633863
tslib: "npm:2.8.1"
38643864
typescript: "npm:5.7.2"
38653865
typescript-eslint: "npm:8.18.2"
3866+
peerDependencies:
3867+
prettier: <=3.3.3
3868+
peerDependenciesMeta:
3869+
prettier:
3870+
optional: true
38663871
bin:
38673872
nsd: output/node-scripts-docs.js
38683873
languageName: unknown

0 commit comments

Comments
 (0)