Add normalize-yaml package to normalize YAML consistently

[aduth]

Supersedes #5028

Like #5028, this resolves an issue where running make normalize_yaml can produce local changes due to differences in how the YAML is formatted, and due to lack of support for comments in the current YAML normalizing scripts.

Compared to #5028, this approach implements normalization using a new internal Yarn package, with the benefit of:

• Supporting comments in YAML files
• Being ~2x faster
• Being self-contained, as opposed to 3 separate tasks: sorting keys via i18n-tasks normalize, formatting content via scripts/normalize-yaml, and normalizing output via prettier

For review, consider the commit in isolation: 0143506

[zachmargolis]

LGTM

[zachmargolis]

is there anything we can do that marks this as "please don't import me into the browser, I'm just meant for development"?

[aduth]

is there anything we can do that marks this as "please don't import me into the browser, I'm just meant for development"?

It's not something I've seen. Usually it's a judgment call from the consumer, and bundlers would often go out of their way to support packages written for a Node setting to be bundled for a browser (e.g. Webpack). This package could run in a browser, AFAICT, even if the bundle size would be pretty large. If we really wanted to, we could set a browser property here that points to a no-op, but I don't really think it's necessary.

[aduth]

Toyed with supporting piped input to avoid the multi-step make update_country_dialing_codes. Works, but keeping as-is since it's a bit simpler.

diff --git a/Makefile b/Makefile
index b9edbdcc9..61c96ae61 100644
--- a/Makefile
+++ b/Makefile
@@ -87,8 +87,7 @@ lint_optimized_assets: optimize_assets
 	(! git diff --name-only | grep "\.svg$$") || (echo "Error: Optimize assets using 'make optimize_assets'"; exit 1)
 
 update_country_dialing_codes:
-	bundle exec ./scripts/pinpoint-supported-countries > config/country_dialing_codes.yml
-	yarn normalize-yaml config/country_dialing_codes.yml
+	bundle exec ./scripts/pinpoint-supported-countries | yarn run --silent normalize-yaml > config/country_dialing_codes.yml
 
 check_asset_strings:
 	find ./app/javascript -name "*.js*" | xargs ./scripts/check-assets
diff --git a/app/javascript/packages/normalize-yaml/cli.js b/app/javascript/packages/normalize-yaml/cli.js
index 9c67362d4..8b0afbb2a 100755
--- a/app/javascript/packages/normalize-yaml/cli.js
+++ b/app/javascript/packages/normalize-yaml/cli.js
@@ -4,16 +4,26 @@ import { join } from 'path';
 import prettier from 'prettier';
 import normalize from './index.js';
 
-const { readFile, writeFile } = fsPromises;
-
 /** @type {Record<string,any>=} */
 const prettierConfig = prettier.resolveConfig.sync(process.cwd());
 
-const files = process.argv.slice(2);
-Promise.all(
-  files.map(async (relativePath) => {
-    const absolutePath = join(process.cwd(), relativePath);
-    const content = await readFile(absolutePath, 'utf8');
-    await writeFile(absolutePath, normalize(content, prettierConfig));
-  }),
-);
+if (process.stdin.isTTY) {
+  const { readFile, writeFile } = fsPromises;
+  const files = process.argv.slice(2);
+  Promise.all(
+    files.map(async (relativePath) => {
+      const absolutePath = join(process.cwd(), relativePath);
+      const content = await readFile(absolutePath, 'utf8');
+      await writeFile(absolutePath, normalize(content, prettierConfig));
+    }),
+  );
+} else {
+  (async () => {
+    let content = '';
+    for await (const chunk of process.stdin) {
+      content += chunk.toString();
+    }
+
+    process.stdout.write(normalize(content, prettierConfig));
+  })();
+}