transform_file: Transform a file and output a customized message

View source: R/transform-files.R

transform_fileR Documentation

Transform a file and output a customized message

Description

Transforms file contents and outputs customized messages.

Usage

transform_file(
  path,
  fun,
  max_char_path,
  message_before = "",
  message_after = " [DONE]",
  message_after_if_changed = " *",
  ...,
  dry
)

Arguments

path

A vector with file paths to transform.

fun

A function that returns a character vector.

max_char_path

The number of characters of the longest path. Determines the indention level of message_after.

message_before

The message to print before the path.

message_after

The message to print after the path.

message_after_if_changed

The message to print after message_after if any file was transformed.

...

Further arguments passed to transform_utf8().

dry

To indicate whether styler should run in dry mode, i.e. refrain from writing back to files ."on" and "fail" both don't write back, the latter returns an error if the input code is not identical to the result of styling. "off", the default, writes back if the input and output of styling are not identical.


r-lib/styler documentation built on March 23, 2024, 5:51 p.m.