Git Product home page Git Product logo

sublimelinter-javac's Introduction

SublimeLinter-javac

Build Status

This linter plugin for SublimeLinter provides an interface to javac. It will be used with files that have the "Java" syntax.

Please note that because javac requires a complete directory context in order to work, this linter plugin currently will only lint a file when it has been saved.

Installation

SublimeLinter must be installed in order to use this plugin.

Please use Package Control to install the linter plugin.

Before using this plugin, ensure that javac (JDK 1.7+) is installed on your system. javac is part of the java developer SDK, which can be downloaded here.

Please make sure that the path to javac is available to SublimeLinter. The docs cover troubleshooting PATH configuration.

Settings

Additional SublimeLinter-javac settings:

Setting Description
lint A comma-delimited list of rules to apply.

Valid rule names are: all, cast, classfile, deprecation, dep-ann, divzero, empty, fallthrough, finally, options, overrides, path, processing, rawtypes, serial, static, try, unchecked, varargs, -cast, -classfile, -deprecation, -dep-ann, -divzero, -empty, -fallthrough, -finally, -options, -overrides, -path, -processing, -rawtypes, -serial, -static, -try, -unchecked, -varargs, none.

For example, to ignore deprecation warnings for all files in a project, you would add this to the linter settings:

"javac": {
    "lint": "all,-deprecation"
}

Passing options to javac

In order to configure javac options like the class path, source path, or file encoding, the args setting can be used.

Setting Description
args An array of strings, alternating between an option and the corresponding value.

A full list of available options is given here.

For example, the following configuration defines the source file encoding, includes the two libraries lib/some_lib.jar and lib/some_other_lib.jar in the classpath, and defines src/ as the project's source path:

"args": [
    "-encoding", "UTF8",
    "-cp", "${folder}/lib/some_lib.jar:${folder}/lib/some_other_lib.jar",
    "-sourcepath", "${folder}/src/"
]

Note that options and their values must be separate elements in the array (i.e. "args": ["-sourcepath", "/path/to/src"] does work, while "args": ["-sourcepath /path/to/src"] does not work).

Project-specific options

Settings like the class path often only apply to one specific project. The general SublimeLinter documentation also explains how to specify project-specific settings in the sublime-project file.

For the example above, such a project file could look like this:

{
    "folders":
    [
        {
            "path": "."
        }
    ],
    "settings":
    {
        "SublimeLinter.linters.javac.lint": "all",
        "SublimeLinter.linters.javac.args": [
            "-encoding", "UTF8",
             "-cp", "${folder}/lib/some_lib.jar:${folder}/lib/some_other_lib.jar",
            "-sourcepath", "${folder}/src/"
        ]
    }
}

sublimelinter-javac's People

Contributors

aparajita avatar braver avatar groteworld avatar mokkabonna avatar kaste avatar 25a0 avatar

Watchers

James Cloos avatar  avatar

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.