Querly 开源项目使用教程

Querly 开源项目使用教程

querlyQuery Method Calls from Ruby Programs项目地址:https://gitcode.com/gh_mirrors/qu/querly

1. 项目的目录结构及介绍

Querly 项目的目录结构如下：

querly/
├── bin/
│   └── querly
├── lib/
│   ├── querly
│   │   ├── cli.rb
│   │   ├── command.rb
│   │   ├── config.rb
│   │   ├── pattern.rb
│   │   ├── rule.rb
│   │   ├── script.rb
│   │   ├── util.rb
│   │   └── version.rb
│   └── querly.rb
├── spec/
│   ├── cli_spec.rb
│   ├── command_spec.rb
│   ├── config_spec.rb
│   ├── pattern_spec.rb
│   ├── rule_spec.rb
│   ├── script_spec.rb
│   └── util_spec.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── querly.gemspec
├── README.md
└── Rakefile

目录结构介绍

• bin/: 包含可执行文件 querly。
• lib/: 包含项目的核心代码。
  • querly/: 包含主要的 Ruby 文件。
    • cli.rb: 命令行接口。
    • command.rb: 命令处理。
    • config.rb: 配置文件处理。
    • pattern.rb: 模式匹配。
    • rule.rb: 规则定义。
    • script.rb: 脚本处理。
    • util.rb: 工具函数。
    • version.rb: 版本信息。
  • querly.rb: 主入口文件。
• spec/: 包含测试文件。
• .gitignore: Git 忽略文件。
• .rspec: RSpec 配置文件。
• .travis.yml: Travis CI 配置文件。
• Gemfile: Ruby 依赖管理文件。
• Gemfile.lock: 依赖锁定文件。
• LICENSE.txt: 许可证文件。
• querly.gemspec: Gem 规范文件。
• README.md: 项目说明文档。
• Rakefile: Rake 任务文件。

2. 项目的启动文件介绍

Querly 项目的启动文件是 bin/querly。这个文件是一个可执行的 Ruby 脚本，用于启动 Querly 工具。

#!/usr/bin/env ruby

require "querly"

Querly::CLI.start(ARGV)

启动文件介绍

• #!/usr/bin/env ruby: 指定使用 Ruby 解释器。
• require "querly": 加载 Querly 库。
• Querly::CLI.start(ARGV): 启动命令行接口，处理用户输入的命令。

3. 项目的配置文件介绍

Querly 项目的配置文件是 querly.yml。这个文件定义了 Querly 的规则和模式。

配置文件示例

rules:
  - id: example_rule
    pattern: "send(:raise, _)"
    message: "Avoid using raise"
    examples:
      - match: "send(:raise, RuntimeError.new('error'))"
        message: "This line raises an exception"

配置文件介绍

• rules: 定义规则列表。
  • id: 规则的唯一标识。
  • pattern: 匹配模式。
  • message: 匹配到模式时的提示信息。
  • examples: 示例列表。
    • match: 匹配的代码示例。
    • message: 示例的提示信息。

通过以上内容，您可以了解 Querly 项目的目录结构、启动文件和配置文件的基本信息，从而更好地使用和配置 Querly 工具。

querlyQuery Method Calls from Ruby Programs项目地址:https://gitcode.com/gh_mirrors/qu/querly