feat(lint-config): remove no-return-await add require-await (#752)

There is no built-in rule or rule plugin that adds more of these best practices. So follow this one for now.

This should improve the stacktrace in async scenarios

Closes #751

packages/cli/scripts/test.js

@@ -69,7 +69,7 @@ async function main(logger) {
       }
     }
 
-    const workers = await initializeWorkers();
+    const workers = initializeWorkers();
     const testResult = await runTests(workers, files);
 
     // Early exit on test failure
@@ -198,9 +198,9 @@ function listTestFiles() {
 /**
  * Create workers and wait till they are initialized.
  *
- * @returns {Promise<Worker[]>}
+ * @returns {Worker[]}
  */
-async function initializeWorkers() {
+function initializeWorkers() {
   const workers = [];
 
   for (let i = 0; i < cpus().length - 1; ++i) {

packages/cli/src/commands/proxy.js

@@ -5,9 +5,9 @@ import proxy from "http-proxy";
 /**
  * @param {Logger} logger
  * @param {UtilCommand} command
- * @returns {Promise<void>}
+ * @returns {void}
  */
-export async function proxyCommand(logger, command) {
+export function proxyCommand(logger, command) {
   const verbose = command.arguments.indexOf("--verbose") !== -1;
   const port = parseInt(
     (environment.API_URL ?? environment.NEXT_PUBLIC_API_URL ?? "")

packages/cli/src/execute.js

@@ -33,7 +33,7 @@ const execCommands = {
  * @param {ScriptCollection} scriptCollection
  * @returns {Promise<void>}
  */
-export async function execute(logger, command, scriptCollection) {
+export function execute(logger, command, scriptCollection) {
   if (command.type === "util") {
     const fn = utilCommands[command.name];
     if (fn) {

packages/cli/src/utils.js

@@ -159,7 +159,7 @@ export function watchOptionsToIgnoredArray(options) {
  * @param commandArgs
  * @param {CliWatchOptions} watchOptions
  */
-export async function executeCommand(
+export function executeCommand(
   logger,
   verbose,
   watch,

packages/code-gen/src/generator/index.js

@@ -37,7 +37,7 @@ import { generateValidatorFile } from "./validator.js";
  * @param {CodeGenStructure} structure
  * @returns {Promise<void>}
  */
-export async function generate(logger, options, structure) {
+export function generate(logger, options, structure) {
   // We can always use '.js' as the import extension and TS will happily resolve to the
   // .ts files Not exactly sure how it all works, but should be good enough for now. The
   // issue when not providing any extension in imports / exports is that TS won't add

packages/code-gen/src/generator/sql/query-basics.js

@@ -51,7 +51,7 @@ function selectQuery(context, imports, type) {
      * @returns {Promise<${type.uniqueName}[]>}
      */
     export async function ${type.name}Select(sql, where) {
-      return query${upperCaseFirst(type.name)}({ where }).exec(sql);
+      return await query${upperCaseFirst(type.name)}({ where }).exec(sql);
     }
   `;
 }
@@ -93,7 +93,7 @@ function deleteQuery(context, imports, type) {
      * @param {${type.uniqueName}Where} [where={}]
      * @returns {Promise<void>}
      */
-    export function ${type.name}Delete${
+    export async function ${type.name}Delete${
     type.queryOptions.withSoftDeletes ? "Permanent" : ""
   }(sql,
                                                                                 where = {}
@@ -103,7 +103,7 @@ function deleteQuery(context, imports, type) {
           ? "where.deletedAtIncludeNotNull = true;"
           : ""
       }
-      return query\`
+      return await query\`
         DELETE FROM "${type.name}" ${type.shortName}
         WHERE $\{${type.name}Where(where)}
         \`.exec(sql);

packages/code-gen/src/generator/sql/query-builder.js

@@ -272,11 +272,10 @@ function queryBuilderForType(context, imports, type) {
                                                type.name,
                                              )}' directly. Please use '.exec' or '.execRaw'."
                                           });
-            }, execRaw: (sql) => qb.exec(sql), exec: (sql) => {
-               return qb.exec(sql).then(result => {
-                  transform${upperCaseFirst(type.name)}(result, builder);
-                  return result;
-               });
+            }, execRaw: async (sql) => await qb.exec(sql), exec: async (sql) => {
+               const result = await qb.exec(sql);
+               transform${upperCaseFirst(type.name)}(result, builder);
+               return result;
             }, get queryPart() {
                return qb;
             }

packages/insight/src/postgres.test.js

@@ -8,7 +8,7 @@ import { postgresTableSizes } from "./postgres.js";
 
 mainTestFn(import.meta);
 
-test("insight/postgres", async (t) => {
+test("insight/postgres", (t) => {
   let sql = undefined;
 
   t.test("create a test db", async (t) => {

packages/lint-config/index.js

@@ -33,13 +33,13 @@ const settings = {
     "default-case-last": "error",
     "no-else-return": "error",
     "no-return-assign": "error",
-    "no-return-await": "error",
     "no-sequences": "error",
     "no-throw-literal": "error",
     "prefer-promise-reject-errors": "error",
     "no-var": "error",
     "prefer-const": "error",
     "prefer-template": "error",
+    "require-await": "error",
 
     // ESLint plugin import
     "import/export": "off",

packages/server/src/app.test.js

@@ -5,7 +5,7 @@ import { closeTestApp, createTestAppAndClient, getApp } from "../index.js";
 
 mainTestFn(import.meta);
 
-test("server/app", async (t) => {
+test("server/app", (t) => {
   const app = getApp();
   const client = Axios.create();
 

packages/server/src/middleware/compose.test.js

@@ -91,7 +91,7 @@ test("Koa Compose", (t) => {
     t.deepEqual(out, ctx2.arr);
   });
 
-  t.test("should only accept an array", async (t) => {
+  t.test("should only accept an array", (t) => {
     try {
       compose();
       t.fail("should throw");
@@ -100,7 +100,7 @@ test("Koa Compose", (t) => {
     }
   });
 
-  t.test("should create next functions that return a Promise", async (t) => {
+  t.test("should create next functions that return a Promise", (t) => {
     const stack = [];
     const arr = [];
     for (let i = 0; i < 5; i++) {
@@ -124,7 +124,7 @@ test("Koa Compose", (t) => {
     }
   });
 
-  t.test("should only accept middleware as functions", async (t) => {
+  t.test("should only accept middleware as functions", (t) => {
     try {
       compose([{}]);
       t.fail("should throw");
@@ -200,7 +200,7 @@ test("Koa Compose", (t) => {
       arr.push(3);
     });
 
-    stack.push(async () => {
+    stack.push(() => {
       arr.push(4);
       throw new Error();
     });
@@ -212,7 +212,7 @@ test("Koa Compose", (t) => {
   t.test("should compose w/ next", async (t) => {
     let called = false;
 
-    await compose([])({}, async () => {
+    await compose([])({}, () => {
       called = true;
     });
     t.ok(called);
@@ -313,7 +313,7 @@ test("Koa Compose", (t) => {
     t.equal(val, 1);
   });
 
-  t.test("should not affect the original middleware array", async (t) => {
+  t.test("should not affect the original middleware array", (t) => {
     const middleware = [];
     const fn1 = (ctx, next) => {
       return next();

packages/server/src/middleware/log.js

@@ -100,7 +100,7 @@ class StreamLength extends Transform {
  * @param ctx
  * @returns {Promise<void>}
  */
-async function bodyCloseOrFinish(ctx) {
+function bodyCloseOrFinish(ctx) {
   return new Promise((resolve) => {
     const onFinish = done.bind(null, "finish");
     const onClose = done.bind(null, "close");

packages/server/src/middleware/session.test.js

@@ -11,7 +11,7 @@ import { session } from "./session.js";
 
 mainTestFn(import.meta);
 
-test("server/session", async (t) => {
+test("server/session", (t) => {
   const app = new Koa();
   const client = Axios.create();
 
@@ -70,7 +70,7 @@ test("server/session", async (t) => {
   });
 });
 
-test("server/session synced cookie", async (t) => {
+test("server/session synced cookie", (t) => {
   const app = new Koa();
   const client = Axios.create();
 

packages/stdlib/src/node.js

@@ -83,7 +83,7 @@ export async function streamToBuffer(stream) {
     return Buffer.from([]);
   }
 
-  return new Promise((resolve, reject) => {
+  return await new Promise((resolve, reject) => {
     const buffers = [];
 
     stream.on("data", function (chunk) {

packages/store/src/file-cache.test.js

@@ -137,7 +137,7 @@ test("store/file-cache", async (t) => {
     );
   });
 
-  t.test("clear file removes from cache", async () => {
+  t.test("clear file removes from cache", () => {
     cache.clear(files.large.id);
   });
 

packages/store/src/file-group.js

@@ -41,7 +41,7 @@ const fileGroupQueries = {
  * @returns {Promise<StoreFileGroup[]>}
  */
 export async function hoistChildrenToParent(sql, fileGroup) {
-  return queries.fileGroupUpdate(
+  return await queries.fileGroupUpdate(
     sql,
     { parent: fileGroup.parent ?? null },
     { parent: fileGroup.id },

packages/store/src/files.js

@@ -96,9 +96,9 @@ export async function getFileStream(
     start = start || 0;
     const size = end === undefined ? 0 : end - start;
 
-    return minio.getPartialObject(bucketName, id, start, size);
+    return await minio.getPartialObject(bucketName, id, start, size);
   }
-  return minio.getObject(bucketName, id);
+  return await minio.getObject(bucketName, id);
 }
 
 /**