From c0f194c26b0536a6bd74545df4e7990bdf85f074 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=AB=8F=E8=A8=AA=E5=8E=9F=E6=85=B6=E6=96=97?=
 <131525647+suwakei@users.noreply.github.com>
Date: Fri, 12 Sep 2025 02:52:45 +0900
Subject: [PATCH] Increased level of self-documentation of code (#17765)

Co-authored-by: fisker Cheung <lionkay@gmail.com>
---
 cspell.json                             |  1 +
 src/language-json/languages.evaluate.js | 12 +++++++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/cspell.json b/cspell.json
index 5d459210f..4b6326a32 100644
--- a/cspell.json
+++ b/cspell.json
@@ -223,6 +223,7 @@
         "picocolors",
         "Pierzchała",
         "Pieter",
+        "Pipenv",
         "Pipfile",
         "pnpapi",
         "posix",
diff --git a/src/language-json/languages.evaluate.js b/src/language-json/languages.evaluate.js
index e1c372a12..949b686a3 100644
--- a/src/language-json/languages.evaluate.js
+++ b/src/language-json/languages.evaluate.js
@@ -1,15 +1,25 @@
 import * as linguistLanguages from "linguist-languages";
 import createLanguage from "../utils/create-language.js";
 
+// A list of files that are commonly generated by tools and should not be
+// formatted by the default JSON parser to avoid unwanted diffs.
+// These files are either formatted by the `json-stringify` parser or ignored.
 const ignoredFilenames = new Set([
-  // These are generated files, we don't want format them by default
+  // Bazel
   "MODULE.bazel.lock",
+  // Swift
   "Package.resolved",
+  // Pipenv
   "Pipfile.lock",
+  // Bun's text lockfile
   "bun.lock",
+  // Composer
   "composer.lock",
+  // Deno
   "deno.lock",
+  // Nix
   "flake.lock",
+  // Minecraft Forge
   "mcmod.info",
 ]);