使用JavaScript自定义规则进行静态分析？

Question

JSLint，JSHint或其他一些开源静态代码分析工具是否支持添加自定义规则以实现代码合规性，或者我可以使用一些ECMAScript兼容解析器来使结果尽可能接近下面的代码片段中所示的结果。 ？

例如，如果它调用一个库（或智能手机为HTML5小部件提供的API）来注册该API命名空间下的所有内容，那么我想研究一下JavaScript代码并列出要调用的函数，以创建一棵树的对象及其属性，以查看是否从可以追溯到的对象中调用了函数，可能带有XML，JSON或其他结构化格式的输出。

举例来说，我有这个JavaScript代码（它什么也不做，仅出于参数目的）：

jobs = mylibrary.getJobs();
found = jobs.find("Python");
list = found.convert("html");

我希望我的分析器工具能够得到这个：

{
    "mylibrary": {
        "jobs": {"maker":"getJobs", "parent": "mylibrary"},
        "found": {"maker": "find", "parent": "jobs", "parameters": "Python"},
        "list": {"maker": "convert", "parent": "found"}
    }
}

Answer 1

你应该能够建立这样的使用亚组的卷饼 ，它使用从解析器丑化-JS并给出了，我想，你所有你需要的。 快速样本：

src.js：

var jobs, found, list;
jobs = mylibrary.getJobs();
found = jobs.find("Python");
list = found.convert("html");

ast.js：

var fs = require('fs'),
    burrito = require('burrito');

var src = fs.readFileSync('./src.js', 'utf8');

burrito(src, function (node) {
    console.log(node.name, node.value);
});

确切地说，您将如何构建所需的结构，我不太确定（我不太精通AST解析自己），但是我敢肯定，这将需要您付出一些努力。 可以这么说，也许您不需要它们之间的结构，而只需验证burrito中的每个节点，即可针对每个call节点的值（函数名，对象名等）对其进行验证，如果有则发出警告。不验证。

这是上面的burrito调用的输出（注意：每个[Object]或类似[Object]都已被node.js的console.log截断。值实际上是burrito的解析树中的节点，因此每个值都具有其关联状态，等等） 。

var [ [ [ 'jobs' ], [ 'found' ], [ 'list' ] ] ]
stat [ [ { name: 'assign', start: [Object], end: [Object] },
    true,
    [ [Object], 'jobs' ],
    [ [Object], [Object], [] ] ] ]
assign [ true,
  [ { name: 'name', start: [Object], end: [Object] }, 'jobs' ],
  [ { name: 'call', start: [Object], end: [Object] },
    [ 'dot', [Object], 'getJobs' ],
    [] ] ]
name [ 'jobs' ]
call [ [ 'dot', [ 'name', 'mylibrary' ], 'getJobs' ], [] ]
stat [ [ { name: 'assign', start: [Object], end: [Object] },
    true,
    [ [Object], 'found' ],
    [ [Object], [Object], [Object] ] ] ]
assign [ true,
  [ { name: 'name', start: [Object], end: [Object] }, 'found' ],
  [ { name: 'call', start: [Object], end: [Object] },
    [ 'dot', [Object], 'find' ],
    [ [Object] ] ] ]
name [ 'found' ]
call [ [ 'dot', [ 'name', 'jobs' ], 'find' ],
  [ [ [Object], 'Python' ] ] ]
string [ 'Python' ]
stat [ [ { name: 'assign', start: [Object], end: [Object] },
    true,
    [ [Object], 'list' ],
    [ [Object], [Object], [Object] ] ] ]
assign [ true,
  [ { name: 'name', start: [Object], end: [Object] }, 'list' ],
  [ { name: 'call', start: [Object], end: [Object] },
    [ 'dot', [Object], 'convert' ],
    [ [Object] ] ] ]
name [ 'list' ]
call [ [ 'dot', [ 'name', 'found' ], 'convert' ],
  [ [ [Object], 'html' ] ] ]
string [ 'html' ]

更新：

另一个选择是更新的（？）ES解析器Esprima ，它似乎更活跃地被开发并且被更好地记录了。 据报道它也比Uglify快。 您可以在“ 解析演示”页面上尝试解析。 使用方法，您将能够使用此构建好的解决方案。

Answer 2

我尝试使用可以从代码（在我的情况下为python）中访问的javascript解释器进行操作。 因此，像pynoceros ， pynarcissus或pyv8这样的解释器可能会对我有所帮助。

这里有一个关于如何安装py8的答案： https ://stackoverflow.com/a/11879224/1577343

由于使用上述方法并没有取得太大的成功，因此我更喜欢使用兼容ECMAScript的解析器的静态分析解决方案。

通过静态分析，到目前为止，我可以使用JSLINT解析器（ 从chrome或firefox中的调试控制台在.js文件上运行JSLint ）：但是我不知道如何进一步使用它。

{
    "string": "(begin)",
    "first": [
        {
            "string": "var",
            "arity": "statement",
            "first": [
                {
                    "string": "jobs"
                },
                {
                    "string": "found"
                },
                {
                    "string": "list"
                }
            ]
        },
        {
            "string": "=",
            "arity": "infix",
            "first": {
                "string": "jobs"
            },
            "second": {
                "string": "(",
                "arity": "infix",
                "first": {
                    "string": ".",
                    "arity": "infix",
                    "first": {
                        "string": "mylibrary"
                    },
                    "second": {
                        "string": "getJobs"
                    }
                },
                "second": []
            }
        },
        {
            "string": "=",
            "arity": "infix",
            "first": {
                "string": "found"
            },
            "second": {
                "string": "(",
                "arity": "infix",
                "first": {
                    "string": ".",
                    "arity": "infix",
                    "first": {
                        "string": "jobs"
                    },
                    "second": {
                        "string": "find"
                    }
                },
                "second": [
                    {
                        "string": "Python",
                        "arity": "string"
                    }
                ]
            }
        },
        {
            "string": "=",
            "arity": "infix",
            "first": {
                "string": "list"
            },
            "second": {
                "string": "(",
                "arity": "infix",
                "first": {
                    "string": ".",
                    "arity": "infix",
                    "first": {
                        "string": "found"
                    },
                    "second": {
                        "string": "convert"
                    }
                },
                "second": [
                    {
                        "string": "html",
                        "arity": "string"
                    }
                ]
            }
        }
    ]
}

Answer 3

PMD通过自定义规则支持ECMAScript静态分析：

以当前规则集之一为例。 将其复制并粘贴到新文件中，从中删除所有旧规则，然后更改名称和描述。

请注意，您可以自定义各个参考规则。 您可以在自定义规则集中覆盖除规则类之外的所有内容。

您还可以使用排除模式以及可选的覆盖包含模式，将某些文件排除在规则集的处理之外。 当存在匹配的排除模式但没有匹配的包含模式时，文件将从处理中排除。

源文件路径中的路径分隔符被标准化为'/'字符，因此同一规则集可以透明地用于多个平台。

此外，无论使用哪种PMD（例如，命令行，IDE，Ant），此排除/包含技术都可以工作，从而使在整个环境中应用PMD规则保持一致变得更加容易。

您可以指定自定义规则集名称的完整路径以及内置PMD规则集

要在您的IDE中查看它，请将其添加到rulesets / rulesets.properties

参考文献

• pmd / pmd-javascript / src / main / resources / rulesets / ecmascript掌握·pmd / pmd

• 使用PMD Maven分析Javascript

• PMD – PMD属性

• PMD –如何制定规则集

• 结合两个PMD检查

• 在PMD规则中使用正则表达式

• PMD – IDE集成