CrystalRuby 项目教程

CrystalRuby 项目教程

crystalrubyEmbed Crystal code directly in Ruby项目地址:https://gitcode.com/gh_mirrors/cr/crystalruby

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

CrystalRuby 项目的目录结构如下：

crystalruby/
├── bin/
├── lib/
│   ├── crystalruby/
│   └── crystalruby.rb
├── spec/
├── Gemfile
├── Gemfile.lock
├── README.md
└── crystalruby.gemspec

• bin/: 包含可执行文件。
• lib/: 包含项目的核心代码。
  • crystalruby/: 包含 CrystalRuby 的具体实现代码。
  • crystalruby.rb: 项目的入口文件。
• spec/: 包含项目的测试代码。
• Gemfile: 定义项目依赖的 Gem 文件。
• Gemfile.lock: 锁定项目依赖的版本。
• README.md: 项目的说明文档。
• crystalruby.gemspec: 项目的 gem 规范文件。

2. 项目的启动文件介绍

项目的启动文件是 lib/crystalruby.rb，该文件负责加载和初始化 CrystalRuby 库。以下是该文件的简要介绍：

# lib/crystalruby.rb

require 'crystalruby/version'
require 'crystalruby/configuration'
require 'crystalruby/compiler'
require 'crystalruby/runner'

module CrystalRuby
  # 初始化配置
  def self.configure
    yield(Configuration)
  end

  # 编译 Crystal 代码
  def self.compile
    Compiler.compile
  end

  # 运行 Crystal 代码
  def self.run
    Runner.run
  end
end

• require 'crystalruby/version': 加载版本信息。
• require 'crystalruby/configuration': 加载配置模块。
• require 'crystalruby/compiler': 加载编译模块。
• require 'crystalruby/runner': 加载运行模块。
• CrystalRuby.configure: 用于配置 CrystalRuby。
• CrystalRuby.compile: 用于编译 Crystal 代码。
• CrystalRuby.run: 用于运行 Crystal 代码。

3. 项目的配置文件介绍

项目的配置文件是 lib/crystalruby/configuration.rb，该文件定义了 CrystalRuby 的配置选项。以下是该文件的简要介绍：

# lib/crystalruby/configuration.rb

module CrystalRuby
  module Configuration
    class << self
      attr_accessor :debug, :single_thread_mode

      def initialize
        @debug = false
        @single_thread_mode = false
      end
    end
  end
end

• attr_accessor :debug, :single_thread_mode: 定义了两个配置选项 debug 和 single_thread_mode。
• initialize: 初始化默认配置，debug 默认为 false，single_thread_mode 默认为 false。

通过这些配置选项，用户可以控制 CrystalRuby 的调试模式和单线程模式。

---

以上是 CrystalRuby 项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用 CrystalRuby 项目。

crystalrubyEmbed Crystal code directly in Ruby项目地址:https://gitcode.com/gh_mirrors/cr/crystalruby