arguard

？ Arguard

GO的Linter检查对功能警卫（又称合同）的静态调用参数。

例子

假设您有以下功能：

 func div ( n , d float64 ) float64 {
  if d == 0 {
    panic ( "denominator must not be zero" )
  }
  return n / d
}

然后您这样称呼：

 div ( userInput , 0. )

即使我们不知道userInput ，我们也可以看到此函数调用在运行时会感到恐慌，因为第二个参数始终为零。

Linter使用安全的部分代码执行和黑魔法找到并报告了这些地方。

？安装

go install github.com/orsinium-labs/arguard@latest

用法

arguard ./...

可用标志：

• -contracts.follow-imports ：将此标志设置为False以不从导入的模块中提取合同。换句话说，只有在合同和功能调用的功能位于同一分析的软件包中，才会报告合同（警卫）违规行为。对于更好的性能很有用。
• -contracts.report-contracts ：为每个检测到的合同发出一条消息。可用于调试，以查看林格是否检测到合同。
• -arguard.report-errors ：设置此标志以显示合同执行期间的失败。默认情况下，如果Arguard未能执行合同，则仅在没有报告任何内容的情况下继续前进。对于调试，了解为什么未报告合同错误。

？ QNA

1. ？它如何工作？里面有两个分析仪。第一个检测到法规中的安全执行合同（警卫）。第二个检测到具有已知合同的功能的调用，提取静态已知的参数，并执行可以使用Yaegi执行的合同。
2. ？什么是警卫（合同）？在功能开头的条件（只有其他合同才能在其之前进行），并进行安全检查，并且身体只返回错误或呼叫panic 。
3. ？结果有多可靠？如果报告错误，很可能有错误。如果没有报告错误，可能仍然存在错误。这是衬里，而不是正式的验证者。
4. ⚖️项目有多稳定？ GO中的静态分析可能会很混乱，尤其是当我们也进行部分代码执行时。 Linter可能会失败，错误或不像可能的那样聪明。尽管如此，它还是静态分析仪，而不是生产依赖性，因此在任何环境中的任何项目都可以安全地使用它。但是请记住，仍然存在部分代码执行，因此您可能不应该在不受信任的代码上运行它，只是为了安全起见。
5. ？会发生破坏吗？该项目遵循Semver。但是，每个版本，甚至是补丁程序，都可以开始报告代码中的新违规行为。因此，从某种意义上说，每个版本都可能破裂。
6. ？是否有Golangci-lint集成？还没有，但最终会。将任何分析供电的衬里与Golangci-lint集成在一起很容易，并且Arguard是由分析驱动的。敬请关注。
7. ✏️是否有IDE集成？还没有。当我们拥有Golangci-lint集成时，IDE集成将免费出现。
8. ？这是一个新主意吗？该项目实现了交易的一件事，我的合同设计图书馆可以做到。交易本身是建立在世代智慧之上的，请参阅此时间表。
9. 有没有GO API，以便我可以将其用作库？是的。分析软件包提供了一种本机组成分析仪的方式，这就是您可以使用该项目的方式。有关如何创建和组成多个analysis.Analyzer示例，请参见Main.Go。
10. ？‍？积极维护吗？该项目以Unixway的最佳传统具有很小且明确定义的范围。我可能会不时回到它，并带来我在不眠之夜期间提出的新有趣的想法，但是每天都没有维护。如果今天起作用，明天就不会破裂，这要归功于依赖关系的简短清单和GO 1兼容性承诺。
11. ？如果我发现一个错误怎么办？分叉项目，修复错误，编写一些测试，然后打开拉动请求。我通常在一天之内合并并发布任何贡献。