refuse to publish packages with no readme

Author: giacomocavalieri

CHANGELOG.md

@@ -74,6 +74,9 @@
   README generated by the `gleam new` command.
   ([Giacomo Cavalieri](https://github.com/giacomocavalieri))
 
+- The build tool will now refuse to publish any package that has no README.
+  ([Giacomo Cavalieri](https://github.com/giacomocavalieri))
+
 ### Language server
 
 - The language server now allows extracting the start of a pipeline into a

compiler-cli/src/publish.rs

@@ -134,7 +134,15 @@ HTML documentation will work:
 
 fn check_for_default_readme(config: &PackageConfig, paths: &ProjectPaths) -> Result<(), Error> {
     let default_readme = default_readme(config.name.as_str());
-    let project_readme = fs::read(paths.readme())?;
+    let project_readme = match fs::read(paths.readme()) {
+        Err(Error::FileIo {
+            err: Some(message), ..
+        }) if message.contains("No such file or directory") => {
+            return Err(Error::CannotPublishWithNoReadme);
+        }
+        Err(error) => return Err(error),
+        Ok(project_readme) => project_readme,
+    };
 
     // We consider the two READMEs equal modulo whitespace, otherwise it would
     // be pretty trivial to trick this check by just formatting the default

compiler-core/src/error.rs

@@ -315,6 +315,9 @@ file_names.iter().map(|x| x.as_str()).join(", "))]
     #[error("Publishing a package with the default README is not permitted")]
     CannotPublishWithDefaultReadme,
 
+    #[error("Publishing a package with no README is not permitted")]
+    CannotPublishWithNoReadme,
+
     #[error("Publishing packages to reserve names is not permitted")]
     HexPackageSquatting,
 
@@ -883,6 +886,19 @@ published package should have its own carefully written README.
                     ),
                 }]
             }
+
+            Error::CannotPublishWithNoReadme => {
+                let text = "You appear to be attempting to publish a package with no README.
+All published packages should have one.
+"
+                .into();
+
+                vec![Diagnostic {
+                    title: "Cannot publish with no README".into(),
+                    text,
+                    level: Level::Error,
+                    location: None,
+                    hint: Some("Add a README to your project before publishing.".into()),
                 }]
             }
 

test/publishing_no_readme/.gitignore

@@ -0,0 +1,3 @@
+*.beam
+*.ez
+build

test/publishing_no_readme/gleam.toml

@@ -0,0 +1,7 @@
+name = "no_readme"
+version = "1.0.0"
+description = "Test project for no readme"
+licences = ["Apache-2.0"]
+
+[dependencies]
+gleam_stdlib = ">= 0.44.0 and < 2.0.0"

test/publishing_no_readme/manifest.toml

@@ -0,0 +1,9 @@
+# This file was generated by Gleam
+# You typically do not need to edit this file
+
+packages = [
+  { name = "gleam_stdlib", version = "0.62.1", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "0080706D3A5A9A36C40C68481D1D231D243AF602E6D2A2BE67BA8F8F4DFF45EC" },
+]
+
+[requirements]
+gleam_stdlib = { version = ">= 0.44.0 and < 2.0.0" }

test/publishing_no_readme/src/no_readme.gleam

@@ -0,0 +1,21 @@
+import gleam/io
+
+/// This tests that a project with no readme doesn't get published.
+///
+pub fn main() -> Nil {
+  greeting()
+  first_line()
+  second_line()
+}
+
+fn greeting() {
+  io.println("Hello from no_readme!")
+}
+
+fn first_line() {
+  io.println("Here we have some additional code so that this is not mistaken")
+}
+
+fn second_line() {
+  io.println("for a default main project, that would be rejected as well!")
+}

test/publishing_no_readme/test.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+set -eu
+
+GLEAM_COMMAND=${GLEAM_COMMAND:-"cargo run --quiet --"}
+
+g() {
+  echo "Running: $GLEAM_COMMAND $@"
+  $GLEAM_COMMAND "$@"
+}
+
+echo Resetting the build directory to get to a known state
+rm -fr build
+
+echo Running publish should not publish anything
+if yes "n" | g publish; then
+  echo "Expected publish to fail, but it succeeded"
+  exit 1
+fi
+
+echo
+echo Success! 💖
+echo