rspec-graphql_matchers 项目教程

rspec-graphql_matchers 项目教程

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

rspec-graphql_matchers/
├── bin/
├── lib/
│   └── rspec/
│       └── graphql_matchers/
├── spec/
├── .codeclimate.yml
├── .editorconfig
├── .gitignore
├── .rspec
├── .rubocop.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── rspec-graphql_matchers.gemspec

• bin/: 包含可执行文件。
• lib/: 包含项目的核心代码，特别是 rspec/graphql_matchers/ 目录下包含了所有的匹配器实现。
• spec/: 包含测试文件。
• .codeclimate.yml: CodeClimate 配置文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .rspec: RSpec 配置文件。
• .rubocop.yml: RuboCop 配置文件。
• CHANGELOG.md: 变更日志。
• CODE_OF_CONDUCT.md: 行为准则。
• Gemfile: 依赖管理文件。
• LICENSE.txt: 许可证文件。
• README.md: 项目说明文档。
• Rakefile: Rake 任务配置文件。
• rspec-graphql_matchers.gemspec: 项目 gem 的规范文件。

2. 项目的启动文件介绍

项目的主要启动文件是 rspec-graphql_matchers.gemspec，它定义了 gem 的元数据和依赖关系。以下是该文件的部分内容：

Gem::Specification.new do |spec|
  spec.name          = "rspec-graphql_matchers"
  spec.version       = "0.2.0"
  spec.authors       = ["Samuel Brandão"]
  spec.email         = ["samuel.brandao@example.com"]
  spec.summary       = %q{Collection of rspec matchers to test your graphQL api schema}
  spec.description   = %q{Convenient rspec matchers for testing your graphql-ruby API/Schema}
  spec.homepage      = "https://github.com/khamusa/rspec-graphql_matchers"
  spec.license       = "MIT"

  spec.files         = `git ls-files -z`.split("\x0")
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_dependency "graphql", "< 1", ">= 0.9"
  spec.add_development_dependency "bundler", "~> 1.12"
  spec.add_development_dependency "pry", "~> 0"
  spec.add_development_dependency "rspec", "~> 3.0"
  spec.add_development_dependency "rubocop", "~> 0"
end

3. 项目的配置文件介绍

• .rspec: 该文件包含 RSpec 的默认配置选项，例如是否显示颜色和格式。
• .rubocop.yml: 该文件定义了 RuboCop 的代码风格和检查规则。
• Gemfile: 该文件定义了项目的依赖关系，包括运行时依赖和开发依赖。
• rspec-graphql_matchers.gemspec: 该文件定义了 gem 的元数据和依赖关系，是项目的主要配置文件之一。

以上是 rspec-graphql_matchers 项目的基本教程，涵盖了目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。