Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
625 changed files
with
136,468 additions
and
268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../0.13.5/api/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| <!DOCTYPE html SYSTEM "about:legacy-compat"> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"/> | ||
| <meta content="width=device-width, initial-scale=1" name="viewport"/> | ||
| <title>sbt Reference Manual — Advanced command example</title> | ||
|
|
||
| <link rel="stylesheet" href="css/blueprint/screen.css" type="text/css" media="screen, projection"/> | ||
| <link rel="stylesheet" href="css/blueprint/grid.css" type="text/css" media="screen and (min-device-width: 800px), projection"/> | ||
| <link rel="stylesheet" href="css/blueprint/print.css" type="text/css" media="print"/> | ||
| <!--[if lt IE 8]> | ||
| <link rel="stylesheet" href={ relativeBase + "css/blueprint/ie.css" } type="text/css" media="screen, projection"/> | ||
| <![endif]--> | ||
| <link rel="stylesheet" href="css/pamflet.css" type="text/css" media="screen, projection"/> | ||
| <link rel="stylesheet" href="css/pamflet-print.css" type="text/css" media="print"/> | ||
| <link rel="stylesheet" href="css/pamflet-grid.css" type="text/css" media="screen and (min-device-width: 800px), projection"/> | ||
| <link rel="stylesheet" href="css/color_scheme-redmond.css" type="text/css" media="screen, projection"/> | ||
| <link rel="stylesheet" href="css/color_scheme-github.css" type="text/css" media="screen, projection"/> | ||
| <link rel="stylesheet" href="css/color_scheme-monokai.css" type="text/css" media="screen, projection"/> | ||
| <link rel="stylesheet" href="css/pamfletheight_80px_2em.css" type="text/css" media="screen and (min-device-width: 800px), projection"/> | ||
| <script type="text/javascript" src="js/jquery-1.6.2.min.js"></script> | ||
| <script type="text/javascript" src="js/jquery.collapse.js"></script> | ||
| <script type="text/javascript" src="js/pamflet.js"></script> | ||
| <script type="text/javascript"> | ||
| Pamflet.page.language = 'en'; | ||
| </script> | ||
| <script type="text/javascript" src="js/prettify/prettify.js"></script><script type="text/javascript" src="js/prettify/lang-scala.js"></script><link type="text/css" rel="stylesheet" href="css/prettify.css"/><script type="text/javascript"><!-- | ||
| window.onload=function() { prettyPrint(); }; | ||
| --></script> | ||
| <link rel="stylesheet" href="css/custom.css" type="text/css" media="screen, projection"/> | ||
|
|
||
|
|
||
| </head> | ||
| <body class="color_scheme-github"> | ||
| <a class="page prev nav" href="Advanced-Configurations-Example.html"> | ||
| <span class="space"> </span> | ||
| <span class="flip arrow">></span> | ||
| </a><a class="page next nav" href="Detailed-Topics.html"> | ||
| <span class="space"> </span> | ||
| <span class="arrow">></span> | ||
| </a> | ||
| <div class="container contentswrapper"> | ||
| <div class="span-16 prepend-1 append-1 contents"> | ||
| <h2 id="Advanced+command+example">Advanced command example<a href="#Advanced+command+example" class="header-link"><span class="header-link-content"> </span></a></h2><p>This is an advanced example showing some of the power of the new | ||
| settings system. It shows how to temporarily modify all declared | ||
| dependencies in the build, regardless of where they are defined. It | ||
| directly operates on the final <code>Seq[Setting[_]]</code> produced from every | ||
| setting involved in the build. | ||
| </p><p>The modifications are applied by running <em>canonicalize</em>. A <em>reload</em> or | ||
| using <em>set</em> reverts the modifications, requiring <em>canonicalize</em> to be | ||
| run again. | ||
| </p><p>This particular example shows how to transform all declared dependencies | ||
| on ScalaCheck to use version 1.8. As an exercise, you might try | ||
| transforming other dependencies, the repositories used, or the scalac | ||
| options used. It is possible to add or remove settings as well. | ||
| </p><p>This kind of transformation is possible directly on the settings of | ||
| Project, but it would not include settings automatically added from | ||
| plugins or build.sbt files. What this example shows is doing it | ||
| unconditionally on all settings in all projects in all builds, including | ||
| external builds. | ||
| </p><pre><code class="prettyprint lang-scala">import sbt._ | ||
| import Keys._ | ||
|
|
||
| object Canon extends Plugin { | ||
| // Registers the canonicalize command in every project | ||
| override def settings = Seq(commands += canonicalize) | ||
|
|
||
| // Define the command. This takes the existing settings (including any session settings) | ||
| // and applies 'f' to each Setting[_] | ||
| def canonicalize = Command.command("canonicalize") { (state: State) => | ||
| val extracted = Project.extract(state) | ||
| import extracted._ | ||
| val transformed = session.mergeSettings map ( s => f(s) ) | ||
| val newStructure = Load.reapply(transformed, structure) | ||
| Project.setProject(session, newStructure, state) | ||
| } | ||
|
|
||
| // Transforms a Setting[_]. | ||
| def f(s: Setting[_]): Setting[_] = s.key.key match { | ||
| // transform all settings that modify libraryDependencies | ||
| case Keys.libraryDependencies.key => | ||
| // hey scalac. T == Seq[ModuleID] | ||
| s.asInstanceOf[Setting[Seq[ModuleID]]].mapInit(mapLibraryDependencies) | ||
| // preserve other settings | ||
| case _ => s | ||
| } | ||
| // This must be idempotent because it gets applied after every transformation. | ||
| // That is, if the user does: | ||
| // libraryDependencies += a | ||
| // libraryDependencies += b | ||
| // then this method will be called for Seq(a) and Seq(a,b) | ||
| def mapLibraryDependencies(key: ScopedKey[Seq[ModuleID]], value: Seq[ModuleID]): Seq[ModuleID] = | ||
| value map mapSingle | ||
|
|
||
| // This is the fundamental transformation. | ||
| // Here we map all declared ScalaCheck dependencies to be version 1.8 | ||
| def mapSingle(module: ModuleID): ModuleID = | ||
| if(module.name == "scalacheck") module.copy(revision = "1.8") | ||
| else module | ||
| } | ||
| </code></pre><div class="bottom nav span-16"> | ||
| <em>Next Page</em> | ||
| <span class="arrow">></span> | ||
| <a href="Detailed-Topics.html"> Detailed Topics </a> | ||
|
|
||
| </div><div class="tocwrapper show"> | ||
| <a class="tochead nav" style="display: none" href="#toc">❦</a> | ||
| <a name="toc"></a> | ||
| <h4 class="toctitle">Contents</h4> | ||
| <div class="tocbody"> | ||
| <div><a href="index.html">sbt Reference Manual</a></div><ol class="toc"> <li><div><a href="General-Info.html">General Information</a></div><ol class="toc"> <li><div><a href="Credits.html">Credits</a></div></li><li><div><a href="Community-Plugins.html">Community Plugins</a></div></li><li><div><a href="Repository-Roles.html">Community Repository Policy</a></div></li><li><div><a href="Bintray-For-Plugins.html">Bintray For Plugins</a></div></li><li><div><a href="Setup-Notes.html">Setup Notes</a></div></li><li><div><a href="Using-Sonatype.html">Deploying to Sonatype</a></div></li><li><div><a href="Changes.html">Changes</a></div><ol class="toc"> <li><div><a href="ChangeSummary_0.13.0.html">sbt 0.13.0 Changes</a></div></li><li><div><a href="ChangeSummary_0.12.0.html">sbt 0.12.0 Changes</a></div></li><li><div><a href="Older-Changes.html">Older Changes</a></div></li><li><div><a href="Migrating-from-sbt-07x.html">Migrating from 0.7 to 0.10+</a></div></li> </ol></li><li><div><a href="Contibuting-to-sbt.html">Contributing to sbt</a></div></li> </ol></li><li><div><a href="Faq.html">Frequently Asked Questions</a></div><ol class="toc"> </ol></li><li><div><a href="Howto.html">How to…</a></div><ol class="toc"> <li><div><a href="Howto-Classpaths.html">Classpaths</a></div></li><li><div><a href="Howto-Customizing-Paths.html">Customizing paths</a></div></li><li><div><a href="Howto-Generating-Files.html">Generating files</a></div></li><li><div><a href="Howto-Inspect-the-Build.html">Inspect the build</a></div></li><li><div><a href="Howto-Interactive-Mode.html">Interactive mode</a></div></li><li><div><a href="Howto-Logging.html">Configure and use logging</a></div></li><li><div><a href="Howto-Project-Metadata.html">Project metadata</a></div></li><li><div><a href="Howto-Package.html">Configure packaging</a></div></li><li><div><a href="Howto-Running-Commands.html">Running commands</a></div></li><li><div><a href="Howto-Scala.html">Configure and use Scala</a></div></li><li><div><a href="Howto-Scaladoc.html">Generate API documentation</a></div></li><li><div><a href="Howto-Triggered.html">Triggered execution</a></div></li><li><div><a href="Examples.html">Examples</a></div><ol class="toc"> <li><div><a href="Basic-Def-Examples.html">.sbt build examples</a></div></li><li><div><a href="Full-Def-Example.html">.scala build example</a></div></li><li><div><a href="Advanced-Configurations-Example.html">Advanced configurations example</a></div></li><li><div class="current">Advanced command example</div></li> </ol></li> </ol></li><li><div><a href="Detailed-Topics.html">Detailed Topics</a></div><ol class="toc"> <li><div><a href="Using-sbt.html">Using sbt</a></div><ol class="toc"> <li><div><a href="Command-Line-Reference.html">Command Line Reference</a></div></li><li><div><a href="Console-Project.html">Console Project</a></div></li><li><div><a href="Cross-Build.html">Cross-building</a></div></li><li><div><a href="Inspecting-Settings.html">Interacting with the Configuration System</a></div></li><li><div><a href="Triggered-Execution.html">Triggered Execution</a></div></li><li><div><a href="Scripts.html">Scripts, REPL, and Dependencies</a></div></li><li><div><a href="Understanding-Recompilation.html">Understanding Incremental Recompilation</a></div></li> </ol></li><li><div><a href="Configuration-Index.html">Configuration</a></div><ol class="toc"> <li><div><a href="Classpaths.html">Classpaths, sources, and resources</a></div></li><li><div><a href="Compiler-Plugins.html">Compiler Plugin Support</a></div></li><li><div><a href="Configuring-Scala.html">Configuring Scala</a></div></li><li><div><a href="Forking.html">Forking</a></div></li><li><div><a href="Global-Settings.html">Global Settings</a></div></li><li><div><a href="Java-Sources.html">Java Sources</a></div></li><li><div><a href="Mapping-Files.html">Mapping Files</a></div></li><li><div><a href="Local-Scala.html">Local Scala</a></div></li><li><div><a href="Macro-Projects.html">Macro Projects</a></div></li><li><div><a href="Paths.html">Paths</a></div></li><li><div><a href="Parallel-Execution.html">Parallel Execution</a></div></li><li><div><a href="Process.html">External Processes</a></div></li><li><div><a href="Running-Project-Code.html">Running Project Code</a></div></li><li><div><a href="Testing.html">Testing</a></div></li> </ol></li><li><div><a href="Dependency-Management-Index.html">Dependency Management</a></div><ol class="toc"> <li><div><a href="Artifacts.html">Artifacts</a></div></li><li><div><a href="Dependency-Management-Flow.html">Dependency Management Flow</a></div></li><li><div><a href="Library-Management.html">Library Management</a></div></li><li><div><a href="Proxy-Repositories.html">Proxy Repositories</a></div></li><li><div><a href="Publishing.html">Publishing</a></div></li><li><div><a href="Resolvers.html">Resolvers</a></div></li><li><div><a href="Update-Report.html">Update Report</a></div></li> </ol></li><li><div><a href="Tasks-and-Commands.html">Tasks and Commands</a></div><ol class="toc"> <li><div><a href="Tasks.html">Tasks</a></div></li><li><div><a href="Input-Tasks.html">Input Tasks</a></div></li><li><div><a href="Commands.html">Commands</a></div></li><li><div><a href="Parsing-Input.html">Parsing and tab completion</a></div></li><li><div><a href="Build-State.html">State and actions</a></div></li><li><div><a href="Task-Inputs.html">Tasks/Settings: Motivation</a></div></li> </ol></li><li><div><a href="Plugins-and-Best-Practices.html">Plugins and Best Practices</a></div><ol class="toc"> <li><div><a href="Best-Practices.html">General Best Practices</a></div></li><li><div><a href="Plugins.html">Plugins</a></div></li><li><div><a href="Plugins-Best-Practices.html">Plugins Best Practices</a></div></li> </ol></li><li><div><a href="Sbt-Launcher.html">Sbt Launcher</a></div><ol class="toc"> <li><div><a href="Launcher-Getting-Started.html">Getting Started with the Sbt Launcher</a></div></li><li><div><a href="Launcher-Architecture.html">Sbt Launcher Architecture</a></div></li><li><div><a href="Launcher-Configuration.html">Sbt Launcher Configuration</a></div></li> </ol></li> </ol></li><li><div><a href="Developers-Guide.html">Developer’s Guide</a></div><ol class="toc"> <li><div><a href="Core-Principles.html">Core Principles</a></div></li><li><div><a href="Settings-Core.html">Settings Core</a></div></li><li><div><a href="Setting-Initialization.html">Setting Initialization</a></div></li><li><div><a href="Build-Loaders.html">Build Loaders</a></div></li><li><div><a href="Command-Line-Applications.html">Creating Command Line Applications Using sbt</a></div></li><li><div><a href="Nightly-Builds.html">Nightly Builds</a></div></li> </ol></li><li><div><a href="Name-Index.html">Index</a></div></li><li class="generated"><div><a href="Contents+in+Depth.html">Contents in Depth</a></div></li><li class="generated"><div><a href="Combined+Pages.html">Combined Pages</a></div></li> </ol></div></div> | ||
| </div> | ||
| </div> | ||
| <div class="header"> | ||
| <link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:400,600,700,900,400italic,700italic" rel="stylesheet" type="text/css"> | ||
| <div class="container navbar-static-top nav"> | ||
| <div class="logo"> | ||
| <a href="../../index.html"><img src="files/sbt-logo-white-72x50.png" alt="sbt"></a> | ||
| </div> | ||
| <ul class="navlist"> | ||
| <li><a href="../../documentation.html">Documentation</a></li> | ||
| <li><a href="../../download.html">Download</a></li> | ||
| <li><a href="../../community.html">Community</a></li> | ||
| <li id="source-code"><a href="https://github.com/sbt/sbt"><img src="files/github-logo.png" alt="Source code"></a></li> | ||
| <li id="twitter"><a href="https://twitter.com/scala_sbt"><img src="files/twitter-logo-white.png" alt="sbt on Twitter"></a></li> | ||
| </ul> | ||
| </div> | ||
|
|
||
| </div> | ||
| <div class="footer"> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.