Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/domluna/JuliaFormatter.jl

An opinionated code formatter for Julia. Plot twist - the opinion is your own.
https://github.com/domluna/JuliaFormatter.jl

cst formatter formatting julia

Last synced: about 2 months ago
JSON representation

An opinionated code formatter for Julia. Plot twist - the opinion is your own.

Host: GitHub
URL: https://github.com/domluna/JuliaFormatter.jl
Owner: domluna
License: mit
Created: 2019-03-10T22:36:14.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-04-08T14:58:14.000Z (6 months ago)
Last Synced: 2024-04-14T10:16:06.609Z (5 months ago)
Topics: cst, formatter, formatting, julia
Language: Julia
Homepage: https://domluna.github.io/JuliaFormatter.jl/dev/
Size: 10.3 MB
Stars: 531
Watchers: 5
Forks: 61
Open Issues: 168
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # JuliaFormatter.jl

[![Documenter: stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://domluna.github.io/JuliaFormatter.jl/stable/)

[![Documenter: dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://domluna.github.io/JuliaFormatter.jl/dev/)

![Build Status](https://github.com/domluna/JuliaFormatter.jl/actions/workflows/ci.yml/badge.svg)

Width-sensitive formatter for Julia code. Inspired by gofmt, refmt, and black.

![Screencast](https://user-images.githubusercontent.com/1813121/72941091-0b146300-3d68-11ea-9c95-75ec979caf6e.gif)

## Installation

```julia

]add JuliaFormatter

```

## Quick Start

```julia

julia> using JuliaFormatter

# Recursively formats all Julia files in the current directory

julia> format(".")

# Formats an individual file

julia> format_file("foo.jl")

# Formats a string (contents of a Julia file)

julia> format_text(str)

```

Check out [the docs](https://domluna.github.io/JuliaFormatter.jl/stable/) for further description of the formatter and its options.

[Use With GitHub Actions](https://github.com/julia-actions/julia-format)

## Editor Plugins

For integration with other editors:

  - [VSCode](https://github.com/singularitti/vscode-julia-formatter/)

  - [Emacs](https://codeberg.org/FelipeLema/julia-formatter.el)

  - [Vim](https://github.com/kdheepak/JuliaFormatter.vim)

  - [Atom (deprecated)](https://github.com/JunoLab/Atom.jl)