Relax rules on license files in psc-publish

hdgarrood · hdgarrood · commit 414372eab239 · 2016-04-17T18:31:52.000+01:00
Instead of requiring a LICENSE file to exist, instead, just check that there is a valid SPDX license expression in bower.json. Fixes purescript#1985.
diff --git a/examples/docs/LICENSE b/examples/docs/LICENSE
diff --git a/examples/docs/bower.json b/examples/docs/bower.json
@@ -16,5 +16,5 @@
   ],
   "dependencies": {
   },
-  "license": "replaceme"
+  "license": "MIT"
 }
diff --git a/purescript.cabal b/purescript.cabal
@@ -92,7 +92,8 @@ library
                    monad-logger >= 0.3 && < 0.4,
                    pipes >= 4.0.0 && < 4.2.0 ,
                    pipes-http -any,
-                   http-types -any
+                   http-types -any,
+                   spdx == 0.2.*
 
     exposed-modules: Language.PureScript
                      Language.PureScript.AST
diff --git a/src/Language/PureScript/Publish.hs b/src/Language/PureScript/Publish.hs
@@ -39,6 +39,7 @@ import Data.Aeson.BetterErrors
 import qualified Data.Text as T
 import qualified Data.Text.Lazy as TL
 import qualified Data.Text.Lazy.Encoding as TL
+import qualified Data.SPDX as SPDX
 
 import Control.Category ((>>>))
 import Control.Arrow ((***))
@@ -128,7 +129,7 @@ catchLeft :: Applicative f => Either a b -> (a -> f b) -> f b
 catchLeft a f = either f pure a
 
 unlessM :: Monad m => m Bool -> m () -> m ()
-unlessM cond act = cond >>= flip unless act 
+unlessM cond act = cond >>= flip unless act
 
 preparePackage' :: PublishOptions -> PrepareM D.UploadedPackage
 preparePackage' opts = do
@@ -137,14 +138,12 @@ preparePackage' opts = do
 
   pkgMeta <- liftIO (Bower.decodeFile "bower.json")
                     >>= flip catchLeft (userError . CouldntDecodeBowerJSON)
-  unlessM (liftIO (doesFileExist "LICENSE")) (userError LicenseNotFound)
+  checkLicense pkgMeta
 
   (pkgVersionTag, pkgVersion) <- publishGetVersion opts
   pkgGithub                   <- getBowerRepositoryInfo pkgMeta
   (pkgBookmarks, pkgModules)  <- getModulesAndBookmarks
 
-  unless (bowerLicenseExists pkgMeta) (userError NoLicenseSpecified)
-
   let declaredDeps = map fst (bowerDependencies pkgMeta ++
                               bowerDevDependencies pkgMeta)
   pkgResolvedDependencies     <- getResolvedDependencies declaredDeps
@@ -215,8 +214,16 @@ getBowerRepositoryInfo = either (userError . BadRepositoryField) return . tryExt
           (Left (BadRepositoryType repositoryType))
         maybe (Left NotOnGithub) Right (extractGithub repositoryUrl)
 
-bowerLicenseExists :: PackageMeta -> Bool
-bowerLicenseExists = any (not . null) . bowerLicense
+checkLicense :: PackageMeta -> PrepareM ()
+checkLicense pkgMeta =
+  unless (any isValidSPDX (bowerLicense pkgMeta))
+    (userError NoLicenseSpecified)
+
+-- |
+-- Check if a string is a valid SPDX license expression.
+--
+isValidSPDX :: String -> Bool
+isValidSPDX = (== 1) . length . SPDX.parseExpression
 
 extractGithub :: String -> Maybe (D.GithubUser, D.GithubRepo)
 extractGithub = stripGitHubPrefixes
diff --git a/src/Language/PureScript/Publish/ErrorsWarnings.hs b/src/Language/PureScript/Publish/ErrorsWarnings.hs
@@ -182,11 +182,27 @@ displayUserError e = case e of
   BadRepositoryField err ->
     displayRepositoryError err
   NoLicenseSpecified ->
-    para (concat
-      ["No license specified in bower.json. Please add one. ",
-       "Distributing code without a license means that nobody ",
-       "will be able to (legally) use it."
-      ])
+    vcat $
+      [ para (concat
+          [ "No license is specified in bower.json. Please add one, using the "
+          , "SPDX license expression format. For example, any of the "
+          , "following would be acceptable:"
+          ])
+      , spacer
+      ] ++
+      map (indented . para)
+        [ "* \"MIT\""
+        , "* \"BSD-2-Clause\""
+        , "* \"GPL-2.0+\""
+        , "* \"(GPL-3.0 OR MIT)\""
+        ]
+        ++
+      [ spacer
+      , para (concat
+          [ "Note that distributing code without a license means that nobody "
+          , "will (legally) be able to use it."
+          ])
+      ]
   MissingDependencies pkgs ->
     let singular = NonEmpty.length pkgs == 1
         pl a b = if singular then b else a

Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,5 @@`
`16`	`16`	`],`
`17`	`17`	`"dependencies": {`
`18`	`18`	`},`
`19`		`- "license": "replaceme"`
	`19`	`+ "license": "MIT"`
`20`	`20`	`}`