js: Automatically convert _.each to for…of.

This commit was automatically generated by the following script,
followed by lint --fix and a few small manual lint-related cleanups.

import * as babelParser from "recast/parsers/babel";
import * as recast from "recast";
import * as tsParser from "recast/parsers/typescript";
import { builders as b, namedTypes as n } from "ast-types";
import { Context } from "ast-types/lib/path-visitor";
import K from "ast-types/gen/kinds";
import { NodePath } from "ast-types/lib/node-path";
import assert from "assert";
import fs from "fs";
import path from "path";
import process from "process";

const checkExpression = (node: n.Node): node is K.ExpressionKind =>
  n.Expression.check(node);
const checkStatement = (node: n.Node): node is K.StatementKind =>
  n.Statement.check(node);

for (const file of process.argv.slice(2)) {
  console.log("Parsing", file);
  const ast = recast.parse(fs.readFileSync(file, { encoding: "utf8" }), {
    parser: path.extname(file) === ".ts" ? tsParser : babelParser,
  });
  let changed = false;
  let inLoop = false;
  let replaceReturn = false;

  const visitLoop = (...args: string[]) =>
    function(this: Context, path: NodePath) {
      for (const arg of args) {
        this.visit(path.get(arg));
      }
      const old = { inLoop };
      inLoop = true;
      this.visit(path.get("body"));
      inLoop = old.inLoop;
      return false;
    };

  recast.visit(ast, {
    visitDoWhileStatement: visitLoop("test"),

    visitExpressionStatement(path) {
      const { expression, comments } = path.node;
      let valueOnly;
      if (
        n.CallExpression.check(expression) &&
        n.MemberExpression.check(expression.callee) &&
        !expression.callee.computed &&
        n.Identifier.check(expression.callee.object) &&
        expression.callee.object.name === "_" &&
        n.Identifier.check(expression.callee.property) &&
        ["each", "forEach"].includes(expression.callee.property.name) &&
        [2, 3].includes(expression.arguments.length) &&
        checkExpression(expression.arguments[0]) &&
        (n.FunctionExpression.check(expression.arguments[1]) ||
          n.ArrowFunctionExpression.check(expression.arguments[1])) &&
        [1, 2].includes(expression.arguments[1].params.length) &&
        n.Identifier.check(expression.arguments[1].params[0]) &&
        ((valueOnly = expression.arguments[1].params[1] === undefined) ||
          n.Identifier.check(expression.arguments[1].params[1])) &&
        (expression.arguments[2] === undefined ||
          n.ThisExpression.check(expression.arguments[2]))
      ) {
        const old = { inLoop, replaceReturn };
        inLoop = false;
        replaceReturn = true;
        this.visit(
          path
            .get("expression")
            .get("arguments")
            .get(1)
            .get("body")
        );
        inLoop = old.inLoop;
        replaceReturn = old.replaceReturn;

        const [right, { body, params }] = expression.arguments;
        const loop = b.forOfStatement(
          b.variableDeclaration("let", [
            b.variableDeclarator(
              valueOnly ? params[0] : b.arrayPattern([params[1], params[0]])
            ),
          ]),
          valueOnly
            ? right
            : b.callExpression(
                b.memberExpression(right, b.identifier("entries")),
                []
              ),
          checkStatement(body) ? body : b.expressionStatement(body)
        );
        loop.comments = comments;
        path.replace(loop);
        changed = true;
      }
      this.traverse(path);
    },

    visitForStatement: visitLoop("init", "test", "update"),

    visitForInStatement: visitLoop("left", "right"),

    visitForOfStatement: visitLoop("left", "right"),

    visitFunction(path) {
      this.visit(path.get("params"));
      const old = { replaceReturn };
      replaceReturn = false;
      this.visit(path.get("body"));
      replaceReturn = old.replaceReturn;
      return false;
    },

    visitReturnStatement(path) {
      if (replaceReturn) {
        assert(!inLoop); // could use labeled continue if this ever fires
        const { argument, comments } = path.node;
        if (argument === null) {
          const s = b.continueStatement();
          s.comments = comments;
          path.replace(s);
        } else {
          const s = b.expressionStatement(argument);
          s.comments = comments;
          path.replace(s, b.continueStatement());
        }
        return false;
      }
      this.traverse(path);
    },

    visitWhileStatement: visitLoop("test"),
  });

  if (changed) {
    console.log("Writing", file);
    fs.writeFileSync(file, recast.print(ast).code, { encoding: "utf8" });
  }
}

Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
This commit is contained in:
Anders Kaseorg
2020-02-05 21:19:47 -08:00
committed by Tim Abbott
parent 811e128787
commit 02511bff1c
103 changed files with 602 additions and 502 deletions

View File

@@ -93,26 +93,26 @@ exports.unread_pm_counter = (function () {
};
self.set_pms = function (pms) {
_.each(pms, function (obj) {
for (const obj of pms) {
const user_ids_string = obj.sender_id.toString();
self.set_message_ids(user_ids_string, obj.unread_message_ids);
});
}
};
self.set_huddles = function (huddles) {
_.each(huddles, function (obj) {
for (const obj of huddles) {
const user_ids_string = people.pm_lookup_key(obj.user_ids_string);
self.set_message_ids(user_ids_string, obj.unread_message_ids);
});
}
};
self.set_message_ids = function (user_ids_string, unread_message_ids) {
_.each(unread_message_ids, function (msg_id) {
for (const msg_id of unread_message_ids) {
bucketer.add({
bucket_key: user_ids_string,
item_id: msg_id,
});
});
}
};
self.add = function (message) {
@@ -208,15 +208,15 @@ exports.unread_topic_counter = (function () {
self.set_streams = function (objs) {
_.each(objs, function (obj) {
for (const obj of objs) {
const stream_id = obj.stream_id;
const topic = obj.topic;
const unread_message_ids = obj.unread_message_ids;
_.each(unread_message_ids, function (msg_id) {
for (const msg_id of unread_message_ids) {
self.add(stream_id, topic, msg_id);
});
});
}
}
};
self.add = function (stream_id, topic, msg_id) {
@@ -424,9 +424,9 @@ exports.update_unread_topics = function (msg, event) {
};
exports.process_loaded_messages = function (messages) {
_.each(messages, function (message) {
for (const message of messages) {
if (!message.unread) {
return;
continue;
}
unread_messages.add(message.id);
@@ -449,7 +449,7 @@ exports.process_loaded_messages = function (messages) {
if (message.mentioned_me_directly || is_unmuted_mention) {
exports.unread_mentions_counter.add(message.id);
}
});
}
};
exports.mark_as_read = function (message_id) {
@@ -584,18 +584,24 @@ exports.initialize = function () {
exports.unread_pm_counter.set_huddles(unread_msgs.huddles);
exports.unread_pm_counter.set_pms(unread_msgs.pms);
exports.unread_topic_counter.set_streams(unread_msgs.streams);
_.each(unread_msgs.mentions, message_id => exports.unread_mentions_counter.add(message_id));
_.each(unread_msgs.huddles, function (obj) {
_.each(obj.unread_message_ids, message_id => unread_messages.add(message_id));
});
_.each(unread_msgs.pms, function (obj) {
_.each(obj.unread_message_ids, message_id => unread_messages.add(message_id));
});
_.each(unread_msgs.streams, function (obj) {
_.each(obj.unread_message_ids, message_id => unread_messages.add(message_id));
});
_.each(unread_msgs.mentions, message_id => unread_messages.add(message_id));
for (const message_id of unread_msgs.mentions) {
exports.unread_mentions_counter.add(message_id);
}
for (const obj of unread_msgs.huddles) {
for (const message_id of obj.unread_message_ids) {unread_messages.add(message_id);}
}
for (const obj of unread_msgs.pms) {
for (const message_id of obj.unread_message_ids) {unread_messages.add(message_id);}
}
for (const obj of unread_msgs.streams) {
for (const message_id of obj.unread_message_ids) {unread_messages.add(message_id);}
}
for (const message_id of unread_msgs.mentions) {unread_messages.add(message_id);}
};
window.unread = exports;