From 84832ee998dccc0640feaa3b25551b695c8a1229 Mon Sep 17 00:00:00 2001 From: Tyler <26290074+tylersayshi@users.noreply.github.com> Date: Wed, 22 Oct 2025 23:36:42 -0700 Subject: [PATCH] fix: use spaces for readme b/c npmjs.org does not format tabs well this is only a recommendation and the better fix would be better default tab spaces view on npmjs.com, but that sounds unlikely? here's an example of when it's bad https://www.npmjs.com/package/prototypey/v/0.2.3 vs with spaces https://www.npmjs.com/package/prototypey/v/0.2.4 --- src/blocks/blockPrettier.test.ts | 6 +++--- src/blocks/blockPrettier.ts | 8 +++++++- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/src/blocks/blockPrettier.test.ts b/src/blocks/blockPrettier.test.ts index a00a9f37a..6f70caf9a 100644 --- a/src/blocks/blockPrettier.test.ts +++ b/src/blocks/blockPrettier.test.ts @@ -102,7 +102,7 @@ describe("blockPrettier", () => { /lib /pnpm-lock.yaml ", - ".prettierrc.json": "{"$schema":"http://json.schemastore.org/prettierrc","useTabs":true}", + ".prettierrc.json": "{"$schema":"http://json.schemastore.org/prettierrc","overrides":[{"files":["README.md"],"options":{"useTabs":false}}],"useTabs":true}", }, "scripts": [ { @@ -242,7 +242,7 @@ describe("blockPrettier", () => { /lib /pnpm-lock.yaml ", - ".prettierrc.json": "{"$schema":"http://json.schemastore.org/prettierrc","useTabs":true}", + ".prettierrc.json": "{"$schema":"http://json.schemastore.org/prettierrc","overrides":[{"files":["README.md"],"options":{"useTabs":false}}],"useTabs":true}", }, "scripts": [ { @@ -371,7 +371,7 @@ describe("blockPrettier", () => { /pnpm-lock.yaml generated ", - ".prettierrc.json": "{"$schema":"http://json.schemastore.org/prettierrc","overrides":[{"files":".nvmrc","options":{"parser":"yaml"}}],"plugins":["./lib/index.js","prettier-plugin-curly","prettier-plugin-packagejson","prettier-plugin-sh"],"useTabs":true}", + ".prettierrc.json": "{"$schema":"http://json.schemastore.org/prettierrc","overrides":[{"files":".nvmrc","options":{"parser":"yaml"}},{"files":["README.md"],"options":{"useTabs":false}}],"plugins":["./lib/index.js","prettier-plugin-curly","prettier-plugin-packagejson","prettier-plugin-sh"],"useTabs":true}", }, "scripts": [ { diff --git a/src/blocks/blockPrettier.ts b/src/blocks/blockPrettier.ts index ba6e42686..190934c94 100644 --- a/src/blocks/blockPrettier.ts +++ b/src/blocks/blockPrettier.ts @@ -99,7 +99,13 @@ pnpm format --write ), ".prettierrc.json": JSON.stringify({ $schema: "http://json.schemastore.org/prettierrc", - ...(overrides.length && { overrides: overrides.sort() }), + overrides: [ + ...(overrides.length ? overrides.sort() : []), + { + files: ["README.md"], + options: { useTabs: false }, + }, + ], ...(plugins.length && { plugins: plugins.sort() }), useTabs: true, }),