chore: add @stylistic/eslint-plugin (#66)

Our current linter is IMO way too loose, causing us to have inconsistent
JS styles across the repo. Let's make it tighter.

Author: aduh95

eslint.config.js

@@ -1,9 +1,16 @@
 import js from "@eslint/js";
 import tsPlugin from "typescript-eslint";
+import stylistic from "@stylistic/eslint-plugin";
 
 export default [
   js.configs.recommended,
   ...tsPlugin.configs.recommended,
+  stylistic.configs.customize({
+    braceStyle: "1tbs",
+    quotes: "double",
+    quoteProps: "as-needed",
+    semi: true,
+  }),
   {
     files: ["**/*.ts"],
     languageOptions: {
@@ -15,6 +22,7 @@ export default [
     },
     plugins: {
       "@typescript-eslint": tsPlugin.plugin,
+      "@stylistic": stylistic,
     },
   },
   { ignores: ["node_modules/", "**/dist/"] },

package.json

@@ -9,6 +9,7 @@
     "url": "https://github.com/nodejs/caritat.git"
   },
   "devDependencies": {
+    "@stylistic/eslint-plugin": "^4.4.1",
     "@types/eslint": "^9",
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^20.0.0",

packages/cli/src/bin/countBallotsFromGit.ts

@@ -22,8 +22,8 @@ const parsedArgs = await parseArgs().options({
 
 const { repo: repoURL, branch, path: subPath } = parsedArgs;
 
-const privateKey =
-  parsedArgs.key === "-"
+const privateKey
+  = parsedArgs.key === "-"
     ? await readStdIn(false)
     : parsedArgs.key && (await fs.readFile(parsedArgs.key as string));
 

packages/cli/src/bin/countBallotsFromGitHub.ts

@@ -19,9 +19,9 @@ const parsedArgs = await parseArgs()
 
     protocol: {
       describe:
-        "the protocol to use to pull the remote repository, either SSH or " +
-        "HTTP (defaults to SSH if a public SSH key is found for the current " +
-        "user, otherwise default to HTTP)",
+        "the protocol to use to pull the remote repository, either SSH or "
+        + "HTTP (defaults to SSH if a public SSH key is found for the current "
+        + "user, otherwise default to HTTP)",
       string: true,
     },
     login: {
@@ -50,8 +50,8 @@ const parsedArgs = await parseArgs()
     ["key-part"]: {
       ...cliArgs["key-part"],
       describe:
-        cliArgs["key-part"].describe +
-        " If not provided, it will be extracted from the PR comments.",
+        cliArgs["key-part"].describe
+        + " If not provided, it will be extracted from the PR comments.",
     },
   })
   .command(
@@ -63,16 +63,16 @@ const parsedArgs = await parseArgs()
         type: "string",
         describe: "URL to the GitHub pull request",
       });
-    }
+    },
   ).argv;
 
-const privateKey =
-  parsedArgs.key === "-"
+const privateKey
+  = parsedArgs.key === "-"
     ? await readStdIn(false)
     : parsedArgs.key && (await fs.readFile(parsedArgs.key));
 
 const prUrlInfo = /^https:\/\/github\.com\/([^/]+)\/([^/]+)\/pull\/(\d+)$/.exec(
-  parsedArgs["pr-url"] as string
+  parsedArgs["pr-url"] as string,
 );
 
 if (prUrlInfo == null) {
@@ -81,7 +81,7 @@ if (prUrlInfo == null) {
 
 const [, owner, repo, prNumber] = prUrlInfo;
 console.warn(
-  `Looking into GitHub pull request ${owner}/${repo}#${prNumber}...`
+  `Looking into GitHub pull request ${owner}/${repo}#${prNumber}...`,
 );
 
 const query = `query PR($prid: Int!, $owner: String!, $repo: String!) {
@@ -126,8 +126,8 @@ const { data } = JSON.parse(
       "-f",
       `query=${query}`,
     ],
-    { captureStdout: true }
-  )
+    { captureStdout: true },
+  ),
 );
 
 const { pullRequest } = data.repository;
@@ -154,31 +154,31 @@ const files = await runChildProcessAsync(
     "--jq",
     ".files.[] | .filename",
   ],
-  { captureStdout: true }
+  { captureStdout: true },
 );
 
 const voteFileCanonicalName = "vote.yml";
 const subPath = files
   .split("\n")
   .find(
-    (path) =>
-      path === voteFileCanonicalName ||
-      path.endsWith(`/${voteFileCanonicalName}`)
+    path =>
+      path === voteFileCanonicalName
+      || path.endsWith(`/${voteFileCanonicalName}`),
   )
   ?.slice(0, -voteFileCanonicalName.length);
 
 const handle = parsedArgs.login || data.viewer.login;
 
-const protocol =
-  parsedArgs.protocol ?? (data.viewer.publicKeys.totalCount ? "ssh" : "http");
+const protocol
+  = parsedArgs.protocol ?? (data.viewer.publicKeys.totalCount ? "ssh" : "http");
 
 function getHTTPRepoURL(repoURL: string, login: string) {
   const url = new URL(repoURL + ".git");
   url.username = login;
   return url.toString();
 }
-const repoURL =
-  protocol === "ssh"
+const repoURL
+  = protocol === "ssh"
     ? data.repository.sshUrl
     : getHTTPRepoURL(data.repository.url, handle);
 
@@ -191,14 +191,14 @@ console.warn("All relevant information has been retrieved:", {
 });
 
 async function getKeyPartsFromComments() {
-  const shamirKeyPartComment =
-    /\n-----BEGIN SHAMIR KEY PART-----\n([a-zA-Z0-9+/\s]+={0,2})\n-----END SHAMIR KEY PART-----\n/;
+  const shamirKeyPartComment
+    = /\n-----BEGIN SHAMIR KEY PART-----\n([a-zA-Z0-9+/\s]+={0,2})\n-----END SHAMIR KEY PART-----\n/;
   const { comments } = JSON.parse(
     await runChildProcessAsync(
       parsedArgs["gh-binary"] as string,
       ["pr", "view", parsedArgs["pr-url"], "--json", "comments"],
-      { captureStdout: true }
-    )
+      { captureStdout: true },
+    ),
   );
 
   const results = [];
@@ -237,12 +237,12 @@ if (parsedArgs["post-comment"]) {
   ]);
 } else {
   console.log(
-    "To publish the results, you should use `--post-comment --commit-json-summary` CLI flags."
+    "To publish the results, you should use `--post-comment --commit-json-summary` CLI flags.",
   );
   console.log(
     "Participation:",
     Math.round(summary.participation * 100_00) / 1_00,
-    "%"
+    "%",
   );
   console.log("Raw results:", summary.result);
 }

packages/cli/src/bin/decryptBallot.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import fs from "fs";
- 
+
 import parseArgs from "../utils/parseArgs.js";
 import decryptData from "@node-core/caritat-crypto/decrypt";
 
@@ -25,7 +25,7 @@ const parsedArgs = await parseArgs().options({
 const { data: filePath, key: privateKeyPath } = parsedArgs;
 
 const { encryptedSecret, data } = JSON.parse(
-  fs.readFileSync(filePath, "utf8").replace(/^\uFEFF/, "")
+  fs.readFileSync(filePath, "utf8").replace(/^\uFEFF/, ""),
 );
 
 console.log(
@@ -34,8 +34,8 @@ console.log(
       await decryptData(
         Buffer.from(data, "base64"),
         Buffer.from(encryptedSecret, "base64"),
-        fs.readFileSync(privateKeyPath)
-      )
-    )
-  ).toString("utf8")
+        fs.readFileSync(privateKeyPath),
+      ),
+    ),
+  ).toString("utf8"),
 );

packages/cli/src/bin/decryptKeyPart.ts

@@ -19,19 +19,19 @@ if (argv[2] === "-h" || argv[2] === "--help") {
   console.log("decryptKeyPath < path/to/vote.yml");
   console.log("curl -L http://example.com/vote.yml | decryptKeyPath | base64");
   console.log(
-    "decryptKeyPath https://github.com/owner/repo/pull/1 # requires gh CLI tool"
+    "decryptKeyPath https://github.com/owner/repo/pull/1 # requires gh CLI tool",
   );
   console.log(
-    "decryptKeyPath https://github.com/owner/repo/pull/1 --post-comment # requires gh CLI tool"
+    "decryptKeyPath https://github.com/owner/repo/pull/1 --post-comment # requires gh CLI tool",
   );
   console.log(
-    "Upon success, this tool will output to stdout a base64 representation of the decrypted key part."
+    "Upon success, this tool will output to stdout a base64 representation of the decrypted key part.",
   );
   exit(0);
 } else if (argv[2]) {
-  //github.com/stduhpf/pleaseignore/raw/15f8e6ae5d2c417d7bc68ec1ea6db35d00cc263c/voteTest/nodejstest/vote.yml
-  const gh_PR_URL =
-    /^https?:\/\/github.com\/([^/]+)\/([^/]+)\/pull\/(\d+)/.exec(argv[2]);
+  // github.com/stduhpf/pleaseignore/raw/15f8e6ae5d2c417d7bc68ec1ea6db35d00cc263c/voteTest/nodejstest/vote.yml
+  const gh_PR_URL
+    = /^https?:\/\/github.com\/([^/]+)\/([^/]+)\/pull\/(\d+)/.exec(argv[2]);
   if (gh_PR_URL == null) throw new Error("Invalid PR URL format");
   const [, owner, repo, prId] = gh_PR_URL;
   const filesData = JSON.parse(
@@ -43,16 +43,16 @@ if (argv[2] === "-h" || argv[2] === "--help") {
         "Accept: application/vnd.github+json",
         `/repos/${owner}/${repo}/pulls/${prId}/files`,
       ],
-      { captureStdout: true }
-    )
+      { captureStdout: true },
+    ),
   );
   const { contents_url } = filesData.find(({ filename }) =>
-    /(^|\/)vote.yml$/.test(filename)
+    /(^|\/)vote.yml$/.test(filename),
   );
   yamlString = await runChildProcessAsync(
     env.GH_BIN || "gh",
     ["api", "-H", "Accept: application/vnd.github.raw", contents_url],
-    { captureStdout: true }
+    { captureStdout: true },
   );
 } else {
   yamlString = (await stdin.toArray()).join();
@@ -72,11 +72,11 @@ const out = await Promise.any(
     cp.stdin.end(share);
     const [code] = await Promise.race([
       once(cp, "exit"),
-      once(cp, "error").then((er) => Promise.reject(er)),
+      once(cp, "error").then(er => Promise.reject(er)),
     ]);
     if (code !== 0) throw new Error("failed", { cause: code });
     return Buffer.concat(await stdout);
-  })
+  }),
 );
 ac.abort();
 
@@ -86,10 +86,10 @@ if (argv[3] === "--post-comment") {
     "comment",
     argv[2],
     "-b",
-    `I would like to close this vote, and for this effect, I'm revealing my ` +
-      `key part:\n\n${"```"}\n-----BEGIN SHAMIR KEY PART-----\n${out.toString(
-        "base64"
-      )}\n-----END SHAMIR KEY PART-----\n${"```"}\n`,
+    `I would like to close this vote, and for this effect, I'm revealing my `
+    + `key part:\n\n${"```"}\n-----BEGIN SHAMIR KEY PART-----\n${out.toString(
+      "base64",
+    )}\n-----END SHAMIR KEY PART-----\n${"```"}\n`,
   ]);
 } else {
   stdout.write(out);

packages/cli/src/bin/encryptBallot.ts

@@ -24,12 +24,12 @@ const { file: filePath, key: publicKeyPath } = parsedArgs;
 
 const { encryptedSecret, saltedCiphertext } = await encryptData(
   fs.readFileSync(filePath),
-  fs.readFileSync(publicKeyPath)
+  fs.readFileSync(publicKeyPath),
 );
 
 console.log(
   JSON.stringify({
     encryptedSecret: Buffer.from(encryptedSecret).toString("base64"),
     data: Buffer.from(saltedCiphertext).toString("base64"),
-  })
+  }),
 );

packages/cli/src/bin/extractEncryptedPrivateKey.ts

@@ -18,7 +18,7 @@ if (yamlFile === "--help" || yamlFile === "-h") {
   console.log("Usage: extractEncryptedPrivateKey <path-to-YAML-file>");
   console.log("or");
   console.log(
-    "Usage: echo 'encryptedPrivateKey: …' | extractEncryptedPrivateKey"
+    "Usage: echo 'encryptedPrivateKey: …' | extractEncryptedPrivateKey",
   );
   process.exit();
 } else if (yamlFile == null) {

packages/cli/src/bin/generateNewVoteFolder.ts

@@ -104,8 +104,8 @@ const parsedArgs = await parseArgs().options({
 
 async function getCommitAuthor() {
   if (
-    (parsedArgs.username && !parsedArgs.email) ||
-    (!parsedArgs.username && parsedArgs.email)
+    (parsedArgs.username && !parsedArgs.email)
+    || (!parsedArgs.username && parsedArgs.email)
   ) {
     const { emailAddress, username } = await getEnv(parsedArgs);
     return `${username} <${emailAddress}>`;
@@ -125,8 +125,8 @@ await generateNewVoteFolder({
     const chars = await once(stdin, "data");
     stdin.pause();
     if (
-      chars[0][0] === 0x6e || // n
-      chars[0][0] === 0x4e // N
+      chars[0][0] === 0x6e // n
+      || chars[0][0] === 0x4e // N
     ) {
       console.log("Vote template file is ready for edit.");
       return true;