Don't modify CHANGELOG.md files when running style:fix; do modify README.md (#68)

steveluscher · web-flow · commit 615ef38027c6 · 2025-01-19T21:48:31.000-08:00
#### Problem

There was disagreement over what `style:fix` does and what the Jest runner in `pnpm dev` does with respect to which files to run Prettier over.

#### Summary of Changes

- Remove `README` from the Jest exclusions
- Add `CHANGELOG` to the `.prettierignore` exclusions.


```shell
find packages -name  .prettierignore \
  -exec sed -i '1i # Changelogs are autogenerated, so leave them alone\nCHANGELOG.md\n' {} +
```
diff --git a/.prettierignore b/.prettierignore
@@ -1,6 +1,9 @@
 .changeset/
 .github/**.md
 
+# These are autogenerated, so leave them alone
+**/CHANGELOG.md
+
 declarations/
 dist/
 doc/
diff --git a/packages/accounts/.prettierignore b/packages/accounts/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/addresses/.prettierignore b/packages/addresses/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/assertions/.prettierignore b/packages/assertions/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/codecs-core/.prettierignore b/packages/codecs-core/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/codecs-data-structures/.prettierignore b/packages/codecs-data-structures/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/codecs-numbers/.prettierignore b/packages/codecs-numbers/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/codecs-strings/.prettierignore b/packages/codecs-strings/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/codecs/.prettierignore b/packages/codecs/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/compat/.prettierignore b/packages/compat/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/crypto-impl/.prettierignore b/packages/crypto-impl/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/errors/.prettierignore b/packages/errors/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/event-target-impl/.prettierignore b/packages/event-target-impl/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/fast-stable-stringify/.prettierignore b/packages/fast-stable-stringify/.prettierignore
@@ -1,2 +1,5 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
 node_modules/
diff --git a/packages/functional/.prettierignore b/packages/functional/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/instructions/.prettierignore b/packages/instructions/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/keys/.prettierignore b/packages/keys/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/library/.prettierignore b/packages/library/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/options/.prettierignore b/packages/options/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/programs/.prettierignore b/packages/programs/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/promises/.prettierignore b/packages/promises/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/react/.prettierignore b/packages/react/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-api/.prettierignore b/packages/rpc-api/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-graphql/.prettierignore b/packages/rpc-graphql/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-parsed-types/.prettierignore b/packages/rpc-parsed-types/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-spec-types/.prettierignore b/packages/rpc-spec-types/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-spec/.prettierignore b/packages/rpc-spec/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-subscriptions-api/.prettierignore b/packages/rpc-subscriptions-api/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-subscriptions-channel-websocket/.prettierignore b/packages/rpc-subscriptions-channel-websocket/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-subscriptions-spec/.prettierignore b/packages/rpc-subscriptions-spec/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-subscriptions/.prettierignore b/packages/rpc-subscriptions/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-transformers/.prettierignore b/packages/rpc-transformers/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-transport-http/.prettierignore b/packages/rpc-transport-http/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc-types/.prettierignore b/packages/rpc-types/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/rpc/.prettierignore b/packages/rpc/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/signers/.prettierignore b/packages/signers/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/subscribable/.prettierignore b/packages/subscribable/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/sysvars/.prettierignore b/packages/sysvars/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/test-config/jest-prettier.config.ts b/packages/test-config/jest-prettier.config.ts
@@ -8,7 +8,7 @@ const config: Partial<Config.InitialProjectOptions> = {
     moduleFileExtensions: ['js', 'ts', 'json', 'md'],
     runner: 'prettier',
     testMatch: ['<rootDir>/src/**', '<rootDir>*'],
-    testPathIgnorePatterns: ['README.md', 'CHANGELOG.md'],
+    testPathIgnorePatterns: ['CHANGELOG.md'],
 };
 
 export default config;
diff --git a/packages/text-encoding-impl/.prettierignore b/packages/text-encoding-impl/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/transaction-confirmation/.prettierignore b/packages/transaction-confirmation/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/transaction-messages/.prettierignore b/packages/transaction-messages/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/transactions/.prettierignore b/packages/transactions/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/webcrypto-ed25519-polyfill/.prettierignore b/packages/webcrypto-ed25519-polyfill/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
diff --git a/packages/ws-impl/.prettierignore b/packages/ws-impl/.prettierignore
@@ -1 +1,4 @@
+# Changelogs are autogenerated, so leave them alone
+CHANGELOG.md
+
 dist/
