Giter VIP home page Giter VIP logo

luafmt's Introduction

luafmt

A code formatter for Lua 5.1, written in Lua 5.1.

Usage:

To print the formatted version to standard out:

lua luafmt.lua <lua file> [max column hint=80]

To update the Lua file in place:

lua luafmt.lua --f <lua file> [max column hint=80]

luafmt.lua in this repository is formatted using itself.

  • No multiple blank lines in a row
  • No spaces on blank lines
  • Spaces around operators and assignment
  • Space around string and table calls: print {}, print ""
  • Space after commas: return {1, 2}
  • Indentation using tabs for both scope and overflowed lines
  • Blank lines above comments
  • No blanks at the beginning or ends of blocks

A bash script like the following can be used to reformat all .lua files in a directory:

 for f in *.lua ; do lua luafmt.lua --f "$f" ; done

Scripts which are not syntactically correct may not be formattable. The script will output an error and not modify the file.

Testing

Run lua test.lua from the project directory to run tests.

Right now, there are only a couple of tests.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.