Ruby项目的标准文件结构是什么?

时间:2014-02-09 21:56:40

标签: ruby gem

假设我正在创建一个不一定是Web项目的vanilla Ruby项目,我的文件结构应该是什么样的?我的要求是:

  • 有一种机制可以包含gems(最可能是根目录中的Gemfile)
  • 允许我直接运行Ruby文件,但也可以作为库

我的想法是:

proj
--> .ruby-version
--> .ruby-gemset
--> lib
----> proj.rb
--> Gemfile
--> README
--> run.rb (which requires the proj.rb in lib/ and uses it to do work)

如果我计划制作一个Ruby Gem,是否需要考虑哪些因素?

1 个答案:

答案 0 :(得分:3)

没有必要设置任何定义Ruby项目的方法。但是,通常RubyGems具有以下文件结构:

.
├── bin
│   └── mygem
├── Gemfile
├── lib
│   ├── mygem
│   │   └── version.rb
│   └── mygem.rb
├── LICENSE
├── mygem.gemspec
├── Rakefile
└── README.md

当然,项目根目录中还有其他目录和文件,用于测试,.ruby-version等。