开源项目 GLI 使用教程

开源项目 GLI 使用教程

gliMake awesome command-line applications the easy way项目地址:https://gitcode.com/gh_mirrors/gl/gli

项目目录结构及介绍

GLI 项目的目录结构如下：

gli/
├── bin/
│   └── gli
├── lib/
│   ├── gli.rb
│   └── gli/
│       ├── command_line_arguments.rb
│       ├── command_target.rb
│       ├── commands.rb
│       ├── custom_error.rb
│       ├── dsl.rb
│       ├── flag_support.rb
│       ├── gli_version.rb
│       ├── init.rb
│       ├── option_support.rb
│       ├── parsing.rb
│       ├── parsing_error.rb
│       ├── pre_block.rb
│       ├── remote_command.rb
│       ├── remote_command_stub.rb
│       ├── switch_support.rb
│       ├── version.rb
│       └── version_string.rb
├── spec/
│   ├── command_line_arguments_spec.rb
│   ├── command_target_spec.rb
│   ├── commands_spec.rb
│   ├── custom_error_spec.rb
│   ├── dsl_spec.rb
│   ├── flag_support_spec.rb
│   ├── gli_version_spec.rb
│   ├── option_support_spec.rb
│   ├── parsing_spec.rb
│   ├── parsing_error_spec.rb
│   ├── pre_block_spec.rb
│   ├── remote_command_spec.rb
│   ├── remote_command_stub_spec.rb
│   ├── switch_support_spec.rb
│   ├── version_spec.rb
│   └── version_string_spec.rb
├── .gitignore
├── .rspec
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── gli.gemspec

目录介绍

• bin/：包含可执行文件 gli。
• lib/：包含项目的核心代码文件。
  • gli.rb：主文件。
  • gli/：包含各个功能模块的文件。
• spec/：包含项目的测试文件。
• .gitignore：Git 忽略文件配置。
• .rspec：RSpec 配置文件。
• .travis.yml：Travis CI 配置文件。
• CHANGELOG.md：变更日志。
• CONTRIBUTING.md：贡献指南。
• Gemfile：依赖管理文件。
• LICENSE.txt：许可证文件。
• README.md：项目说明文件。
• Rakefile：Rake 任务文件。
• gli.gemspec：Gem 规范文件。

项目启动文件介绍

项目的启动文件位于 bin/ 目录下，文件名为 gli。这个文件是项目的入口点，负责初始化和启动应用程序。

#!/usr/bin/env ruby

require 'gli'

include GLI::App

program_desc 'A command-line interface for GLI'

version GLI::VERSION

desc 'Example command'
command :example do |c|
  c.action do |global_options,options,args|
    puts "Example command executed!"
  end
end

exit run(ARGV)

启动文件介绍

• #!/usr/bin/env ruby：指定使用 Ruby 解释器。
• require 'gli'：加载 GLI 库。
• include GLI::App：包含 GLI 应用程序模块。
• program_desc 'A command-line interface for GLI'：设置程序描述。
• version GLI::VERSION：设置程序版本。
• desc 'Example command'：设置命令描述。
• command :example do |c|：定义一个示例命令。
• c.action do |global_options,options,args|：定义命令的执行动作。
• exit run(ARGV)：运行程序并退出。

项目配置文件介绍

GLI 项目的配置文件主要是 gli.gemspec 和 Gemfile。

gli.gemspec

gli.gemspec 文件定义了 Gem 的规范，

gliMake awesome command-line applications the easy way项目地址:https://gitcode.com/gh_mirrors/gl/gli