node.js - 组织需求并将其移至文档顶部

我正在组织应用程序中的代码。 require语句是无组织的，因此我使此codemod对其进行排序并将其添加到页面顶部。

The codemod works，几乎完美。我有些疑惑：


这是好的方法，还是有使用API​​的更正确方法？
如何在sourceStart（所有要求）和其余源代码之间保持空白？
ES6导入中可以使用类似的方法吗？ （即使用jscodeshift对它们进行排序）


我的初始代码：

var path = require('path');
var stylus = require('stylus');
var express = require('express');
var router = express.Router();
var async = require('async');

let restOfCode = 'foo';

我的codemod：

let requires = j(file.source).find(j.CallExpression, {
    "callee": {
        "name": "require"
    }
}).closest(j.VariableDeclarator);

let sortedNames = requires.__paths.map(node => node.node.id.name).sort(sort); // ["async", "express", "path", "stylus"]
let sortedRequires = [];
requires.forEach(r => {
    let index = sortedNames.indexOf(r.node.id.name);
    sortedRequires[index] = j(r).closest(j.VariableDeclaration).__paths[0]; // <- feels like a hack
});

let sourceStart = j(sortedRequires).toSource();
let sourceRest = j(file.source).find(j.CallExpression, {
    "callee": {
        "name": "require"
    }
}).closest(j.VariableDeclaration)
.replaceWith((vD, i) => {
    // return nothing, it will be replaced on top of document
})
.toSource();

return sourceStart.concat(sourceRest).join('\n'); // is there a better way than [].concat(string).join(newLine) ?

结果是：

var async = require('async');
var express = require('express');
var path = require('path');
var stylus = require('stylus');
var router = express.Router(); // <- I would expect a empty line before this one

let restOfCode = 'foo';

最佳答案

这是好的方法，还是有使用API​​的更正确方法？


您不应该直接访问__paths。如果需要访问所有NodePath，则可以使用.paths()方法。如果要访问AST节点，请使用.nodes()。

例如。映射将是

let sortedNames = requires.nodes()(node => node.id.name).sort(sort);

  如何在sourceStart（所有要求）和其余源代码之间保持空白？


确实没有一个很好的方法来执行此操作。请参见this related recast issue。希望有一天，通过CST，这将变得更加容易。


  ES6导入中可以使用类似的方法吗？ （即使用jscodeshift对它们进行排序）


当然。



FWIW，这是我的版本（根据您的第一个版本）：

export default function transformer(file, api) {
    const j = api.jscodeshift;
    const sort = (a, b) => a.declarations[0].id.name.localeCompare(
        b.declarations[0].id.name
    );

    const root = j(file.source);
    const requires = root
      .find(j.CallExpression, {"callee": {"name": "require"}})
      .closest(j.VariableDeclaration);
    const sortedRequires = requires.nodes().sort(sort);

    requires.remove();

    return root
      .find(j.Statement)
      .at(0)
      .insertBefore(sortedRequires)
      .toSource();
    };
}

https://astexplorer.net/#/i8v3GBENZ7