Release 1.6.0

.travis.yml

@@ -0,0 +1,44 @@
+language: generic
+
+notifications:
+  email:
+    on_success: never
+    on_failure: never
+
+script: 'curl -s https://raw.githubusercontent.com/atom/ci/master/build-package.sh | sh'
+
+git:
+  depth: 10
+
+matrix:
+  include:
+    - os: linux
+      dist: trusty
+      sudo: required
+      language: cpp
+      env: ATOM_CHANNEL=stable APM_TEST_PACKAGES="" CHROME_DEVEL_SANDBOX=""
+    - os: linux
+      dist: trusty
+      sudo: required
+      language: cpp
+      env: ATOM_CHANNEL=beta APM_TEST_PACKAGES="" CHROME_DEVEL_SANDBOX=""
+    - os: osx
+      language: objective-c
+      env: ATOM_CHANNEL=stable APM_TEST_PACKAGES=""
+    - os: osx
+      language: objective-c
+      env: ATOM_CHANNEL=beta APM_TEST_PACKAGES=""
+
+
+env:
+  global:
+    - APM_TEST_PACKAGES=""
+
+
+addons:
+  apt:
+    packages:
+    - build-essential
+    - git
+    - libgnome-keyring-dev
+    - fakeroot

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Contributors of the AtomLinters/linter-javac Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,42 +1,62 @@
 # linter-javac
 
-This package will lint your `.java` opened files in Atom through [javac](http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javac.html).
+This package will lint your opened `.java`-files on save, using [javac][javac-docs].
 
-This package will ensure all dependencies are installed on activation.
 
 ## Installation
 
-*   Install [java](http://www.java.com/).
-*   `$ apm install linter-javac`
+Ensure a working JDK is available in your environment (see FAQ) then enter the following on your command line:
+
+    apm install linter-javac
+
+Or Atom ➔ Preferences... ➔ Packages ➔ Search for "linter-javac".
+
 
 ## Settings
 
-You can configure linter-javac by editing `~/.atom/config.cson` (choose Open
-Your Config in Atom menu):
+You can configure linter-javac by using the GUI (recommended - the GUI offers a description and valid defaults) or by editing your `~/.atom/config.cson` (or Atom ➔ Open Your Config):
 
 ```coffeescript
 "linter-javac":
-  # The path to javac.   The default (javac) should work as long as you have it
-  # in your system PATH.
   javaExecutablePath: "javac"
-  # Extra classpath.  This will be appended to the classpath when executing javac.
-    classpath: ""
+  additionalClasspaths: "C:\Users\JohnDoe"
+  additionalJavacOptions: "-verbose -d C:\java-class-cache"
 ```
+Example-Configuration, see our [Wiki][wiki] or the config-GUI for further information.
+
+> To configure linter-javac on a per project-base, we currently encourage you using the [project-manager package][project-manager].
+
 
 ## Classpath
 
-It is strongly recommended that you configure your classpath via a `.classpath`
-file within your project (typically at the root). Simply create a file
-named `.classpath` somewhere within your project (ideally at the root of
-the project). The linter will search for this file by starting at the directory
-of the file being compiled and then searching all parent directories within the
-project. If you have more than one of these configuration files, it will use
-the one that is "closest" to the file being compiled. Within `.classpath` place
-only the classpath to be used for the project (nothing else). For example:
+> The currently implemented `.classpath`-file format conflicts with the Eclipse-based file format. Therefore this implementation will be replaced in the far future.  
+We are aware that configuring classpath-information is the most important (and annoying) issue in linting source-files right - we are working hard to make our planned improvement imperceptible for you. We will keep you informed.
+
+~~It is strongly recommended that you~~ You may configure your classpath via a `.classpath` file within your project (typically at the root). Simply create a file named `.classpath` somewhere within your project (ideally at the root of the project). The linter will search for this file by starting at the directory of the file being compiled and then searching all parent directories within the project. If you have more than one of these configuration files, it will use the one that is "closest" to the file being compiled. Within `.classpath` place only the classpath to be used for the project (nothing else). For example:
 
 ```java
 .:./lib/junit.jar
 ```
 
 This linter will execute `javac` within the directory of the `.classpath`
 file, so relative paths can be considered to be relative to that file.
+
+
+## Frequently Asked Questions
+
+Please take a look into our [FAQs at our wiki][faqs].
+
+
+### Can I help?
+
+Yes please! Give us feedback, file bugs or just help us coding - join us on https://github.com/AtomLinter/linter-javac/issues and leave a note!
+
+
+:gift_heart:
+
+
+
+[javac-docs]: https://docs.oracle.com/javase/8/docs/technotes/tools/unix/javac.html
+[wiki]: https://github.com/AtomLinter/linter-javac/wiki
+[project-manager]: https://atom.io/packages/project-manager
+[faqs]: https://github.com/AtomLinter/linter-javac/wiki#frequently-asked-questions

lib/init.coffee

@@ -1,30 +1,65 @@
 {Directory, CompositeDisposable} = require 'atom'
+_os = require 'os'
 path = require 'path'
 helpers = require 'atom-linter'
 voucher = require 'voucher'
 fs = require 'fs'
 cpConfigFileName = '.classpath'
 
 module.exports =
+  # coffeelint: disable=max_line_length
   config:
-    javaExecutablePath:
+    javacExecutablePath:
       type: 'string'
-      title: 'Path to the javac executable'
+      description: 'Path to the javac executable. This setting will be used to
+      call the java-compiler. The entered value should be immediately callable
+      on commandline. Example: `C:\\Program Files\\Java\\jdk1.6.0_16\\bin\\javac.exe`.
+      Keep in mind that placeholders like `~` do **not** work. If your
+      [path-variable](https://en.wikipedia.org/wiki/PATH_\(variable\))
+      is set properly it should not be necessary to change the default.'
       default: 'javac'
-    classpath:
+    additionalClasspaths:
       type: 'string'
-      title: "Extra classpath for javac"
+      description: 'Additional classpaths to be used (for the `-cp`-option)
+      when calling javac, separate multiple paths using the right
+      path-delimiter for your os (`:`/`;`).
+      Be aware that existing classpath-definitions from
+      the environment variable "CLASSPATH" will be merged into the argument,
+      as well as the content of your optional
+      [`.classpath`-files](https://atom.io/packages/linter-javac).
+      Example: `/path1:/path2` will become `javac -cp :/path1:/path2`.
+      Keep in mind that placeholders like `~` do **not** work.'
       default: ''
+    additionalJavacOptions:
+      type: 'string'
+      default: ''
+      description: 'Your additional options will be inserted between
+      the javac-command and the sourcefiles. Example: `-d /root/class-cache`
+      will become `javac -Xlint:all -d /root/class-cache .../Test.java`
+      take a look to the
+      [javac-docs](http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javac.html)
+      for further information on valid options. Keep in mind that placeholders
+      like `~` do **not** work.'
+
 
   activate: ->
     require('atom-package-deps').install()
     @subscriptions = new CompositeDisposable
-    @subscriptions.add atom.config.observe 'linter-javac.javaExecutablePath',
+    @subscriptions.add atom.config.observe 'linter-javac.javacExecutablePath',
       (newValue) =>
-        @javaExecutablePath = newValue
-    @subscriptions.add atom.config.observe 'linter-javac.classpath',
+        @javaExecutablePath = newValue.trim()
+    @subscriptions.add atom.config.observe 'linter-javac.additionalClasspaths',
       (newValue) =>
         @classpath = newValue.trim()
+    @subscriptions.add atom.config.observe 'linter-javac.additionalJavacOptions',
+      (newValue) =>
+        trimmedValue = newValue.trim()
+        if trimmedValue
+          @additionalOptions = trimmedValue.split(/\s+/)
+        else
+          @additionalOptions = []
+
+  # coffeelint: enable=max_line_length
 
   deactivate: ->
     @subscriptions.dispose()
@@ -38,7 +73,7 @@ module.exports =
       wd = path.dirname filePath
       searchDir = @getProjectRootDir()
       # Classpath
-      cp = null
+      cp = ''
 
       # Find project config file if it exists.
       cpConfig = @findClasspathConfig(wd)
@@ -62,9 +97,45 @@ module.exports =
         .then (files) =>
           # Arguments to javac
           args = ['-Xlint:all']
-          args = args.concat(['-cp', cp]) if cp?
+          args = args.concat(['-cp', cp]) if cp
+
+          # add additional options to the args-array
+          if @additionalOptions.length > 0
+            args = args.concat @additionalOptions
+
           args.push.apply(args, files)
 
+
+
+
+          # TODO: remove this quick fix
+          # count the size of expected execution-command
+          # see issue #58 for further details
+          cliLimit = if _os.platform() == 'win32' then 7900 else 130000
+          expectedCmdSize = @javaExecutablePath.length
+          sliceIndex = 0
+          for arg in args
+            expectedCmdSize++ # add prepending space
+            if (typeof arg) == 'string'
+              expectedCmdSize += arg.length
+            else
+              expectedCmdSize += arg.toString().length
+            if expectedCmdSize < cliLimit
+              sliceIndex++
+
+          if sliceIndex < (args.length - 1)
+            # coffeelint: disable=max_line_length
+            console.warn """
+linter-javac: The lint-command is presumed to break the limit of #{cliLimit} characters on the #{_os.platform()}-platform.
+Dropping #{args.length - sliceIndex} source files, as a result javac may not resolve all dependencies.
+"""
+            # coffeelint: enable=max_line_length
+            args.push(filePath)
+            args = args.slice(0, sliceIndex)
+
+
+
+
           # Execute javac
           helpers.exec(@javaExecutablePath, args, {stream: 'stderr', cwd: wd})
             .then (val) =>

package.json

@@ -1,12 +1,12 @@
 {
   "name": "linter-javac",
   "main": "./lib/init",
-  "version": "1.5.0",
-  "description": "Lint Java using javac",
+  "version": "1.6.0",
+  "description": "Lint Java on save, using javac.",
   "repository": "https://github.com/AtomLinter/linter-javac",
   "license": "MIT",
   "engines": {
-    "atom": ">0.50.0"
+    "atom": ">1.0.0"
   },
   "dependencies": {
     "atom-linter": "^4.5.0",

spec/_spec-helpers.coffee

@@ -0,0 +1,6 @@
+# Helpers for the specs of this plugin
+
+# Generates a primitive stub of the atom-texteditor-object to provide a path
+this.texteditorFactory = (texteditorPath) ->
+  getPath: () ->
+    texteditorPath

spec/base-spec.coffee

@@ -0,0 +1,68 @@
+# This file contains all specs to ensure the base-functionality of
+# this plugin.
+
+_path = require 'path'
+
+
+_helpers = require _path.join(__dirname, '_spec-helpers.coffee')
+
+
+describe 'linter-javac', ->
+  beforeEach ->
+    #atom.workspace.destroyActivePaneItem
+    waitsForPromise ->
+      atom.packages.activatePackage 'linter-javac'
+      atom.packages.activatePackage 'language-java'
+
+
+
+  describe 'when using a faulty java-source file', ->
+    beforeEach ->
+      javaFile = _path.join(__dirname, 'fixtures', 'BrokenWorld.java')
+      waitsForPromise =>
+        atom.workspace.open(javaFile)
+        .then (whatever) =>
+          @texteditor = whatever
+          @linter = require(_path.join(__dirname, '..', 'lib', 'init.coffee'))
+          .provideLinter()
+
+    it 'returns at least 8 messages in the linter-message-object', ->
+      waitsForPromise( =>
+        @linter.lint(@texteditor).then( (messages) ->
+          expect(messages.length).toBeGreaterThan(7)
+        )
+      )
+
+
+
+  describe 'when using a correct java-source file', ->
+    beforeEach ->
+      javaFile = _path.join(__dirname, 'fixtures', 'HelloWorld.java')
+      waitsForPromise =>
+        atom.workspace.open(javaFile)
+        .then (whatever) =>
+          @texteditor = whatever
+          @linter = require(_path.join(__dirname, '..', 'lib', 'init.coffee'))
+          .provideLinter()
+
+    it 'returns an empty linter-message-object', ->
+      result = {}
+      expect(JSON.stringify(@linter.lint(@texteditor)))
+        .toEqual(JSON.stringify(result))
+
+
+
+  describe 'when using an empty java-source file', ->
+    beforeEach ->
+      javaFile = _path.join(__dirname, 'fixtures', 'EmptyWorld.java')
+      waitsForPromise =>
+        atom.workspace.open(javaFile)
+        .then (whatever) =>
+          @texteditor = whatever
+          @linter = require(_path.join(__dirname, '..', 'lib', 'init.coffee'))
+          .provideLinter()
+
+    it 'returns an empty linter-message-object', ->
+      result = {}
+      expect(JSON.stringify(@linter.lint(@texteditor)))
+        .toEqual(JSON.stringify(result))

spec/fixtures/BrokenWorld.java

@@ -0,0 +1,12 @@
+*
+  This world is realistic.
+*/
+public class BrokenWorld
+
+  @SuppressWarnings({})
+  public static void main (String[ args)
+  {
+    / This prints "Hello World!":
+    System.out.println("Hello World!")
+  }
+}

spec/fixtures/HelloWorld.java

@@ -0,0 +1,12 @@
+/*
+  In this world, everything is okay!
+*/
+public class HelloWorld
+{
+  @SuppressWarnings({})
+  public static void main (String[] args)
+  {
+    // This prints "Hello World!":
+    System.out.println("Hello World!");
+  }
+}