R/ExtGitignore.R

In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases

#' Extension Gitignore file class
#'
#' @description
#' A class for generating the .gitignore file of an extension package.
#'
#' @details
#' This class can be used to generate a new .gitignore file or to keep one
#' up to date.
#'
#' @examples
#' # Generate a new package:
#' pkgFolder <- file.path(tempfile(), 'biodbFoo')
#' dir.create(pkgFolder, recursive=TRUE)
#' biodb::ExtGitignore$new(path=pkgFolder)$generate()
#'
#' @import R6
#' @import chk
#' @include ExtFileGenerator.R
#' @export
ExtGitignore <- R6::R6Class('ExtGitignore',

inherit=ExtFileGenerator,

public=list(

#' @description
#' Initializer.
#' @param ... See the constructor of ExtFileGenerator for the parameters.
#' @return Nothing.
initialize=function(...) {
    super$initialize(filename=".gitignore", template='gitignore',
        upgrader='lineAdder', ...)

    return(invisible(NULL))
}
))