Need help with hugo?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

JakeWharton
7.7K Stars 801 Forks Apache License 2.0 121 Commits 58 Opened issues

Description

Annotation-triggered method call logging for your debug builds.

Services available

!
?

Need anything else?

Contributors list

# 227
Java
Kotlin
Android
kotlin-...
50 commits
# 47,518
Shell
Java
Groovy
Android
14 commits
# 83,875
Java
Groovy
5 commits
# 82,558
Java
Groovy
android...
4 commits
# 35,764
Java
pinyin
Groovy
2 commits
# 82,596
Java
Groovy
Android
android...
2 commits
# 124,146
Java
SDK
Android
Groovy
2 commits
# 10,353
Java
Groovy
ijkplay...
iOS
1 commit
# 133,541
Java
Groovy
1 commit
# 105,979
Java
Groovy
Android
Shell
1 commit
# 153,941
Groovy
Shell
s3
hubot
1 commit
# 124,341
Shell
Groovy
annotat...
Android
1 commit
# 97,805
Groovy
Gradle
Kotlin
github-...
1 commit

Hugo

Annotation-triggered method call logging for your debug builds.

As a programmer, you often add log statements to print method calls, their arguments, their return values, and the time it took to execute. This is not a question. Every one of you does this. Shouldn't it be easier?

Simply add

@DebugLog
to your methods and you will automatically get all of the things listed above logged for free.
@DebugLog
public String getName(String first, String last) {
  SystemClock.sleep(15); // Don't ever really do this!
  return first + " " + last;
}
V/Example: ⇢ getName(first="Jake", last="Wharton")
V/Example: ⇠ getName [16ms] = "Jake Wharton"

The logging will only happen in debug builds and the annotation itself is never present in the compiled class file for any build type. This means you can keep the annotation and check it into source control. It has zero effect on non-debug builds.

Add it to your project today!

buildscript {
  repositories {
    mavenCentral()
  }

dependencies { classpath 'com.jakewharton.hugo:hugo-plugin:1.2.1' } }

apply plugin: 'com.android.application' apply plugin: 'com.jakewharton.hugo'

Disable logging temporarily by adding the following:

hugo {
  enabled false
}

If you want to toggle logging at runtime, use

Hugo.setEnabled(true|false)

Local Development

Working on this project? Here's some helpful Gradle tasks:

  • install
    - Install plugin, runtime, and annotations into local repo.
  • cleanExample
    - Clean the example project build.
  • assembleExample
    - Build the example project. Must run
    install
    first.
  • installExample
    - Build and install the example project debug APK onto a device.

License

Copyright 2013 Jake Wharton

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.