Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 2.79 KB

engine_local_dev_guide.md

File metadata and controls

77 lines (49 loc) · 2.79 KB

远程使用

如果您已经熟悉 engine 的用法和提供的功能，不需要随时查看 engine 源代码，可以直接在Gemfile中添加远程的 github 代码库：

gem 'rails_ui', github: "work-design/rails_ui"

然后 bundle install即可。 不过，work design engine业务抽象化组件集合了众多特性，随时查阅组件提供的功能和属性，然后根据您项目的实际需要进行定制和 override 重载是我们推荐的方式，所以我们更推荐您使用本地submodule的方式来进行开发。

本地submodule方式

我们更推荐的本地submodule方式，可以随时查看 engine 的文档、源码。

第一步：新建项目总文件夹

进入文件夹后，新建或拷贝已有的主项目。

第二步：克隆全部 engine 到本地项目总文件夹。

git clone https://github.com/work-design/rails_engine.git

第三步：进入到刚 clone 的 engine 目录中，初始化 engine

git submodule update --init

命令会根据.gitmodules这个文件中的配置clone所有 engine 到本地。如果您只是需要部分组件，也可以修改.gitmodules文件，只加入您项目需要的 rails_xxx。

[submodule "rails_xxx"]
  path = rails_xxx
  url = [email protected]:work-design/rails_xxx.git

后续更新项目:

git pull
git submodule update --rebase(或--merge)

第四步：配置bundle

您也可以直接在Gemfile中直接指定 Gem 的路径为本地目录。

gem 'rails_xxx", path:"~/your_gem_local_path"

但这种方式缺少灵活性，Gemfile带一大堆本地文件显得不专业 。

所以我们建议您使用bundle config命令来拦截Gemfile中的设置。每次bundle install时从本地文件获取Gem，而不是从远程网络中获取。您可以这样做：

bundle config local.rails_xxx ~/your_main_project_path/engine_path/rails_xxx

这个命令会修改~/.bundle/config文件，会在文件末尾添加：

BUNDLE_LOCAL__RAILS_XXX: "~/your_main_project_path/engine_path/rails_xxx"

第五步：在RubyMine或VSCode中开发

把本地项目文件夹和engine文件夹加入到您的编辑器中，您就可以愉快的开发了。我们更推荐使用RubyMine，它会自动索引代码，这样您就可以自如在项目代码和engine代码中跳转了。当然，您也可以使用免费且强大的VSCode，但需要您进行配置各类插件来达到RubyMine的功能。

总结

所有您需要查看源码的Gem，都可以采用这种方式。git clone到本地，bundle config设置到本地，加入编辑器 IDE，愉快的开发。

文档还在逐步完善中，如果您发现错误或者有更好的建议，欢迎您提issue或者和直接我们联系。