Skip to content

chore: add prettier for markdown and astro formatting #2153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
notrab wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

chore: add prettier for markdown and astro formatting #2153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f9064d
docs(changeset): Eliminate the `@ensnode/ensnode-react` package; its …
notrab May 14, 2026
61a85e4
chore: add prettier for markdown and astro formatting
notrab May 19, 2026
1bda9d2
Delete .changeset/upset-kids-drop.md
notrab May 19, 2026
38424bf
add prettier-plugin-astro
notrab May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Dependencies and build output (prettier ignores node_modules by default; listed for clarity)
node_modules
dist
build
.next
.astro
.ponder
generated

# Lockfiles
pnpm-lock.yaml

# Generated changelogs — owned by changesets, do not reformat
**/CHANGELOG.md
4 changes: 4 additions & 0 deletions .prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"printWidth": 100,
"proseWrap": "preserve"
}
3 changes: 3 additions & 0 deletions docs/ensnode.io/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
.astro
13 changes: 13 additions & 0 deletions docs/ensnode.io/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
Copy link
Copy Markdown
Contributor

@vercel vercel Bot May 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Workspace-specific Prettier configs missing base formatting options (printWidth, proseWrap) causes inconsistent code formatting

Fix on Vercel

"plugins": ["prettier-plugin-astro"],
"overrides": [
{
"files": "*.astro",
"options": {
"parser": "astro"
}
}
],
"bracketSameLine": true,
"astroSkipFrontmatter": true
}
4 changes: 4 additions & 0 deletions docs/ensnode.io/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
"astro": "astro",
"lint": "biome check --write",
"lint:ci": "biome ci",
"format": "prettier --write \"**/*.astro\"",
"format:check": "prettier --check \"**/*.astro\"",
"omnigraph-examples:refresh-responses": "tsx --tsconfig tsconfig.json scripts/fetch-omnigraph-example-responses.mts",
"test": "vitest",
"generate:openapi": "pnpm --filter ensapi exec tsx --tsconfig tsconfig.json ../../scripts/generate-ensapi-openapi.mts"
Expand Down Expand Up @@ -56,6 +58,8 @@
"devDependencies": {
"@types/react": "catalog:",
"@types/react-dom": "catalog:",
"prettier": "catalog:",
"prettier-plugin-astro": "catalog:",
"tsx": "^4.19.3",
"vitest": "catalog:"
}
Expand Down
3 changes: 3 additions & 0 deletions docs/ensrainbow.io/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
dist
.astro
13 changes: 13 additions & 0 deletions docs/ensrainbow.io/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"plugins": ["prettier-plugin-astro"],
"overrides": [
{
"files": "*.astro",
"options": {
"parser": "astro"
}
}
],
"bracketSameLine": true,
"astroSkipFrontmatter": true
}
8 changes: 6 additions & 2 deletions docs/ensrainbow.io/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
"preview": "astro preview",
"astro": "astro",
"lint": "biome check --write .",
"lint:ci": "biome ci"
"lint:ci": "biome ci",
"format": "prettier --write \"**/*.astro\"",
"format:check": "prettier --check \"**/*.astro\""
},
"dependencies": {
"@astrojs/react": "catalog:",
Expand All @@ -30,6 +32,8 @@
},
"devDependencies": {
"@types/react": "catalog:",
"@types/react-dom": "catalog:"
"@types/react-dom": "catalog:",
"prettier": "catalog:",
"prettier-plugin-astro": "catalog:"
}
}
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"private": true,
"packageManager": "pnpm@10.33.0",
"scripts": {
"lint": "biome check --write .",
"lint:ci": "biome ci",
"lint": "pnpm exec prettier --write \"**/*.md\" && pnpm -r --parallel --if-present run format && biome check --write .",
Copy link
Copy Markdown
Member

@shrugs shrugs May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it'd be simplest and easiest to reason about if we did the following

    "lint": "pnpm run -w \"/^lint:[.!:]*$/\"",
    // ^- make this run lint:prettier and lint:biome in parallel
    "lint:ci": "pnpm run -w \"/^lint:.*:ci$/\"",
    "lint:prettier": "pnpm exec prettier --write  \"**/*.md\" && pnpm -r lint:prettier",
    "lint:prettier:ci": "pnpm exec prettier --check  \"**/*.md\" && pnpm -r lint:prettier:ci",
    "lint:biome": "biome check --write .",
    "lint:biome:ci": "biome ci"

and then define the lint:prettier and `lint:biome

or rename format:check to format:ci to follow biome pattern and keep the current structure.

don't think --if-present is necessary when using -r, it's implied

Copy link
Copy Markdown
Member Author

@notrab notrab May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. Was just following how ENSAwards so it was consistent to what @Y3drk had approved and merged. @Y3drk wdyt?

Copy link
Copy Markdown
Member

@Y3drk Y3drk May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The end goal is to have lint and lint:ci commands that, when called, perform both biome and prettier actions together.
  • When we call pnpm lint at the repo root or project/package root, all files affected should be fully formatted

-- that was specifically requested by @lightwalker-eth when I was making these changes in ENSAwards.

  • As long as that's met, I think it's okay to make it more modular as @shrugs suggests.
  • I'd also be in favor of removing the format* commands and handling it all with lint*, assuming that's possible

"lint:ci": "pnpm exec prettier --check \"**/*.md\" && pnpm -r --parallel --if-present run format:check && biome ci",
Comment on lines +7 to +8
Copy link
Copy Markdown
Member Author

@notrab notrab May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Config here states {md,mdx}?

Copy link
Copy Markdown
Member Author

@notrab notrab May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what Prettier is for...

Comment thread
vercel[bot] marked this conversation as resolved.
"test": "vitest --silent passed-only",
"test:integration": "vitest --config vitest.integration.config.ts --silent passed-only",
"test:integration:ci": "pnpm -F @ensnode/integration-test-env start",
Expand Down Expand Up @@ -36,6 +36,8 @@
"@changesets/cli": "^2.29.8",
"@typescript/native-preview": "7.0.0-dev.20260128.1",
"jsdom": "^27.0.1",
"prettier": "catalog:",
"prettier-plugin-astro": "catalog:",
"tsup": "catalog:",
"typescript": "catalog:",
"vitest": "catalog:"
Expand Down
68 changes: 61 additions & 7 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions pnpm-workspace.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ catalog:
pino: 10.1.0
ponder: 0.16.6
postcss: 8.5.12
prettier: 3.6.2
prettier-plugin-astro: 0.14.1
react: 19.2.1
react-dom: 19.2.1
tailwind-merge: ^3.4.0
Expand Down
Loading