chore: various internal updates

Author: dsherret

.github/workflows/ci.yml

@@ -2,13 +2,13 @@ name: CI
 on: push
 jobs:
   test-library:
-      name: Deno test
-      runs-on: ubuntu-latest
+    name: Deno test
+    runs-on: ubuntu-latest
 
-      steps:
-        - uses: actions/checkout@v2
-        - uses: denolib/setup-deno@v2
-          with:
-            deno-version: v1.7
-        - name: Run tests
-          run: deno test
+    steps:
+      - uses: actions/checkout@v2
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+      - name: Run tests
+        run: deno test

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "deno.enable": true
+  "deno.enable": true,
+  "deno.lint": true
 }

build_npm.ps1

@@ -1 +1 @@
-deno run -A --unstable scripts/build_npm.ts
+deno run --allow-read=./ --allow-write=./npm --unstable scripts/build_npm.ts

comment_char.ts

@@ -1,5 +1,5 @@
 /** @internal */
 export enum CommentChar {
-    Line,
-    Star,
+  Line,
+  Star,
 }

mod.test.ts

@@ -60,7 +60,7 @@ function runTestsForNewLineChar(opts: { newLine: "\r\n" | "\n" }) {
       const expected = "";
 
       doTest(expected, writer => {
-        writer.write(null as any as string);
+        writer.write(null as unknown as string);
       });
     });
 
@@ -736,6 +736,7 @@ test`;
     });
 
     it("should not evaluate the given function when the condition is false", () => {
+      // deno-lint-ignore no-explicit-any
       const test: any = null;
       doTest("", writer => {
         writer.conditionalWrite(false, () => test.test);
@@ -775,6 +776,7 @@ test`;
     });
 
     it("should not evaluate the given function when the condition is false", () => {
+      // deno-lint-ignore no-explicit-any
       const test: any = null;
       doTest("", writer => {
         writer.conditionalWriteLine(false, () => test.test);
@@ -899,6 +901,7 @@ describe("#setIndentationLevel", () => {
 
   it("should throw when not providing a number or string", () => {
     const writer = new CodeBlockWriter();
+    // deno-lint-ignore no-explicit-any
     expect(() => writer.setIndentationLevel({} as any)).to.throw();
   });
 
@@ -1047,6 +1050,7 @@ describe("#queueIndentationLevel", () => {
 
   it("should throw when not providing a number or string", () => {
     const writer = new CodeBlockWriter();
+    // deno-lint-ignore no-explicit-any
     expect(() => writer.queueIndentationLevel({} as any)).to.throw();
   });
 

mod.ts

@@ -475,9 +475,10 @@ export default class CodeBlockWriter {
         }
         this.write("*/");
         break;
-      default:
+      default: {
         const _assertUndefined: undefined = commentChar;
         break;
+      }
     }
 
     return this;

readme.md

@@ -7,22 +7,24 @@
 
 Code writer that assists with formatting and visualizing blocks of JavaScript or TypeScript code.
 
-```
-npm install --save code-block-writer
+With Deno/Browser:
+
+```ts
+import CodeBlockWriter from "https://deno.land/x/code_block_writer/mod.ts";
 ```
 
-Or with Deno:
+Or with Node:
 
-```ts
-import CodeBlockWriter from "https://deno.land/x/[email protected]/mod.ts";
+```
+npm install --save code-block-writer
 ```
 
 ## Example
 
 <!-- dprint-ignore -->
 
 ```typescript
-import CodeBlockWriter from "https://deno.land/x/code_block_writer@x.x.x/mod.ts";
+import CodeBlockWriter from "https://deno.land/x/code_block_writer/mod.ts";
 
 const writer = new CodeBlockWriter({
     // optional options

test_helpers/mocha.ts

@@ -17,7 +17,7 @@ export function it(desc: string, action: () => void) {
 }
 
 function logDesc(desc: string) {
-  console.log(desc.split("\n").map(l => "  ".repeat(indent) + desc).join("\n"));
+  console.log(desc.split("\n").map(l => "  ".repeat(indent) + l).join("\n"));
 }
 
 export function expect<T>(value: T) {
@@ -33,9 +33,9 @@ export function expect<T>(value: T) {
           throw new Error(`FAIL. ${JSON.stringify(value)} did not equal ${JSON.stringify(otherValue)}`);
         }
       },
-      throw(message?: string) {
-        const func = value as any as () => void;
-        let caughtErr: any;
+      throw(_message?: string) {
+        const func = value as unknown as () => void;
+        let caughtErr: unknown;
         try {
           func();
         } catch (err) {
@@ -46,8 +46,8 @@ export function expect<T>(value: T) {
         }
       },
       notThrow() {
-        const func = value as any as () => void;
-        let caughtErr: any;
+        const func = value as unknown as () => void;
+        let caughtErr: unknown;
         try {
           func();
         } catch (err) {

utils/string_utils.test.ts

@@ -2,43 +2,43 @@ import { describe, expect, it } from "../test_helpers/mocha.ts";
 import { escapeChar, escapeForWithinString, getStringFromStrOrFunc } from "./string_utils.ts";
 
 describe("escapeForWithinString", () => {
-    function doTest(input: string, expected: string) {
-        expect(escapeForWithinString(input, "\"")).to.equal(expected);
-    }
+  function doTest(input: string, expected: string) {
+    expect(escapeForWithinString(input, "\"")).to.equal(expected);
+  }
 
-    it("should escape the quotes and newline", () => {
-        doTest(`"testing\n this out"`, `\\"testing\\\n this out\\"`);
-    });
+  it("should escape the quotes and newline", () => {
+    doTest(`"testing\n this out"`, `\\"testing\\\n this out\\"`);
+  });
 });
 
 describe("escapeChar", () => {
-    function doTest(input: string, char: string, expected: string) {
-        expect(escapeChar(input, char)).to.equal(expected);
-    }
+  function doTest(input: string, char: string, expected: string) {
+    expect(escapeChar(input, char)).to.equal(expected);
+  }
 
-    it("should throw when specifying a char length > 1", () => {
-        expect(() => escapeChar("", "ab")).to.throw();
-    });
+  it("should throw when specifying a char length > 1", () => {
+    expect(() => escapeChar("", "ab")).to.throw();
+  });
 
-    it("should throw when specifying a char length < 1", () => {
-        expect(() => escapeChar("", "")).to.throw();
-    });
+  it("should throw when specifying a char length < 1", () => {
+    expect(() => escapeChar("", "")).to.throw();
+  });
 
-    it("should escape the single quotes when specified", () => {
-        doTest(`'testing "this" out'`, `'`, `\\'testing "this" out\\'`);
-    });
+  it("should escape the single quotes when specified", () => {
+    doTest(`'testing "this" out'`, `'`, `\\'testing "this" out\\'`);
+  });
 
-    it("should escape regardless of if the character is already escaped", () => {
-        doTest(`"testing \\"this\\" out"`, `"`, `\\"testing \\\\"this\\\\" out\\"`);
-    });
+  it("should escape regardless of if the character is already escaped", () => {
+    doTest(`"testing \\"this\\" out"`, `"`, `\\"testing \\\\"this\\\\" out\\"`);
+  });
 });
 
 describe("getStringFromStrOrFunc", () => {
-    it("should return a string when given a string", () => {
-        expect(getStringFromStrOrFunc("test")).to.equal("test");
-    });
+  it("should return a string when given a string", () => {
+    expect(getStringFromStrOrFunc("test")).to.equal("test");
+  });
 
-    it("should return a string when given a function", () => {
-        expect(getStringFromStrOrFunc(() => "test")).to.equal("test");
-    });
+  it("should return a string when given a function", () => {
+    expect(getStringFromStrOrFunc(() => "test")).to.equal("test");
+  });
 });