fix: check that a replacement is not mapped to itself (#540)

* fix: check that a replacement is not mapped to itself

* feat: add `dottie` to preferred manifest

* update doc

* Update preferred.json

Author: gameroman

docs/modules/dot-prop.md

@@ -20,23 +20,18 @@ setProperty(obj, 'foo.bar.baz', 'value') // [!code --]
 dset(obj, 'foo.bar.baz', 'value') // [!code ++]
 ```
 
-## `object-path`
+## `String.prototype.split` + `Array.prototype.reduce` (native)
 
-[`object-path`](https://github.com/mariocasciaro/object-path) provides get/set/has/delete operations plus array methods like push, insert, and empty.
+If you only need to get a nested value you can use a simple function:
 
-```ts
-import { deleteProperty, getProperty, hasProperty, setProperty } from 'dot-prop' // [!code --]
-import objectPath from 'object-path' // [!code ++]
-
-const value = getProperty(obj, 'foo.bar.baz') // [!code --]
-const value = objectPath.get(obj, 'foo.bar.baz') // [!code ++]
+```js
+function getProperty(obj, key) {
+  return key.split('.').reduce((acc, k) => acc?.[k], obj)
+}
 
-setProperty(obj, 'foo.bar.baz', 'value') // [!code --]
-objectPath.set(obj, 'foo.bar.baz', 'value') // [!code ++]
-
-const exists = hasProperty(obj, 'foo.bar.baz') // [!code --]
-const exists = objectPath.has(obj, 'foo.bar.baz') // [!code ++]
-
-deleteProperty(obj, 'foo.bar.baz') // [!code --]
-objectPath.del(obj, 'foo.bar.baz') // [!code ++]
+const value = getProperty(obj, 'foo.bar.baz')
 ```
+
+> [!NOTE]
+> This assumes that you do not consume dot paths as user input.
+> If you do, ensure you sanitize keys before accessing them (e.g. through `Object.hasOwn`).

manifests/preferred.json

@@ -183,7 +183,7 @@
     "dot-prop": {
       "type": "module",
       "moduleName": "dot-prop",
-      "replacements": ["dlv", "object-path"],
+      "replacements": ["dlv"],
       "url": {"type": "e18e", "id": "dot-prop"}
     },
     "dotenv": {
@@ -192,6 +192,12 @@
       "replacements": ["--env-file"],
       "url": {"type": "e18e", "id": "dotenv"}
     },
+    "dottie": {
+      "type": "module",
+      "moduleName": "dottie",
+      "replacements": ["dlv", "dset"],
+      "url": {"type": "e18e", "id": "dot-prop"}
+    },
     "duplexer": {
       "type": "module",
       "moduleName": "duplexer",
@@ -351,7 +357,7 @@
     "get-value": {
       "type": "module",
       "moduleName": "get-value",
-      "replacements": ["dlv", "object-path"],
+      "replacements": ["dlv"],
       "url": {"type": "e18e", "id": "dot-prop"}
     },
     "glob": {
@@ -2445,7 +2451,7 @@
     "object-path": {
       "type": "module",
       "moduleName": "object-path",
-      "replacements": ["dlv", "object-path"],
+      "replacements": ["dlv", "dset"],
       "url": {"type": "e18e", "id": "dot-prop"}
     },
     "ora": {
@@ -2593,7 +2599,7 @@
     "set-value": {
       "type": "module",
       "moduleName": "set-value",
-      "replacements": ["dlv", "object-path"],
+      "replacements": ["dset"],
       "url": {"type": "e18e", "id": "dot-prop"}
     },
     "shortid": {
@@ -3008,6 +3014,12 @@
       "url": {"type": "e18e", "id": "dot-prop"},
       "replacementModule": "dlv"
     },
+    "dset": {
+      "id": "dset",
+      "type": "documented",
+      "url": {"type": "e18e", "id": "dot-prop"},
+      "replacementModule": "dset"
+    },
     "elysia": {
       "id": "elysia",
       "type": "documented",
@@ -3326,12 +3338,6 @@
       "url": {"type": "e18e", "id": "npm-run-all"},
       "replacementModule": "npm-run-all2"
     },
-    "object-path": {
-      "id": "object-path",
-      "type": "documented",
-      "url": {"type": "e18e", "id": "dot-prop"},
-      "replacementModule": "object-path"
-    },
     "obug": {
       "id": "obug",
       "type": "documented",

scripts/validate-manifests.js

@@ -65,11 +65,20 @@ export async function validateManifests() {
       }
 
       for (const replacementId of mapping.replacements) {
-        if (!manifest.replacements[replacementId]) {
+        const replacement = manifest.replacements[replacementId];
+
+        if (!replacement) {
           throw new Error(
             `${manifestPath}: mapping "${key}" references unknown replacement "${replacementId}"`
           );
         }
+
+        if (replacement.replacementModule === key) {
+          throw new Error(
+            `${manifestPath}: mapping "${key}" defines a replacementModule that is identical to itself.`
+          );
+        }
+
         usedReplacementIds.add(replacementId);
       }
     }