Skip to content

haaakon/SwiftFormat

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

SwiftFormat

Python script for auto formatting Swift code, similar to Clang format.

Current status: Gonna rewrite this to Swift.

Usage

auto format a file

Usage: 
--file [FILE] The file to format
--output [FILE] The file to write the formatted output to

python format.py --file inputfilename.swift --output outputfilename.swift

Demo

Demo script run

Contributing

All contributions are more than welcome, suggestions on how to move forward is appreciated.

Test format

Put source code to be formatted above @@@, and under put the correct way it should be formatted after running the format script.

class test() {{var str = "teststr" }}
@@@
class test() {
    {
        var str = "teststr"
    }
}

For each rule thats added, add a test file that shows how it should format correctly. The test checks that all files are formatted correctly as shown under the @@@ in their file.

Run tests

python tests.py
TEST OK for python/SwiftFormatter/testCases/indentation/indentTest.test
TEST OK for python/SwiftFormatter/testCases/indentation/lotsOfCurlyBraces.test
TEST OK for python/SwiftFormatter/testCases/indentation/mulitplemethodsinclass.test
TEST OK for python/SwiftFormatter/testCases/indentation/prefixedSpaces.test
TEST OK for python/SwiftFormatter/testCases/indentation/twoCurly.test

TODO

  • Add alot more formatting rules
  • be able to turn rules on/off
  • add a plugin for xcode

License

MIT

Author

Håkon Bogen hakon.bogen@gmail.com

About

Python script for auto formatting Swift code

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages