gradle-sublimetext-plugin's Introduction

sublimeText Plugin for Gradle

The sublimeText plugin allows gradle to create a Sublime Text 2 project file.

##Usage Put the following into your build script and tweak the settings to your liking:

apply plugin: 'sublimeText'

buildscript {
  repositories {
    maven {
      url 'http://phildop.us/m2repo'
    }
    dependencies {
      classpath 'us.phildop:gradle-sublimetext-plugin:0.5'
    }
  }
}

sublimeText {
  // enter relevant (and optional) config stuff here, explained below
}

####sublimeProjectName

If set, the generated file will be named <sublimeProjectName>.sublime-project. Otherwise, it will default to the gradle project's name.

sublimeText {
  sublimeProjectName = 'custom-project-name'
}

####defaultFileExcludePatterns & defaultFolderExcludePatterns

Exclude unimportant files and folders generated by gradle and eclipse. These will be copied to each folder entry.

sublimeText {
  defaultFileExcludePatterns = ['.project', '.classpath', '.pydevproject']
  defaultFolderExcludePatterns = ['.gradle', 'bin', 'build', '.settings']
}

####addDependencyProjects

If set to true, any dependency project folders will be added.

sublimeText {
  addDependencyProjects = true
}

####SublimeJava

Generate paths for SublimeJava

sublimeText {
  generateSublimeJavaClasspath = true
  generateSublimeJavaSrcpath = true
}

####addGradleCompile

If set to true, generate a Sublime Text build system that calls gradle compileJava on project.

sublimeText {
  addGradleCompile = true
}

####addSublimeLinterConfig

If set to true, generate configuration for SublimeLinter.

sublimeText {
  addSublimeLinterConfig = true
}

####EclipseJavaFormatter

Options for EclipseJavaFormatter.

sublimeText {
  eclipseJavaFormatterConfigFile = "/path/to/config/org.eclipse.jdt.core.prefs"
  eclipseJavaFormatterSortImportsOrder = ["java", "javax", "org", "com"]
  eclipseJavaFormatterRestoreLineEndings = true
}