├── CONTRIBUTING.md ├── LICENSE ├── README.md └── scalafix.conf /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | pending [https://github.com/scalaz/scalazzi/issues/3] 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Scalazzi 2 | 3 | This project is configuration to enforce the [scalazzi](http://yowconference.com.au/slides/yowwest2014/Morris-ParametricityTypesDocumentationCodeReadability.pdf) safe subset of scala with [scalafix](https://github.com/scalacenter/scalafix). 4 | 5 | To install, first install the beta version of scalafix, e.g. in `project/plugins.sbt` 6 | 7 | ```scala 8 | addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.6.0-M12") 9 | ``` 10 | 11 | and enable the compiler plugin for each project in `build.sbt` 12 | 13 | ```scala 14 | scalacOptions += "-Yrangepos" 15 | addCompilerPlugin(scalafixSemanticdb) 16 | ``` 17 | 18 | If anything goes wrong, you can ask on the [scalacenter/scalafix](https://gitter.im/scalacenter/scalafix) channel but be aware that this is a pre-release and you are expected to read the scalafix and sbt-scalafix source code rather than refer to the older release's documentation. 19 | 20 | Copy the `scalafix.conf` from here to `.scalafix.conf` in your project root and run `scalafix` in your sbt shell. 21 | 22 | As an added bonus, you are also now set up to beta test [Metals](https://github.com/scalameta/metals) and [Metadoc](https://github.com/scalameta/metadoc). 23 | 24 | If you would like to contribute to this initiative you can: 25 | 26 | - pick up the tickets in this repo to ease installation and extensibility 27 | - [expand the list of manually verified "safe" methods](CONTRIBUTING.md) 28 | - [implement and improve scalazzi rules inside scalafix](https://github.com/scalacenter/scalafix/issues?q=is%3Aissue+is%3Aopen+label%3Ascalazzi) 29 | -------------------------------------------------------------------------------- /scalafix.conf: -------------------------------------------------------------------------------- 1 | # Copyright: 2018 Sam Halliday 2 | # License: https://www.apache.org/licenses/LICENSE-2.0 3 | 4 | # This file enforces the scalazzi safe subset of scala. 5 | # 6 | # For further information, see https://github.com/scalaz/scalazzi 7 | 8 | rules = [ 9 | Disable 10 | DisableSyntax 11 | ExplicitResultTypes 12 | LeakingImplicitClassVal 13 | MissingFinal 14 | NoAutoTupling 15 | NoValInForComprehension 16 | ProcedureSyntax 17 | RemoveUnused 18 | ] 19 | 20 | Disable.symbols = [ 21 | { 22 | regex = "^\\Qscala/collection/mutable\\E.*$" 23 | message = "Java collections have better performance, which is what I assume you were trying to do" 24 | } 25 | { 26 | regex = "^\\Qscala/collection/parallel\\E.*$" 27 | message = "parallel collections are low performance and block the thread, prefer scalaz.ApplyN" 28 | } 29 | { 30 | regex = "^\\Qscala/math/Big\\E.*$" 31 | message = "scala arbitrary precision numbers are broken: https://github.com/scala/bug/issues/9670" 32 | } 33 | { 34 | regex = { 35 | includes = [ 36 | "^\\Qjava/io\\E.*$" 37 | "^\\Qscala/io/Source\\E.*$" 38 | ] 39 | } 40 | message = "legacy blocking API, prefer java.nio" 41 | } 42 | { 43 | regex = "^\\Qjava/net/URL#\\E.*$" 44 | message = "URL talks to the network for equality, prefer URI" 45 | } 46 | { 47 | regex = { 48 | includes = [ 49 | # overrides not fully implemented: https://github.com/scalacenter/scalafix/pull/634 50 | "^.*\\Q#equals().\\E$" 51 | "^.*\\Q#hashCode().\\E$" 52 | "^.*\\Q#toString().\\E$" # doesn't catch string interpolators... 53 | # more to add here... 54 | ] 55 | } 56 | message = "prefer scalaz.{Equal, Show, Liskov, etc}" 57 | } 58 | 59 | { 60 | symbol = "scala/Enumeration" 61 | message = "prefer a sealed abstract class" 62 | } 63 | 64 | { 65 | regex = { 66 | includes = [ 67 | "^\\Qscala/util/Either.LeftProjection#get().\\E$" 68 | "^\\Qscala/util/Either.RightProjection#get().\\E$" 69 | "^\\Qscala/util/Try#get().\\E$" 70 | "^\\Qscala/Option#get().\\E$" 71 | "^\\Qscala/collection/IterableLike#head().\\E$" 72 | ] 73 | } 74 | message = "not a total function" 75 | } 76 | ] 77 | 78 | Disable.ifSynthetic = [ 79 | "java/io/Serializable" 80 | "scala/Any" 81 | "scala/Product" 82 | 83 | # local type inference + covariant types fires this 84 | # "scala/Nothing" 85 | 86 | # when upstream broke noImplicitConversion and we don't agree that their 87 | # implicits are worth the mental burden. 88 | "scala/Option.option2Iterable" 89 | "scala/Predef.any2stringadd" 90 | 91 | # I don't understand why these are synthetic 92 | # https://github.com/scalacenter/scalafix/issues/703 93 | { 94 | regex = { 95 | includes = [ 96 | "^\\Qscala/collection/MapLike#apply().\\E$" 97 | "^\\Qscala/collection/LinearSeqOptimized#apply().\\E$" 98 | ] 99 | } 100 | message = "not a total function" 101 | } 102 | ] 103 | 104 | Disable.unlessInside = [ 105 | { 106 | safeBlocks = [ 107 | "fommil/std/IO" 108 | "scalaz/ioeffect/IO" 109 | "scalaz/ioeffect/Task" 110 | "scalaz/ApplicativeError.handleError" 111 | "scalaz/ApplicativeError.raiseError" 112 | "scalaz/syntax/ApplicativeErrorOps.handleError" 113 | "scalaz/syntax/ApplicativeErrorOps.recover" 114 | "scalaz/syntax/MonadErrorOps.emap" 115 | "scalaz/zio/IO" 116 | "scalaz/zio/Task" 117 | "scalaz/zio/UIO" 118 | "scalaz/zio/ZIO" 119 | "scalaz/zio/ZIO_E_Throwable.effect" 120 | "scalaz/zio/ZIOFunctions.effectAsync" 121 | "scalaz/zio/ZIOFunctions.effectTotal" 122 | "scalaz/zio/ZIOFunctions.effectTotalWith" 123 | "scalaz/zio/ZIOFunctions.fail" 124 | "scalaz/zio/ZIOFunctions.halt" 125 | ] 126 | symbols = [ 127 | { 128 | # This takes the approach of banning everything and then blessing things 129 | # we trust. It would be entirely feasible to do it the other way and 130 | # list the explicit list of things that we need to go through IO, but it 131 | # is less safe. We can have another rule if something in an "excludes" 132 | # glob catches unsafe things. 133 | # 134 | # If something is referentially transparent but not total, instead of 135 | # adding to this excludes list, add it to the includes list of the 136 | # scalaz.Maybe.attempt safeBlock. If it can return `null`, add it to a 137 | # scalaz.Maybe.fromNullable safeBlock. 138 | regex = { 139 | includes = [ 140 | "^\\Qjava/\\E.*$" 141 | #"^.*$" 142 | ] 143 | excludes = [ 144 | "^fommil.*$" 145 | "^scalaz.*$" 146 | "^\\Qjava/lang/String#\\E.*$" 147 | "^\\Qjava/time/Instant#\\E.*$" 148 | "^\\Qjava/time/ZonedDateTime#\\E.*$" 149 | "^\\Qjava/time/temporal/ChronoUnit#\\E.*$" 150 | "^\\Qjava/net/URI#\\E.*$" 151 | "^\\Qjava/net/URLEncoder#\\E.*$" 152 | "^\\Qjava/net/URLDecoder#\\E.*$" 153 | # primitives are not supported: https://github.com/scalameta/scalameta/issues/1488 154 | 155 | # WORKAROUND https://github.com/scalacenter/scalafix/issues/715 156 | "^\\Qjava/\\E$" 157 | "^\\Qjava/lang/\\E$" 158 | "^\\Qjava/time/\\E$" 159 | "^\\Qjava/net\\E$" 160 | ] 161 | } 162 | message = "Untrusted third party library must be called from IO, or blessed in scalafix.conf" 163 | } 164 | ] 165 | } 166 | { 167 | safeBlocks = [ 168 | "scalaz/`\/`.fromTryCatchNonFatal", 169 | "scalaz/`\/`.fromTryCatchThrowable", 170 | "scalaz/Maybe.attempt", 171 | "scalaz/Maybe.fromTryCatchNonFatal", 172 | "scalaz/Maybe.fromTryCatchThrowable" 173 | ] 174 | symbols = [ 175 | { 176 | regex = { 177 | includes = [ 178 | # should live in a common file so we don't need to duplicate 179 | "^\\Qjava/net/URLEncoder#\\E.*$" 180 | "^\\Qjava/net/URLDecoder#\\E.*$" 181 | ] 182 | excludes = [ 183 | ] 184 | } 185 | message = "Deterministic method is not total, must be called via Maybe.attempt, \/.fromTryCatchNonFatal, etc." 186 | } 187 | ] 188 | } 189 | ] 190 | 191 | DisableSyntax { 192 | noAsInstanceOf = true 193 | noContravariantTypes = true 194 | noCovariantTypes = true 195 | noDefaultArgs = true 196 | noFinalVal = true 197 | noFinalize = true 198 | noImplicitConversion = true 199 | noImplicitObject = true 200 | noIsInstanceOf = true 201 | noNulls = true 202 | noReturns = true 203 | noSemicolons = true 204 | noTabs = true 205 | noThrows = true 206 | noUniversalEquality = true 207 | noValInAbstract = true 208 | noValPatterns = true 209 | noVars = true 210 | noWhileLoops = true 211 | noXml = true 212 | } 213 | 214 | ExplicitResultTypes { 215 | unsafeShortenNames = true 216 | 217 | fatalWarnings = true 218 | 219 | # these apply to non-implicits 220 | memberKind = [Def, Val] 221 | memberVisibility = [Public, Protected] 222 | 223 | # turn to the max... 224 | skipSimpleDefinitions = false 225 | skipLocalImplicits = false 226 | } 227 | --------------------------------------------------------------------------------