├── .git-blame-ignore-revs ├── .github └── workflows │ ├── scala-project-template.yml │ ├── scala-steward.yml │ └── scala.yml ├── .gitignore ├── .scalafmt.conf ├── .vscode └── settings.json ├── LICENSE ├── NOTICE ├── README.md ├── README.png ├── build.sbt ├── project ├── build.properties └── sbt-best-practice.sbt ├── pubring.asc ├── secret.sbt └── src └── main └── scala └── com └── thoughtworks └── sbtScalaJsMap └── ScalaJsMap.scala /.git-blame-ignore-revs: -------------------------------------------------------------------------------- 1 | # Scala Steward: Reformat with scalafmt 3.1.2 2 | fb6cfb8aea15a1b339e3ed69e1e96acd7df4cae6 3 | 4 | # Scala Steward: Reformat with scalafmt 3.7.9 5 | 8ff009734ef47bf27bc49adac25fab17b41d4f5d 6 | -------------------------------------------------------------------------------- /.github/workflows/scala-project-template.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches-ignore: 4 | - "update/**" 5 | schedule: 6 | - cron: "0 0 * * 0" 7 | workflow_dispatch: 8 | 9 | name: Update Scala project template 10 | 11 | jobs: 12 | update-scala-project-template: 13 | permissions: 14 | # for peter-evans/create-pull-request to create branch 15 | contents: write 16 | # for peter-evans/create-pull-request to create a PR 17 | pull-requests: write 18 | runs-on: ubuntu-22.04 19 | steps: 20 | - uses: actions/checkout@v3 21 | - run: git fetch https://github.com/Atry/scala-project-template.git template 22 | - run: git reset --hard FETCH_HEAD 23 | - uses: peter-evans/create-pull-request@v5 24 | continue-on-error: true 25 | with: 26 | delete-branch: true 27 | base: ${{github.ref_name}} 28 | branch: update/${{github.ref_name}}/scala-project-template 29 | title: Update scala-project-template 30 | token: ${{ secrets.PERSONAL_ACCESS_TOKEN || github.token }} 31 | -------------------------------------------------------------------------------- /.github/workflows/scala-steward.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | branches-ignore: 4 | - "update/**" 5 | schedule: 6 | - cron: "0 0 * * 0" 7 | workflow_dispatch: 8 | 9 | name: Launch Scala Steward 10 | 11 | jobs: 12 | scala-steward: 13 | runs-on: ubuntu-22.04 14 | name: Launch Scala Steward 15 | steps: 16 | - name: Launch Scala Steward 17 | uses: scala-steward-org/scala-steward-action@v2 18 | with: 19 | github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN || github.token }} 20 | branches: ${{ github.ref_name }} 21 | -------------------------------------------------------------------------------- /.github/workflows/scala.yml: -------------------------------------------------------------------------------- 1 | name: Scala CI 2 | 3 | on: 4 | push: 5 | branches-ignore: 6 | - "update/**" 7 | tags: 8 | - "v*" 9 | pull_request: 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | strategy: 16 | fail-fast: false 17 | matrix: 18 | scala: 19 | - 2.12.15 20 | 21 | steps: 22 | - uses: actions/checkout@v3 23 | with: 24 | fetch-depth: 0 # Need the git history for sbt-dynver to determine the version 25 | - name: Set up JDK 11 26 | uses: actions/setup-java@v3 27 | with: 28 | java-version: "11" 29 | distribution: temurin 30 | - name: Cache SBT 31 | uses: actions/cache@v3 32 | with: 33 | path: | 34 | ~/.ivy2/local/ 35 | ~/.ivy2/cache/ 36 | ~/.sbt/ 37 | ~/.coursier/ 38 | key: | 39 | ${{runner.os}}-${{matrix.scala}}-${{hashFiles('**/*.sbt')}}-${{matrix.sbt-args}} 40 | ${{runner.os}}-${{matrix.scala}}-${{hashFiles('**/*.sbt')}}- 41 | ${{runner.os}}-${{matrix.scala}}- 42 | - name: Run tests 43 | run: sbt ${{matrix.sbt-args}} ++${{ matrix.scala }} test 44 | - name: Publish to Maven Central Repository 45 | env: 46 | GITHUB_PERSONAL_ACCESS_TOKEN: ${{secrets.PERSONAL_ACCESS_TOKEN}} 47 | if: ${{ env.GITHUB_PERSONAL_ACCESS_TOKEN != '' && github.event_name != 'pull_request' }} 48 | run: sbt ${{matrix.sbt-args}} ++${{ matrix.scala }} "set every Seq(sonatypeSessionName := \"${{github.workflow}} ${{github.run_id}}-${{github.run_number}}-${{github.run_attempt}}-$$ ${{ matrix.scala }}\", publishTo := sonatypePublishToBundle.value)" publishSigned sonatypeBundleRelease 49 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | *.log 3 | 4 | # sbt specific 5 | .cache 6 | .history 7 | .lib/ 8 | dist/* 9 | target/ 10 | lib_managed/ 11 | src_managed/ 12 | project/boot/ 13 | project/plugins/project/ 14 | 15 | # Scala-IDE specific 16 | .scala_dependencies 17 | .worksheet 18 | 19 | # IntelliJ IDEA 20 | .idea/ 21 | 22 | # Files created for deployment 23 | secret/ 24 | local.sbt 25 | secret/ 26 | .metals/ 27 | .bloop/ 28 | metals.sbt 29 | .bsp/ 30 | .vscode/launch.json 31 | *.scala.semanticdb 32 | -------------------------------------------------------------------------------- /.scalafmt.conf: -------------------------------------------------------------------------------- 1 | runner.dialect = scala212source3 2 | version = "3.7.9" 3 | maxColumn = 80 4 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.watcherExclude": { 3 | "**/target": true 4 | } 5 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Copyright 2016 ThoughtWorks, Inc. 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); 4 | you may not use this file except in compliance with the License. 5 | You may obtain a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, 11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | See the License for the specific language governing permissions and 13 | limitations under the License. 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # sbt-scala-js-map 2 | 3 | [![Build Status](https://travis-ci.org/ThoughtWorksInc/sbt-scala-js-map.svg)](https://travis-ci.org/ThoughtWorksInc/sbt-scala-js-map) 4 | [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.thoughtworks.sbt-scala-js-map/sbt-scala-js-map/badge.svg)](https://repo1.maven.org/maven2/com/thoughtworks/sbt-scala-js-map/) 5 | 6 | **sbt-scala-js-map** is a Sbt plugin that configures source mapping for Scala.js projects hosted on Github. 7 | 8 | ## Motivation 9 | 10 | I have some Scala.js libraries hosted on Github ([Binding.scala](https://github.com/ThoughtWorksInc/Binding.scala) and some private libraries). Then, other Scala.js applications would depend on these libraries. When I debug the Scala.js application in a browser, I want to see the Scala source files of the original libraries. 11 | 12 | However, by default, the generated `*.js.map` files maps the generated JavaScript to the absolute Scala source path where the original library compiled. For me, the path is on a Travis CI worker, like `/home/travis/build/ThoughtWorksInc/.../Binding.scala`. The path obviously does not exist on my local computer that debugs the application. Too bad. 13 | 14 | This sbt plugin detects if a library is hosted on Github repository and let source map point to https://raw.githubusercontent.com/ instead of a local file path. 15 | 16 | ### Showcase 17 | 18 | Browse http://todomvc.com/examples/binding-scala/ then open the inspector of your browser. You will be able to debug the Scala.js code in your browser now. 19 | 20 | ![Debugging Scala.js](https://github.com/ThoughtWorksInc/sbt-scala-js-map/raw/master/README.png) 21 | 22 | ### Alternative options 23 | 24 | An alternative option is specifying Scala.js's relative source mappings flag. 25 | 26 | However, this approach enforce library users cloning the library's source files into their local file system before debugging their applications. 27 | 28 | On the other hand, libraries published with this plugin enable the library users to view the source (of correct revision), automatically. 29 | 30 | ## Usage 31 | 32 | ### Step 1: Add the dependencies in your Scala.js library's `project/plugins.sbt` 33 | 34 | ``` sbt 35 | addSbtPlugin("com.thoughtworks.sbt-scala-js-map" % "sbt-scala-js-map" % "latest.release") 36 | ``` 37 | 38 | Note that sbt-scala-js-map 2.x requires sbt 0.13.x, sbt-api-mappings 3.x requires sbt 1.x. 39 | 40 | 41 | ### Step 2: Publish your Scala.js library 42 | 43 | Execute the release command if you have setup [sbt-release](https://github.com/sbt/sbt-release) correctly。 44 | 45 | ``` 46 | sbt release 47 | ``` 48 | 49 | ### Step 3: Debug it! 50 | 51 | Now switch your Scala.js application to the newly published Scala.js library, build it, browse your web page, and open the debugger in your browser. You will see the Scala source files hosted under https://raw.githubusercontent.com/ and you can set break points at code lines in these Scala files. 52 | -------------------------------------------------------------------------------- /README.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ThoughtWorksInc/sbt-scala-js-map/4da053d2b7f03f6456aef2bec5728e788045e677/README.png -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | sbtPlugin := true 2 | 3 | name := "sbt-scala-js-map" 4 | 5 | organization := "com.thoughtworks.sbt-scala-js-map" 6 | 7 | description := "A Sbt plugin that setup source mapping for Scala.js projects hosted on Github" 8 | 9 | startYear := Some(2016) 10 | 11 | addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.16.0") 12 | 13 | libraryDependencies += "org.eclipse.jgit" % "org.eclipse.jgit" % "6.6.0.202305301015-r" 14 | -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=1.9.2 2 | -------------------------------------------------------------------------------- /project/sbt-best-practice.sbt: -------------------------------------------------------------------------------- 1 | addSbtPlugin( 2 | "com.thoughtworks.sbt-best-practice" % "sbt-best-practice" % "8.3.1" 3 | ) 4 | -------------------------------------------------------------------------------- /pubring.asc: -------------------------------------------------------------------------------- 1 | -----BEGIN PGP PUBLIC KEY BLOCK----- 2 | Version: BCPG v1.51 3 | 4 | mQENBFapKd0BCACEjOwIKC6OXozOeNjocDA24rQCw1H6ChvhbXcdY0T9MVHMmL4M 5 | PRrc6r7niAO2jCV0zMl2ogAy53qmlBbfam0+9YWzwHEmHaf4MAUbgxkNDRo2U2Gl 6 | ZJmTsdMcJMApMsSkhGAuWEpNr2sWx3oZzKsmy99j7pTnSYDZ5bpel4cxJYvDa5uX 7 | O4nqJmotm8aPcrl7gN7bzFvBter8M3o0BSUKpCGebwgrEqf4UJ6meC6ih5dHwyH7 8 | tmfDjNhsj1LoEY0tIoT7RmAIYu0Xkr3g55hctLTFMhoB15U4itQHLlV0REDltumi 9 | 10az1flp7m1YV9am3ZwEt2TyaBbSKtd9wHWTABEBAAG0HFlhbmcgQm8gPHBvcC5h 10 | dHJ5QGdtYWlsLmNvbT6JARwEEwECAAYFAlapKd0ACgkQWeOsiuc+fAmRxQf9E+4N 11 | Cc/q4TsZ0wOjeo5zlHGEIpF4Yw4sdJO3XVHeTscKjzD6bDt0xXPSQHpS2cozQeMa 12 | unIl8WltoqGzpVV0B89ywZFvAEPlHCFzPtmpNeoJ3WKDFUkm/OO0wihlRKXf5D4E 13 | nMaUpb4qBh3zyhhgN+VeySmwPNMfQO9Z7wekdZNVuxYweiC4jk89MGeQbfQOXHV3 14 | w4CY+M84PciO1lQeN0SgGXL/lyhrgQxKYERVn0iLypZBeiq2uQLXrFSO/UAWBTCW 15 | M8pR3woNRWoBdo4IMVDl579RO+kztm//9PbYFhb/h9gPWN2bO2U7bsIdQYRVV6OI 16 | RZpu6Y3T9l3knLvJGg== 17 | =2YuA 18 | -----END PGP PUBLIC KEY BLOCK----- 19 | -------------------------------------------------------------------------------- /secret.sbt: -------------------------------------------------------------------------------- 1 | lazy val secret = { 2 | for (token <- sys.env.get("GITHUB_PERSONAL_ACCESS_TOKEN")) yield { 3 | val secret = project.settings(publish / skip := true).in { 4 | val secretDirectory = file(sourcecode.File()).getParentFile / "secret" 5 | IO.delete(secretDirectory) 6 | org.eclipse.jgit.api.Git 7 | .cloneRepository() 8 | .setURI( 9 | "https://github.com/Atry/secrets.git" 10 | ) 11 | .setDirectory(secretDirectory) 12 | .setCredentialsProvider( 13 | new org.eclipse.jgit.transport.UsernamePasswordCredentialsProvider( 14 | token, 15 | "" 16 | ) 17 | ) 18 | .call() 19 | .close() 20 | secretDirectory 21 | } 22 | secret 23 | } 24 | }.getOrElse(null) 25 | -------------------------------------------------------------------------------- /src/main/scala/com/thoughtworks/sbtScalaJsMap/ScalaJsMap.scala: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright 2016 ThoughtWorks, Inc. 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | package com.thoughtworks.sbtScalaJsMap 18 | 19 | import java.net._ 20 | 21 | import org.eclipse.jgit.api.Git 22 | import org.eclipse.jgit.lib.ConfigConstants._ 23 | import org.eclipse.jgit.lib.Constants._ 24 | import org.eclipse.jgit.revwalk.{RevWalk, RevWalkUtils} 25 | import org.eclipse.jgit.storage.file.FileRepositoryBuilder 26 | import org.eclipse.jgit.transport.RemoteConfig 27 | import org.scalajs.sbtplugin.ScalaJSPlugin 28 | import sbt.Keys._ 29 | import sbt._ 30 | 31 | import scala.collection.JavaConverters._ 32 | import org.eclipse.jgit.transport.URIish 33 | 34 | object ScalaJsMap extends AutoPlugin { 35 | 36 | object autoImport { 37 | 38 | val gitRemoteUris = 39 | settingKey[Seq[URIish]]("The remote git URIs to host the source code.") 40 | val isLatestSourcePushed = 41 | settingKey[Boolean]( 42 | "Determine if the latest source files have been pushed to the remote git repository." 43 | ) 44 | val scalaJsMapToGithubScalacOptions = settingKey[Seq[String]]( 45 | "The scalac options to create Scala.js source map to the corresponding Github URI if any." 46 | ) 47 | 48 | } 49 | 50 | import autoImport._ 51 | 52 | override def globalSettings: Seq[Setting[_]] = Seq( 53 | gitRemoteUris := Seq.empty, 54 | scalaJsMapToGithubScalacOptions := Seq.empty 55 | ) 56 | 57 | override final def projectSettings = 58 | Seq( 59 | gitRemoteUris ++= { 60 | val repositoryBuilder = 61 | new FileRepositoryBuilder().findGitDir(sourceDirectory.value) 62 | if (repositoryBuilder.getGitDir == null) { 63 | Seq.empty 64 | } else { 65 | val repository = repositoryBuilder.build() 66 | try { 67 | new RemoteConfig( 68 | repository.getConfig, 69 | DEFAULT_REMOTE_NAME 70 | ).getURIs.asScala 71 | } finally { 72 | repository.close() 73 | } 74 | } 75 | }, 76 | scalaJsMapToGithubScalacOptions ++= { 77 | val repositoryBuilder = 78 | new FileRepositoryBuilder().findGitDir(sourceDirectory.value) 79 | val repository = repositoryBuilder.build() 80 | val head = 81 | try { 82 | repository.resolve(HEAD) 83 | } finally { 84 | repository.close() 85 | } 86 | if (repositoryBuilder.getGitDir == null) { 87 | None 88 | } else { 89 | gitRemoteUris.value.collectFirst { 90 | case url if url.getHost == "github.com" => 91 | val path = url.getPath 92 | val slug = if (path.endsWith(DOT_GIT_EXT)) { 93 | path.substring(0, path.length - DOT_GIT_EXT.length) 94 | } else { 95 | path 96 | } 97 | val key = CrossVersion.partialVersion(scalaVersion.value) match { 98 | case Some((3, _)) => 99 | "-scalajs-mapSourceURI" 100 | case _ => 101 | "-P:scalajs:mapSourceURI" 102 | } 103 | raw"""$key:${repositoryBuilder.getWorkTree.toURI}->https://github.com/$slug/raw/${head.name}/""" 104 | } 105 | } 106 | }, 107 | isLatestSourcePushed := { 108 | def isCi = sys.env.contains("CI") 109 | def isLatestSourcePushedFromWorkTree = { 110 | val repositoryBuilder = 111 | new FileRepositoryBuilder().findGitDir(sourceDirectory.value) 112 | if (repositoryBuilder.getGitDir == null) { 113 | false 114 | } else { 115 | val repository = repositoryBuilder.build() 116 | try { 117 | val git = new Git(repository) 118 | try { 119 | def isClean = git.status().call().isClean 120 | def unreachableOriginBranches = { 121 | val head = repository.resolve(HEAD) 122 | val revWalk = new RevWalk(repository) 123 | try { 124 | RevWalkUtils 125 | .findBranchesReachableFrom( 126 | revWalk.lookupCommit(head), 127 | revWalk, 128 | repository.getRefDatabase 129 | .getRefsByPrefix(s"$R_REMOTES$DEFAULT_REMOTE_NAME/") 130 | ) 131 | .isEmpty 132 | } finally { 133 | revWalk.close() 134 | } 135 | } 136 | isClean && !unreachableOriginBranches 137 | } finally { 138 | git.close() 139 | } 140 | } finally { 141 | repository.close() 142 | } 143 | } 144 | } 145 | isCi || isLatestSourcePushedFromWorkTree 146 | }, 147 | scalacOptions ++= { 148 | if (isLatestSourcePushed.value) { 149 | scalaJsMapToGithubScalacOptions.value 150 | } else { 151 | Seq.empty 152 | } 153 | } 154 | ) 155 | 156 | override final def requires = ScalaJSPlugin 157 | 158 | override def trigger = allRequirements 159 | 160 | } 161 | 162 | // vim: set ts=2 sw=2 et: 163 | --------------------------------------------------------------------------------