feat: add js-yaml (#199)

remcohaszing · web-flow · commit 70a9345e8ada · 2025-02-27T10:19:29.000Z
This recommends `yaml` over `js-yaml`. Closes #197
diff --git a/docs/modules/README.md b/docs/modules/README.md
@@ -38,6 +38,7 @@ ESLint plugin.
 - [`invariant`](./invariant.md)
 - [`is-builtin-module`](./is-builtin-module.md)
 - [`jQuery`](./jquery.md)
+- [`js-yaml`](./js-yaml.md)
 - [`lint-staged`](./lint-staged.md)
 - [`lodash`, `underscore` and related](./lodash-underscore.md)
 - [`MaterializeCSS`](./materialize-css.md)
diff --git a/docs/modules/js-yaml.md b/docs/modules/js-yaml.md
@@ -0,0 +1,13 @@
+# `js-yaml`
+
+`js-yaml` appears to be no longer maintained. It also parses some YAML incorrectly.
+
+## Alternatives
+
+### `yaml`
+
+`yaml` is a better JavaScript YAML parser. It’s maintained, follows the YAML spec more closely, and has support for more features, such a modifying YAML content.
+
+[Project Page](https://eemeli.org/yaml/)
+
+[npm](https://www.npmjs.com/package/yaml)
diff --git a/manifests/preferred.json b/manifests/preferred.json
@@ -180,6 +180,12 @@
       "docPath": "jquery",
       "category": "preferred"
     },
+    {
+      "type": "documented",
+      "moduleName": "js-yaml",
+      "docPath": "js-yaml",
+      "category": "preferred"
+    },
     {
       "type": "documented",
       "moduleName": "lint-staged",
