class CKick::Plugin

Base class for a CKick plugin

Public Class Methods

new(args) click to toggle source
# File lib/ckick/plugin.rb, line 10
def initialize args
end

Public Instance Methods

call(project) click to toggle source

Ran after project's structure creation (create_structure)

# File lib/ckick/plugin.rb, line 34
def call(project)
  nil
end
cmake() click to toggle source

Plugin's output to add to main CMakeLists.txt

# File lib/ckick/plugin.rb, line 24
def cmake
  ""
end
include(project) click to toggle source

Appends project's includes path before structure creation

# File lib/ckick/plugin.rb, line 39
def include(project)
  []
end
lib(project) click to toggle source

Appends project's libraries path before structure creation

# File lib/ckick/plugin.rb, line 44
def lib(project)
  []
end
name() click to toggle source

Plugin's name, defaults to class name

# File lib/ckick/plugin.rb, line 14
def name
  self.class.name
end
run(project) click to toggle source

Ran before project's structure creation

# File lib/ckick/plugin.rb, line 29
def run(project)
  nil
end
to_hash() click to toggle source

Plugin to hash is :name => “class name”

# File lib/ckick/plugin.rb, line 19
def to_hash
  {name: self.class.name}
end