Create a dockerignore template for common ignore patterns

Creates a comprehensive .dockerignore template with patterns for various file categories based on the selected options.

Usage

dk_template_ignore_common(
  .dockerignore = NULL,
  git = TRUE,
  r = TRUE,
  os = TRUE,
  editor = FALSE,
  node = FALSE,
  python = FALSE,
  data = FALSE
)

Arguments

.dockerignore

Optional existing dockerignore object to add patterns to

git

Include Git-related files (default: TRUE)

r

Include R-related files (default: TRUE)

os

Include OS-specific files (default: TRUE)

editor

Include editor-specific files (default: FALSE)

node

Include Node.js-related files (default: FALSE)

python

Include Python-related files (default: FALSE)

data

Include data-related files (default: FALSE)

Value

A dockerignore object with selected ignore patterns

Details

This function provides a convenient way to create a comprehensive .dockerignore file tailored to your project's needs. Each category adds patterns relevant to specific types of files:

• git: Git repositories, .gitignore, etc.

• r: R history, RData, Rproj.user, etc.

• os: .DS_Store, Thumbs.db, etc.

• editor: .vscode, .idea, *.swp, etc.

• node: node_modules, package-lock.json, etc.

• python: pycache, *.pyc, venv, etc.

• data: *.csv, *.json, *.xlsx, etc.

See also

dk_template_ignore_git() for Git-specific patterns, dk_template_ignore_r() for R-specific patterns, & di_add() for adding custom patterns

Other dockerignore template functions: dk_template_ignore_data(), dk_template_ignore_editor(), dk_template_ignore_git(), dk_template_ignore_node(), dk_template_ignore_os(), dk_template_ignore_packrat(), dk_template_ignore_python(), dk_template_ignore_r(), dk_template_ignore_raw_data(), dk_template_ignore_renv()

Examples

# Basic template with Git, R, and OS patterns
di <- dk_template_ignore_common()

# Customize with additional categories
di <- dk_template_ignore_common(
  git = TRUE,
  r = TRUE,
  os = TRUE,
  editor = TRUE,
  data = TRUE
)