组织需要并将它们移动到文档Top

时间:2016-06-21 23:44:51

标签: node.js abstract-syntax-tree jscodeshift

我在应用中组织代码。 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';

1 个答案:

答案 0 :(得分:2)

  

这是一个好的方法,还是有更正确的方法来使用API​​?

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

E.g。映射只是

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