Sandi Meter 项目教程
1. 项目的目录结构及介绍
sandi_meter/
├── LICENSE
├── README.md
├── Rakefile
├── sandi_meter.gemspec
├── bin/
│ └── sandi_meter
├── html/
│ └── ...
├── lib/
│ └── sandi_meter/
│ ├── version.rb
│ └── ...
├── spec/
│ └── ...
└── ...
- LICENSE: 项目的许可证文件。
- README.md: 项目说明文档。
- Rakefile: Rake 任务配置文件。
- sandi_meter.gemspec: Gem 的规范文件。
- bin/: 可执行文件目录,包含
sandi_meter
命令。 - html/: 生成的 HTML 报告文件目录。
- lib/: 项目的主要代码目录,包含
sandi_meter
的核心逻辑。 - spec/: 测试文件目录。
2. 项目的启动文件介绍
项目的启动文件位于 bin/
目录下,文件名为 sandi_meter
。这个文件是项目的可执行文件,用于启动 Sandi Meter 工具来检查 Ruby 代码是否符合 Sandi Metz 的规则。
3. 项目的配置文件介绍
项目的配置文件主要是 sandi_meter.gemspec
,这是一个 Gem 的规范文件,包含了项目的元数据和依赖信息。以下是该文件的部分内容:
Gem::Specification.new do |spec|
spec.name = "sandi_meter"
spec.version = SandiMeter::VERSION
spec.authors = ["Anatoli Makarevich"]
spec.email = ["makaroni4@gmail.com"]
spec.description = %q[Sandi Metz rules checker]
spec.summary = %q[Sandi Metz rules checker]
spec.homepage = "https://github.com/makaroni4/sandi_meter"
spec.license = "MIT"
spec.required_ruby_version = '>= 2.0.0'
spec.files = %w(LICENSE README.md Rakefile sandi_meter.gemspec)
spec.files += Dir.glob("html/*")
spec.files += Dir.glob("lib/**/*")
spec.files += Dir.glob("bin/**/*")
spec.files += Dir.glob("spec/**/*")
spec.executables = ['sandi_meter']
end
- spec.name: 项目的名称。
- spec.version: 项目的版本号。
- spec.authors: 项目的作者。
- spec.email: 作者的联系邮箱。
- spec.description: 项目的描述。
- spec.summary: 项目的简要描述。
- spec.homepage: 项目的主页。
- spec.license: 项目的许可证。
- spec.required_ruby_version: 项目所需的 Ruby 版本。
- spec.files: 项目包含的文件。
- spec.executables: 项目的可执行文件。
通过这些配置信息,可以了解项目的依赖关系、版本要求以及如何安装和使用该项目。