julia-vscode / DocumentFormat.jl

Auto-formatter for Julia
Other
62 stars 18 forks source link

DocumentFormat

This package is deprecated. Please use JuliaFormatter.jl instead!


Dev Project Status: Active - The project has reached a stable, usable state and is being actively developed. codecov.io

An auto formatter for Julia.

Installation and Usage

using Pkg
Pkg.add("DocumentFormat")
using DocumentFormat

Documentation: Dev

Overview

The main function to format code is format. When called with a string argument, that string is assumed to be code and a new string in which the code is formatted is returned. When called with an AbstractPath that points to a file, that file is being formatted. If called with an AbstractPath that points to a folder, all *.jl files in that folder are formatted.

The function isformatted checks whether a piece of code is formatted. It can be called with a string (assumed to hold code) or an AbstractPath.