Skip to content

Replace JuliaFormatter with Runic.jl in style guide#68

Merged
ChrisRackauckas merged 1 commit intoSciML:mainfrom
ChrisRackauckas-Claude:replace-juliaformatter-with-runic
Jan 9, 2026
Merged

Replace JuliaFormatter with Runic.jl in style guide#68
ChrisRackauckas merged 1 commit intoSciML:mainfrom
ChrisRackauckas-Claude:replace-juliaformatter-with-runic

Conversation

@ChrisRackauckas-Claude
Copy link
Copy Markdown
Contributor

Summary

  • Replace all JuliaFormatter references with Runic.jl documentation
  • Update style rules to reflect Runic.jl's fixed formatting conventions
  • Add notes throughout the guide about automatic enforcement by Runic.jl

Changes Made

Table of Contents

  • Updated link from JuliaFormatter to Runic

High Level Rules Section

  • Added notes that 4-space indentation is automatically enforced by Runic.jl
  • Noted that line length limit must be managed manually (Runic doesn't wrap lines)

Whitespace Section

  • Added introductory note that whitespace rules are automatically enforced by Runic.jl

Binary Operators Section

  • Clarified that spaces ARE used around = in keyword arguments
  • Changed "may be excluded" language to explicit "Exceptions (no spaces)" list
  • Added type annotations (::) to the exceptions list

NamedTuples Section

  • Updated to note that Runic.jl automatically formats named tuples

For Loops Section

  • Added note that Runic.jl automatically converts = and to in

Replaced JuliaFormatter Section

The new Runic section includes:

  • Description of Runic's zero-configuration philosophy
  • Installation instructions
  • Command-line usage examples
  • Complete CI workflow YAML example
  • Instructions for selectively disabling formatting (# runic: off/on)
  • Note about JuliaFormatter comment compatibility (#! format: off/on)

Test plan

  • Verify the FormatCheck.yml workflow in the repo already uses Runic (it does)
  • Review that documentation accurately reflects Runic.jl behavior
  • Verify all internal links in Table of Contents work correctly

🤖 Generated with Claude Code

- Update Table of Contents to reference Runic instead of JuliaFormatter
- Replace JuliaFormatter section with comprehensive Runic.jl documentation
  including installation, usage commands, and CI workflow example
- Add notes throughout style guide about Runic.jl automatic enforcement:
  - High Level Rules section: indentation and line length notes
  - Whitespace section: note about automatic enforcement
  - Binary operators: clarify spacing rules matching Runic behavior
  - NamedTuples section: note about automatic formatting
  - For loops section: note about automatic in/=/∈ conversion
- Update operator spacing rules to be more definitive (Runic has fixed rules)
- Add documentation for runic: off/on comments and JuliaFormatter compatibility

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ChrisRackauckas ChrisRackauckas merged commit d51826f into SciML:main Jan 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants