草庐IT

javascript - 如何使用 ESlint 禁止特定的命名函数

coder 2024-07-18 原文

现状

在我们当前的项目中,我们遇到了一些反复出现的问题,人们使用来自 seamless-immutable 的“asMutable”实际上没有必要的地方。这导致“搜索字符串“asMutable”的项目”成为每个拉取请求的一部分。为了加快速度,我们想在我们的 eslint 中添加一条警告规则。但我还没弄明白怎么办。

问题

虽然我乐于接受建议,但对我来说现在最好的解决方案是允许我指定要禁止的函数名称的规则。 ESlint 或相应的插件是否具有这种功能?

附加说明

我有点想写我们自己的,但我被 AST 吓到了以及编写我的第一条规则的启动难度。如果我找不到更好的答案,我可能会冒险,是的,我们在 PR 中得到了足够多的答案来保证它。不过,这似乎比我聪明得多的人已经解决了,所以我宁愿追随他们的脚步,然后建立自己的。

最佳答案

不久前我遇到了同样的问题,所以我可以帮助您编写自己的问题。

那么,首先,让我们解释一些基本结构:

  1. ESLint插件,每个插件都有规则
  2. ESLint 使用 AST 这是一个语法树 来查找代码中的特定部分。这有助于 ESLint 找到每条规则正在寻找的内容。

那么,让我们开始创建一个带有规则的插件:


1。为 Yeoman 使用 ESLint 生成器

这让事情变得简单多了。 看看here .

安装 yeomanyeoman eslint 生成器 后:

  • 进入您要在其中创建项目的文件夹
  • 运行 yo eslint:plugin 创建一个新的 ESLint 插件
  • 创建插件后,在同一文件夹中运行yo eslint:rule

我使用 suni 作为插件名称,使用 check-as-mutable 作为规则名称。 现在我们有了编写规则所需的所有初始文件。


2。使用 AST Explorer 了解您需要查找的内容

AST Explorer可以帮助我们找到我们正在寻找的类型的东西。这很重要,因此我们可以告诉 ESLint 我们希望函数在代码中的什么地方运行。

当您将代码粘贴到 AST Explorer 时,它会向您显示 ESLint 看到的内容。 我们要针对所有 MemberExpression:

something.asMutable();

在其中,我们希望 Identifier 节点检查函数名称


3。自己写插件

打开 lib/rules/check-as-mutable.js 并检查它。您为 Yeoman 提供的所有数据都用于填写此处的一些字段。

在规则中,您有一个create 属性。在这里,我们编写代码。这个函数应该返回一个对象,我们希望我们的规则作为属性运行。所以,在这种情况下,它看起来像这样:

create: function(context) {

    return {
      MemberExpression: function(node)...

    };
}

在编写规则时,您应该使用 AST Explorer 检查您需要哪些字段。

这里是实现:

create: function(context) {
  var UNWANTED_FUNCTION_NAME = 'asMutable';
  return {
    MemberExpression: function reportUnwantedName(node) {
      var functionName = node.property.name;

      if (functionName === UNWANTED_FUNCTION_NAME) {
        context.report({
          node: node,
          message: [
            'Please don\'t use ',
            UNWANTED_FUNCTION_NAME,
            '. We don\'t like it!'].join('')
        });
      }
    }
  };
}

之后,您需要在您的项目中安装该插件。 为此,将其上传到 GitHub,并使用 npm 安装:

npm install --save-dev <user_name>/<repository_name>

并将规则也包含在您的 .eslintrc 文件中:

{
    'plugins': ['suni'],
    'rules': {
      'suni/check-as-mutable': 1
    }
}

请注意,我给它的值是 1。这使得此规则显示为警告 而不是错误

请注意,警告突出显示了 Immutable 本身,因为它是我们传递给 context.reportnode。您可以调整它以突出显示 id 节点

Here's the plugin I created for this answer

祝你好运!

关于javascript - 如何使用 ESlint 禁止特定的命名函数,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40977713/

有关javascript - 如何使用 ESlint 禁止特定的命名函数的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序,它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重,我想提高压缩级别,因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗?是否有另一个允许指定压缩级别的Ruby库? 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  4. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法? - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  5. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  6. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外,还有什么方法可以访问C和m中的其他内容?我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)?如何在使用完匿名模块后将其删除,使其定义的常量不再存在? 最佳答案 三个答案:是的,使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  7. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封,在我看来soap请求没有正确的命名空间。任何人都可以建议我

  8. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  9. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  10. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

随机推荐