Skip to content

usethis::use_air()#429

Open
d-morrison wants to merge 7 commits into
mainfrom
air
Open

usethis::use_air()#429
d-morrison wants to merge 7 commits into
mainfrom
air

Conversation

@d-morrison

Copy link
Copy Markdown
Member

@codecov

codecov Bot commented Mar 22, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

@d-morrison d-morrison marked this pull request as ready for review June 4, 2026 00:46
@claude

claude Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Claude finished @d-morrison's task in 3m 52s —— View job


Code Review: usethis::use_air()

  • Gather context
  • Review changed files
  • Assess impact on CI/workflow
  • Final verdict

This PR adds minimal Air formatter infrastructure via usethis::use_air(). The changes are focused and correct.

.Rbuildignore
Both patterns are correct:

  • ^[\.]?air\.toml$ — matches both air.toml and .air.toml
  • ^\.vscode$ — excludes the IDE directory from the package bundle

air.toml (empty)
An empty file signals Air is in use and applies all defaults. This is appropriate for now — Air's configuration surface is still limited. The one thing to be aware of: Air will format code using its own defaults (Tidyverse style) when run, which is compatible with the project's .lintr.R since both follow the Tidyverse style guide.

.vscode/settings.json
Enables format-on-save with Air as the default R formatter. Contributors using VSCode/Cursor without the Air extension installed will see a "formatter not found" warning on save. Installing the recommended extension (declared in extensions.json) resolves it, but it may be worth a note in the contributing docs.

History note
The original commit (b1d0aba) accidentally included junit.xml (a local test-output artifact). It was cleaned up in dbef4fc, and .gitignore now covers it — no action needed, just noting it for history cleanliness.

inst/WORDLIST
The word "Air" is not in the WORDLIST, but since "air" is a common English word, spelling::spell_check_package() should not flag it. The +1 line added to WORDLIST in this PR appears to be gh (added in the most recent commit to fix a CI spell-check failure).


Overall: Clean, minimal setup. The PR does exactly what usethis::use_air() is supposed to do and nothing more. No R source changes, no impact on tests or documentation. ✓ Approve.

One optional improvement: add a note to CONTRIBUTING.md (or the relevant docs) that contributors using VSCode should install the Posit.air-vscode extension. Low priority given the extension recommendations file handles it.

@claude

claude Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Claude finished @d-morrison's task in 1m 36s —— View job


Code Review: usethis::use_air()

  • Gather context and diff
  • Review changed files
  • Check CI/workflow impact
  • Final verdict

This PR adds Air formatter infrastructure via usethis::use_air() and documents it for contributors. Changes are minimal and correct.

.Rbuildignore
Both new patterns are well-formed:

  • ^[\.]?air\.toml$ — correctly matches both air.toml and .air.toml
  • ^\.vscode$ — correctly excludes the IDE directory from the package bundle

air.toml (empty)
An empty file signals Air is in use and applies its defaults (Tidyverse style). Compatible with the project's .lintr.R since both target the same style guide.

.vscode/extensions.json + .vscode/settings.json
extensions.json recommends Posit.air-vscode. settings.json enables format-on-save correctly scoped to "[r]" — contributors using other languages won't be affected. Clean.

.github/CONTRIBUTING.Rmd + .github/CONTRIBUTING.md
The Air note is added to the "Code style" section in both the source (.Rmd) and generated (.md) files, keeping them in sync. Good. One minor observation: the section still mentions styler as the style tool ("You can use the styler package to apply these styles"). With Air now configured, it may be worth a follow-up to replace or supplement that guidance with Air, but it's non-blocking.

inst/WORDLIST
gh was added to fix a CI spell-check failure. Appropriate.


Overall: Clean, minimal setup. No R source changes, no impact on tests or documentation. The CONTRIBUTING update addresses the suggestion from the previous review pass. ✓ Approve.

github-actions Bot added a commit that referenced this pull request Jun 4, 2026
@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

📖 https://UCD-SERG.github.io/serocalculator/preview/pr429/
Preview documentation for this PR (at commit 159913f)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants