Skip to content

Commit 1f40580

Browse files
committed
add prettier tooling
1 parent 25d73eb commit 1f40580

4 files changed

Lines changed: 59 additions & 2 deletions

File tree

.prettierignore

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,12 @@ test-results/
132132
playwright-report/
133133
playwright/.cache/
134134

135+
# Generated API artifacts (regenerated via `make gen`)
136+
public_api.swagger.json
137+
proxy_api.swagger.json
138+
scripts/openapi-gen/openapi.json
139+
scripts/openapi-gen/proxy_api_openapi.json
140+
141+
# Synced from the SDK repo via `make sync-sdk-gen-docs` (don't reformat in place)
142+
generated-docs/
143+

Makefile

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
ROOT := $(shell git rev-parse --show-toplevel)
22
JS_SDK_ROOT := $(ROOT)/../sdk
33

4-
.PHONY: openapi-gen gen tags mintlify-check
4+
.PHONY: openapi-gen gen tags mintlify-check format format-check
55

66
# Convenience method to start dev server
77
dev:
88
mintlify dev
99

10+
# Format all hand-written content with Prettier (mdx, md, css, json, ts, js, ...)
11+
format:
12+
npm run format
13+
14+
# Check formatting without writing changes (use in CI)
15+
format-check:
16+
npm run format:check
17+
1018
# Install deps for OpenAPI
1119
install:
1220
cd scripts/openapi-gen && npm install

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,21 @@ mintlify dev
2525

2626
This will start a local development server where you can preview your changes in real-time.
2727

28+
### Formatting
29+
30+
This repo uses [Prettier](https://prettier.io) to format all hand-written content (`.mdx`, `.md`, `.css`, `.json`, `.ts`, `.js`, ...). Generated artifacts (swagger files, `generated-docs/`) are excluded via `.prettierignore`.
31+
32+
```sh
33+
# Install dev dependencies (one time)
34+
npm install
35+
36+
# Format everything in place
37+
npm run format # or: make format
38+
39+
# Check formatting without writing (useful in CI)
40+
npm run format:check # or: make format-check
41+
```
42+
2843
If you encounter any issues with the development server:
2944

3045
- Run `mintlify install` to reinstall dependencies

package-lock.json

Lines changed: 26 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)