Module: Rbnotes

Defined in:

lib/rbnotes.rb,
lib/rbnotes/conf.rb,
lib/rbnotes/error.rb,
lib/rbnotes/utils.rb,
lib/rbnotes/version.rb,
lib/rbnotes/commands.rb,
lib/rbnotes/statistics.rb

Defined Under Namespace

Modules: Commands, ErrMsg Classes: Conf, Error, InvalidTimestampPatternAsDateError, InvalidTimestampPatternError, MissingArgumentError, MissingTimestampError, NoArgumentError, NoConfFileError, NoEditorError, NoTemplateFileError, ProgramAbortError, Statistics, UnknownKeywordError, Utils

Constant Summary

NAME =

:nodoc:

File.basename($PROGRAM_NAME)

VERSION =

"0.4.21"

RELEASE =

"2024-11-03"

Class Method Summary

• .conf(conf_path = nil) ⇒ Object

  Gets the instance of Rbnotes::Conf.

• .utils ⇒ Object

  Retrieves the singleton instance of Rbnotes::Utils class.

Class Method Details

.conf(conf_path = nil) ⇒ Object

Gets the instance of Rbnotes::Conf. An optional argument is to specify the absolute path for the configuration file.

:call-seq:

conf(String) => Rbnotes::Conf

# File 'lib/rbnotes/conf.rb', line 135

def conf(conf_path = nil)
  Conf.new(conf_path)
end

.utils ⇒ Object

Retrieves the singleton instance of Rbnotes::Utils class. Typical usage is as follows:

Rbnotes.utils.find_editor("emacsclient")

# File 'lib/rbnotes/utils.rb', line 19

def utils
  Utils.instance
end