module Rake::DSL

要約

Rakefile の中で使うタスク定義などの DSL メソッドを定義するモジュールです。

require "rake" すると main オブジェクトがこのモジュールで extend されるため、Rakefile のトップレベルでは task や desc などを直接呼び出せます。

目次

privateメソッド

• desc
• directory
• file
• file_create
• import
• multitask
• namespace
• rule
• task

継承しているメソッド

RakeFileUtilsから継承しているメソッド

• nowrite
• verbose
• when_writing

privateメソッド

desc(description) -> StringRuby 3.0 から[permalink][rdoc][edit]

直後の Rake タスクの説明を登録します。

[PARAM] description:

直後のタスクの説明を指定します。

例

desc "Run the Unit Tests"
task :test => [:build] do
  runtests
end

directory(dir) -> ()Ruby 3.0 から[permalink][rdoc][edit]

与えられたディレクトリを作成するタスクを定義します。

[PARAM] dir:

作成するディレクトリを指定します。

例

directory 'testdata/doc'

file(*args) { ... } -> Rake::FileTaskRuby 3.0 から[permalink][rdoc][edit]

ファイルタスクを定義します。

[PARAM] args:

ファイル名と依存ファイル名を指定します。

例

file "config.cfg" => ["config.template"] do
  open("config.cfg", "w") do |outfile|
    open("config.template") do |infile|
      while line = infile.gets
        outfile.puts line
      end
    end
  end
end

[SEE_ALSO] Rake::Task.define_task

file_create(*args) { ... } -> Rake::FileCreationTaskRuby 3.0 から[permalink][rdoc][edit]

ファイルを作成するタスクを定義します。

主に Rake::DSL#directory を定義するために使用します。

import(*filenames)Ruby 3.0 から[permalink][rdoc][edit]

分割された Rakefile をインポートします。

インポートされたファイルは、現在のファイルが完全にロードされた後でロードされます。このメソッドはインポートするファイルのどこで呼び出されてもかまいません。また、インポートされるファイル内に現れるオブジェクトはインポートするファイル内で定義されているオブジェクトに依存していてもかまいません。

このメソッドは依存関係を定義したファイルを読み込むのによく使われます。

[PARAM] filenames:

インポートする Rakefile を指定します。

例

import ".depend", "my_rules"

multitask(args) { ... } -> Rake::MultiTaskRuby 3.0 から[permalink][rdoc][edit]

事前タスクを並列実行するタスクを定義します。

与えられた事前タスクを実行する順序は不定です。

例

multitask :deploy => [:deploy_gem, :deploy_rdoc]

namespace(name = nil) { ... } -> Rake::NameSpaceRuby 3.0 から[permalink][rdoc][edit]

新しい名前空間を作成します。

与えられたブロックを評価する間は、その名前空間を使用します。

例

ns = namespace "nested" do
  task :run
end
task_run = ns[:run] # find :run in the given namespace.

[SEE_ALSO] Rake::TaskManager#in_namespace

rule(*args) {|t| ... } -> Rake::TaskRuby 3.0 から[permalink][rdoc][edit]

自動的に作成するタスクのためのルールを定義します。

[PARAM] args:

ルールに与えるパラメータを指定します。

例

rule '.o' => '.c' do |t|
  sh %{cc -o #{t.name} #{t.source}}
end

task(*args) { ... } -> Rake::TaskRuby 3.0 から[permalink][rdoc][edit]

Rake タスクを定義します。

[PARAM] args:

タスク名と依存タスクを指定します。

例

task :clobber => [:clean] do
  rm_rf "html"
end

[SEE_ALSO] Rake::Task.define_task