feat: add _generatedBy to package.json for arethetypeswrong (#352)

lib/package_json.test.ts

@@ -81,6 +81,7 @@ Deno.test("single entrypoint", () => {
     scripts: {
       test: "node test_runner.js",
     },
+    _generatedBy: "dnt@dev",
   });
 
   assertEquals(
@@ -114,6 +115,7 @@ Deno.test("single entrypoint", () => {
           },
         },
       },
+      _generatedBy: "dnt@dev",
     },
   );
 
@@ -145,6 +147,7 @@ Deno.test("single entrypoint", () => {
           require: undefined,
         },
       },
+      _generatedBy: "dnt@dev",
     },
   );
 
@@ -167,6 +170,7 @@ Deno.test("single entrypoint", () => {
         "@types/node": versions.nodeTypes,
       },
       scripts: undefined,
+      _generatedBy: "dnt@dev",
     },
   );
 
@@ -196,6 +200,7 @@ Deno.test("single entrypoint", () => {
           require: undefined,
         },
       },
+      _generatedBy: "dnt@dev",
     },
   );
 
@@ -228,6 +233,7 @@ Deno.test("single entrypoint", () => {
           require: undefined,
         },
       },
+      _generatedBy: "dnt@dev",
     },
   );
 });
@@ -348,6 +354,7 @@ Deno.test("multiple entrypoints", () => {
       },
     },
     scripts: undefined,
+    _generatedBy: "dnt@dev",
   });
 });
 
@@ -417,6 +424,7 @@ Deno.test("binary entrypoints", () => {
       },
     },
     scripts: undefined,
+    _generatedBy: "dnt@dev",
   });
 });
 
@@ -505,6 +513,7 @@ Deno.test("peer dependencies", () => {
           "test-dep": "0.1.0",
           "@deno/shim-deno": "~0.1.0",
         },
+        _generatedBy: "dnt@dev",
       },
       null,
       2,

lib/package_json.ts

@@ -3,6 +3,7 @@
 import type { EntryPoint, ShimOptions } from "../mod.ts";
 import { TransformOutput } from "../transform.ts";
 import { PackageJson } from "./types.ts";
+import { getDntVersion } from "./utils.ts";
 
 export interface GetPackageJsonOptions {
   transformOutput: TransformOutput;
@@ -150,6 +151,7 @@ export function getPackageJson({
       peerDependencies,
       devDependencies,
     }),
+    _generatedBy: `dnt@${getDntVersion()}`,
   };
   return sortObject(final);
 
@@ -203,7 +205,12 @@ function sortObject(obj: Record<string, unknown>) {
     "exports",
     "scripts",
   ];
-  const lowPrecedence = ["dependencies", "peerDependencies", "devDependencies"];
+  const lowPrecedence = [
+    "dependencies",
+    "peerDependencies",
+    "devDependencies",
+    "_generatedBy",
+  ];
   const sortedObj: Record<string, unknown> = {};
   const finalEntries: Record<string, unknown> = {};
   for (const key of highPrecedence) {

lib/utils.test.ts

@@ -1,6 +1,6 @@
 import { path } from "./mod.deps.ts";
 import { assertEquals, assertRejects } from "./test.deps.ts";
-import { runCommand, valueToUrl } from "./utils.ts";
+import { getDntVersion, runCommand, valueToUrl } from "./utils.ts";
 
 Deno.test({
   name: "should error when command doesn't exist",
@@ -30,3 +30,12 @@ Deno.test("valueToUrl", () => {
   );
   assertEquals(valueToUrl("file:///test"), "file:///test");
 });
+
+Deno.test("getDntVersion", () => {
+  assertEquals(getDntVersion("https://deno.land/x/dnt@0.1.0/mod.ts"), "0.1.0");
+  assertEquals(
+    getDntVersion("https://deno.land/x/dnt@20.21.22/mod.ts"),
+    "20.21.22",
+  );
+  assertEquals(getDntVersion("file:///test/mod.ts"), "dev");
+});

lib/utils.ts

@@ -103,3 +103,7 @@ export function valueToUrl(value: string) {
     return path.toFileUrl(path.resolve(value)).toString();
   }
 }
+
+export function getDntVersion(url = import.meta.url) {
+  return /\/dnt@([0-9]+\.[0-9]+\.[0-9]+)\//.exec(url)?.[1] ?? "dev";
+}

tests/integration.test.ts

@@ -87,6 +87,7 @@ Deno.test("should build test project - basic", async () => {
         "@deno/shim-deno": versions.denoShim,
         "@deno/sham-weakref": versions.weakRefSham,
       },
+      _generatedBy: "dnt@dev",
     });
     assertEquals(
       output.npmIgnore,
@@ -161,6 +162,7 @@ Deno.test("should build test project without esm", async () => {
         "@deno/shim-deno": versions.denoShim,
         "@deno/sham-weakref": versions.weakRefSham,
       },
+      _generatedBy: "dnt@dev",
     });
     assertEquals(
       output.npmIgnore,
@@ -216,6 +218,7 @@ Deno.test("should build with all options off", async () => {
       devDependencies: {
         "@types/node": versions.nodeTypes,
       },
+      _generatedBy: "dnt@dev",
     });
 
     output.assertNotExists("script/mod.js");
@@ -297,6 +300,7 @@ Deno.test("should build test project with declarations inline by default", async
           picocolors: versions.picocolors,
           "@deno/shim-deno": versions.denoShim,
         },
+        _generatedBy: "dnt@dev",
       });
     });
   }
@@ -333,6 +337,7 @@ Deno.test("should build bin project", async () => {
         picocolors: versions.picocolors,
         "@deno/shim-deno": versions.denoShim,
       },
+      _generatedBy: "dnt@dev",
     });
     const expectedText = "#!/usr/bin/env node\n";
     assertEquals(
@@ -431,6 +436,7 @@ Deno.test("not error for TLA when not using CommonJS", async () => {
         picocolors: versions.picocolors,
         "@deno/shim-deno": versions.denoShim,
       },
+      _generatedBy: "dnt@dev",
     });
   });
 });
@@ -549,6 +555,7 @@ Deno.test("should build with package mappings", async () => {
         picocolors: versions.picocolors,
         "@deno/shim-deno": versions.denoShim,
       },
+      _generatedBy: "dnt@dev",
     });
     assertEquals(
       output.npmIgnore,
@@ -619,6 +626,7 @@ Deno.test("should build with peer dependencies in mappings", async () => {
         picocolors: versions.picocolors,
         "@deno/shim-deno": versions.denoShim,
       },
+      _generatedBy: "dnt@dev",
     });
   });
 });