relateiq/google-java-format

Name: google-java-format

Owner: SalesforceIQ

Description: null

Created: 2015-12-10 22:54:50.0

Updated: 2015-12-10 22:54:51.0

Pushed: 2015-12-16 00:36:09.0

Homepage: null

Size: 432

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

google-java-format

Release version: 0.1-alpha Snapshot version: 0.1-SNAPSHOT

google-java-format is a program that reformats Java source code to comply with Google Java Style.

Using the formtter from the command-line

First download the formatter and save it where you wish. Then simply run it via:

 -jar /path/to/google-java-format-0.1-alpha.jar <options> [files...]

The formatter can act on whole files, on limited lines (--lines), on specific ofsets (--offset), passing through to standard-out (default) or altered in-place (--replace).

Note: There is no configurability as to the formatter's algorithm for formatting. This is a deliberate design decision to unify our code formatting on a single format.

Using the formatter in code-generators

The formatter can be used in software which generates java to output more legible java code. Just include the library in your maven/gradle/etc. configuration.

Maven

endency>
roupId>com.google.googlejavaformat</groupId>
rtifactId>google-java-format</artifactId>
ersion>0.1-alpha</version>
pendency>

Gradle

ndencies {
mpile 'com.google.googlejavaformat:google-java-format:0.1-alpha'

You can then use the formatter quite simply using the various formatSource methods. E.g.

ng formattedSource = Formatter.formatSource(sourceString);

or

Source source = ...
Sink output = ...
atter.formatSource(source, output);

Generally speaking, your starting point should be the static methods found in com.google.googlejavaformat.java.Formatter.

Building from source

To build google-java-format from source, you will need copy IntelliJ's platform JARs from a local IntelliJ install; see install-idea-jars.sh. Alternatively, you can skip building the IntelliJ plugin:

mvn -pl '!idea_plugin' install

Contributing

Please see the contributors guide for details.

License

right 2015 Google Inc.

nsed under the Apache License, Version 2.0 (the "License"); you may not
this file except in compliance with the License. You may obtain a copy of
License at

http://www.apache.org/licenses/LICENSE-2.0

ss required by applicable law or agreed to in writing, software
ributed under the License is distributed on an "AS IS" BASIS, WITHOUT
ANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
nse for the specific language governing permissions and limitations under
License.