feat: support lock option (#171)

* feat: support lock option

* add tests

Author: GJZwiers

__snapshots__/writeConfigFile.test.ts.snap

@@ -178,13 +178,20 @@ snapshot[`writeConfigFile 9`] = `
   '      "exclude": []',
   "    }",
   "  },",
+  '  "lock": true,',
   '  "tasks": {},',
   '  "test": {',
   '    "files": {',
   '      "include": [],',
   '      "exclude": []',
   "    }",
   "  },",
+  '  "bench": {',
+  '    "files": {',
+  '      "include": [],',
+  '      "exclude": []',
+  "    }",
+  "  },",
   '  "compilerOptions": {}',
   "}",
 ]
@@ -215,3 +222,11 @@ snapshot[`writeConfigFile 11`] = `
   "}",
 ]
 `;
+
+snapshot[`writeConfigFile 12`] = `
+[
+  "{",
+  '  "lock": true',
+  "}",
+]
+`;

init.ts

@@ -41,6 +41,10 @@ await new Command()
     "-l, --lint [lint:boolean]",
     "Set up config for deno lint only.",
   )
+  .option(
+    "-o, --lock <lock:string>",
+    "The name of the lock file.",
+  )
   .option(
     "-k, --task [task:boolean]",
     "Set up config for deno tasks only. Requires Deno 1.20 or higher",

processOptions.test.ts

@@ -89,6 +89,30 @@ Deno.test("processOptions", async (context) => {
     },
   });
 
+  await test({
+    name: "throw if --yes is used with --bench",
+    fn: () => {
+      testOpts.yes = true;
+      testOpts.bench = true;
+
+      assertThrows(() => {
+        process(testOpts);
+      });
+    },
+  });
+
+  await test({
+    name: "throw if --yes is used with --lock",
+    fn: () => {
+      testOpts.yes = true;
+      testOpts.lock = true;
+
+      assertThrows(() => {
+        process(testOpts);
+      });
+    },
+  });
+
   await test({
     name: "Returns object with map: true if --map option is true",
     fn: () => {

processOptions.ts

@@ -16,15 +16,16 @@ export function process(opts: Options): Options {
   if (opts.yes) {
     if (
       opts.tsconfig || opts.fmt || opts.lint || opts.task || opts.map ||
-      opts.test
+      opts.test || opts.bench || opts.lock
     ) {
       throw new Error("--yes cannot be used together with other options.");
     }
   }
 
   if (
     opts.yes || opts.fill || opts.fmt || opts.lint ||
-    opts.tsconfig || opts.jsonc || opts.task || opts.map || opts.test
+    opts.tsconfig || opts.jsonc || opts.task || opts.map || opts.test ||
+    opts.bench || opts.lock
   ) {
     return { ...defaultOpts, ...opts };
   } else {

writeConfigFile.test.ts

@@ -258,4 +258,22 @@ Deno.test("writeConfigFile", async (context) => {
       await assertSnapshot(context, output.split("\n"));
     },
   });
+
+  await test({
+    name: "create lock",
+    fn: async () => {
+      testOpts.lock = true;
+
+      const output = await inputHandler(testOpts);
+
+      const bytes = await Deno.readFile(
+        `${testOpts.name}`,
+      );
+
+      assert(bytes.length > 0);
+      assertEquals(testOpts.name, "deno.json");
+
+      await assertSnapshot(context, output.split("\n"));
+    },
+  });
 });

writeConfigFile.ts

@@ -8,6 +8,7 @@ export interface Options {
   fmt: boolean;
   jsonc: boolean;
   lint: boolean;
+  lock: boolean;
   map: boolean;
   name: string;
   task: boolean;
@@ -23,6 +24,7 @@ export const defaultOpts: Options = {
   fmt: false,
   jsonc: false,
   lint: false,
+  lock: false,
   map: false,
   name: "deno.json",
   task: false,
@@ -65,6 +67,7 @@ export type ConfigFile = {
     };
   };
   importMap?: string;
+  lock?: boolean;
 };
 
 export async function inputHandler(opts: Options) {
@@ -91,6 +94,8 @@ export async function inputHandler(opts: Options) {
     opts.tsconfig = true;
     opts.task = true;
     opts.test = true;
+    opts.bench = true;
+    opts.lock = true;
   }
 
   if (opts.fmt) {
@@ -120,6 +125,10 @@ export async function inputHandler(opts: Options) {
     configFile.importMap = "import_map.json";
   }
 
+  if (opts.lock) {
+    configFile.lock = true;
+  }
+
   if (opts.task) {
     configFile.tasks = {};
   }