Packages

o

com.typesafe.sbt.jse

SbtJsTask

object SbtJsTask extends AutoPlugin

The commonality of JS task execution oriented plugins is captured by this class.

Linear Supertypes
AutoPlugin, PluginsFunctions, Basic, Plugins, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SbtJsTask
  2. AutoPlugin
  3. PluginsFunctions
  4. Basic
  5. Plugins
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class JsTaskFailure extends RuntimeException

    Thrown when there is an unexpected problem to do with the task's execution.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def &&(o: Basic): Plugins
    Definition Classes
    Basic → Plugins
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def addJsSourceFileTasks(sourceFileTask: TaskKey[Seq[sbt.File]]): Seq[sbt.Setting[_]]

    Convenience method to add a source file task into the Asset and TestAsset configurations, along with adding the source file tasks in to their respective collection.

    Convenience method to add a source file task into the Asset and TestAsset configurations, along with adding the source file tasks in to their respective collection.

    sourceFileTask

    The task key to declare.

    returns

    The settings produced.

  6. def allRequirements: PluginTrigger
    Definition Classes
    PluginsFunctions
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val autoImport: JsTaskImport.type
  9. def buildSettings: Seq[sbt.Def.Setting[_]]
    Definition Classes
    AutoPlugin
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def derivedProjects(proj: ProjectDefinition[_]): Seq[Project]
    Definition Classes
    AutoPlugin
  12. def empty: Plugins
    Definition Classes
    PluginsFunctions
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def executeJs(state: State, engineType: JsEngineImport.JsEngineKeys.EngineType.Value, command: Option[sbt.File], nodeModules: Seq[String], shellSource: sbt.File, args: Seq[String], stderrSink: Option[(String) ⇒ Unit] = None, stdoutSink: Option[(String) ⇒ Unit] = None): Seq[JsValue]

    Execute some arbitrary JavaScript.

    Execute some arbitrary JavaScript.

    This method is intended to assist in building SBT tasks that execute generic JavaScript. For example:

    myTask := {
  executeJs(state.value, engineType.value, Seq((nodeModules in Plugin).value.getCanonicalPath,
    baseDirectory.value / "path" / "to" / "myscript.js", Seq("arg1", "arg2"))
}
    state

    The SBT state.

    engineType

    The type of engine to use.

    command

    An optional path to the engine.

    nodeModules

    The node modules to provide (if the JavaScript engine in use supports this).

    shellSource

    The script to execute.

    args

    The arguments to pass to the script.

    stderrSink

    A callback to handle the sctipr's error output.

    stdoutSink

    A callback to handle the sctipr's normal output.

    returns

    A JSON status object if one was sent by the script. A script can send a JSON status object by, as the last thing it does, sending a DLE character (0x10) followed by some JSON to std out.

  16. def extraProjects: Seq[Project]
    Definition Classes
    AutoPlugin
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def globalSettings: Seq[sbt.Def.Setting[_]]
    Definition Classes
    AutoPlugin
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def jsSourceFileTask(task: TaskKey[Seq[sbt.File]], config: sbt.Configuration): sbt.Def.Initialize[Task[Seq[sbt.File]]]

    Primary means of executing a JavaScript shell script for processing source files.

    Primary means of executing a JavaScript shell script for processing source files. unmanagedResources is assumed to contain the source files to filter on.

    task

    The task to resolve js task settings from - relates to the concrete plugin sub class

    config

    The sbt configuration to use e.g. Assets or TestAssets

    returns

    A task object

  23. val jsTaskSpecificUnscopedBuildSettings: Seq[sbt.Setting[_]]
  24. val jsTaskSpecificUnscopedConfigSettings: Seq[sbt.Def.Setting[_ >: File with Task[OpInputHasher[File]] <: Serializable]]
  25. val jsTaskSpecificUnscopedProjectSettings: Seq[sbt.Setting[_]]
  26. val label: String
    Definition Classes
    AutoPlugin
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTrigger: PluginTrigger
    Definition Classes
    PluginsFunctions
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def projectConfigurations: Seq[Configuration]
    Definition Classes
    AutoPlugin
  32. def projectSettings: Seq[sbt.Setting[_]]
    Definition Classes
    SbtJsTask → AutoPlugin
    Annotations
    @nowarn()
  33. def requires: Plugins
    Definition Classes
    SbtJsTask → AutoPlugin
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AutoPlugin → AnyRef → Any
  36. def trigger: PluginTrigger
    Definition Classes
    SbtJsTask → AutoPlugin
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  40. object JsTaskProtocol extends DefaultJsonProtocol

    For automatic transformation of Json structures.

Deprecated Value Members

  1. def executeJs(state: State, engineType: JsEngineImport.JsEngineKeys.EngineType.Value, command: Option[sbt.File], nodeModules: Seq[String], shellSource: sbt.File, args: Seq[String], timeout: FiniteDuration): Seq[JsValue]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.3.0) Use the other executeJs instead

  2. val jsTaskSpecificUnscopedSettings: Seq[sbt.Setting[_]]
    Annotations
    @deprecated
    Deprecated

    (Since version 1.2.0) Add jsTaskSpecificUnscopedProjectSettings to AutoPlugin.projectSettings and jsTaskSpecificUnscopedBuildSettings to AutoPlugin.buildSettings

Inherited from AutoPlugin

Inherited from PluginsFunctions

Inherited from Basic

Inherited from Plugins

Inherited from AnyRef

Inherited from Any

Ungrouped