Package 'jsslintr'

Find manuscript files for a JSS style check

Description

Lists the .tex, .ltx, .bib, .Rnw, and .Rmd files in a directory – the file set jsslint() checks when called without arguments.

Usage

jss_files(path = ".")

Arguments

path	Directory to search (default: the working directory).

Value

A character vector of file paths.

---

Apply automatic fixes for JSS style issues

Description

Lints the given files and applies the automatic fixes in place (atomic write; a fix that reintroduces its own violation is rolled back). Use dry_run = TRUE to preview the changes as a unified diff without touching the files.

Usage

jssfix(
  files,
  rules = NULL,
  dry_run = FALSE,
  journal = NULL,
  mode = NULL,
  ignore_rules = NULL,
  min_confidence = NULL,
  verbose = NULL
)

Arguments

files	Character vector of file paths, or a "jsslint" object as returned by jsslint() (its files and lint options are reused).
rules	Character vector of rule ids; when given, only fixes for these rules are applied.
dry_run	If TRUE, show the diff of what would change and write nothing.
journal	Journal identifier (default: "jss").
mode	"author" or "reviewer" (default: "author").
ignore_rules	Character vector of rule ids to suppress.
min_confidence	"low", "medium", or "high".
verbose	Enable diagnostic output on stderr.

Value

Invisibly, an object of class "jsslint_fixes" with data frames applied, skipped, and rejected, plus the unified diff (dry runs only). Printing it summarises what happened.

Examples

## Not run: 
jssfix(c("paper.tex", "refs.bib"), dry_run = TRUE)
jssfix(c("paper.tex", "refs.bib"))

## End(Not run)

---

Check a paper against the JSS style guide

Description

Reads the given manuscript files and lints them against the Journal of Statistical Software style guide. This is the main entry point for interactive use; render() is the lower-level in-memory binding it wraps.

Usage

jsslint(
  files = jss_files(),
  journal = NULL,
  mode = NULL,
  ignore_rules = NULL,
  min_confidence = NULL,
  verbose = NULL
)

Arguments

files	Character vector of paths to .tex/.ltx and .bib files, e.g. c("paper.tex", "refs.bib"). Defaults to every such file in the working directory.
journal	Journal identifier (default: "jss").
mode	"author" or "reviewer" (default: "author").
ignore_rules	Character vector of rule ids to suppress.
min_confidence	"low", "medium", or "high".
verbose	Enable diagnostic output on stderr.

Value

An object of class "jsslint". Print it for a quick overview, use summary() for a by-rule and by-category breakdown, and as.data.frame() for one row per issue. Pass it to jssfix() to apply the automatic fixes.

Examples

## Not run: 
res <- jsslint(c("paper.tex", "refs.bib"))
res
summary(res)
as.data.frame(res)
jssfix(res)

## End(Not run)

---

Versions of the package, engine, and rule set

Description

The distribution-to-engine-to-rule-set mapping in code (spec 027 item D). package is this R package's version, which may carry a CRAN resubmission suffix (⁠1.2.0-1⁠) that no other channel uses; tool and engine name the compiled core it wraps; ruleset_version is the date of the rule set whose findings — and whose baseline entries — this build produces. docs/versions.md carries the same mapping for every other channel.

Usage

jsslint_version()

Value

A named list with package, tool, engine, ruleset_version, and guide_source.

Examples

jsslint_version()

---

Lint files against the JSS style guide

Description

Mirrors jsslint::render (the PyO3 binding) / the WASM binding's render().

Usage

render(
  files,
  journal = NULL,
  mode = NULL,
  output = NULL,
  ignore_rules = NULL,
  min_confidence = NULL,
  fail_on = NULL,
  source_root = NULL,
  verbose = NULL
)

Arguments

files	A named character vector: names are file paths (.tex/.ltx/.bib/.Rnw/.Rmd), values are the file contents.
journal	Journal identifier (default: "jss").
mode	"author" or "reviewer" (default: "author").
output	"terminal", "json", "sarif", or "html" (default: "terminal").
ignore_rules	Comma-separated rule ids to suppress.
min_confidence	"low", "medium", or "high".
fail_on	"error", "warning", or "info".
source_root	Base directory for SARIF artifact URIs.
verbose	Enable diagnostic output on stderr.

Value

The rendered report, as a single string.

---