commit | eb0030039434766814d3f5ff059b404af751c085 | [log] [tgz] |
---|---|---|
author | emcmanus <emcmanus@google.com> | Mon Mar 21 14:35:20 2016 -0700 |
committer | Liam Miller-Cushon <cushon@google.com> | Tue Mar 22 17:44:13 2016 -0700 |
tree | 39464a92cc76a7e83a8912bbf278ffee78efde6d | |
parent | c0f147afb71fa893a0762bda939ca98c78d8aa63 [diff] |
Add hidden option to sort imports The new options are --sort-imports=also to trigger import sorting, and --sort-imports=only to sort imports and do nothing else. Eventually, g-j-f should just sort imports always, but it can't do that until the new import order is fully established. (More accurately, it should sort imports if all the imports are inside the text to be formatted.) ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=117755463
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.
First download the formatter and save it where you wish. Then simply run it via:
java -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.
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.
<dependency> <groupId>com.google.googlejavaformat</groupId> <artifactId>google-java-format</artifactId> <version>0.1-alpha</version> </dependency>
dependencies { compile 'com.google.googlejavaformat:google-java-format:0.1-alpha' }
You can then use the formatter through the formatSource
methods. E.g.
String formattedSource = new Formatter().formatSource(sourceString);
or
CharSource source = ... CharSink output = ... new Formatter().formatSource(source, output);
Generally speaking, your starting point should be the instance methods of com.google.googlejavaformat.java.Formatter
.
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
Please see the contributors guide for details.
Copyright 2015 Google Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.