Add private field to package manifest

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Wally Changelog
 
 ## Unreleased Changes
+* Added private field to package manifest ([#9])
+
+[#9]: https://github.com/UpliftGames/wally/issues/9
 
 ## 0.3.1 (2021-11-12)
 * Support for dev dependencies ([#63][63])

README.md

@@ -157,6 +157,9 @@ registry = "https://github.com/upliftgames/wally-index"
 # include = []
 exclude = ["node_modules"]
 
+# Packages can be marked as private to prevent them from being published.
+private = true
+
 [dependencies]
 # Most dependencies will look like this.
 #

src/commands/publish.rs

@@ -1,6 +1,6 @@
 use std::path::{Path, PathBuf};
 
-use anyhow::Context;
+use anyhow::{bail, Context};
 use structopt::StructOpt;
 use url::Url;
 
@@ -22,6 +22,11 @@ pub struct PublishSubcommand {
 impl PublishSubcommand {
     pub fn run(self, global: GlobalOptions) -> anyhow::Result<()> {
         let manifest = Manifest::load(&self.project_path)?;
+
+        if manifest.package.private {
+            bail!("Cannot publish private package.");
+        }
+
         let auth_store = AuthStore::load()?;
 
         let index_url = if global.test_registry {

src/manifest.rs

@@ -120,6 +120,12 @@ pub struct Package {
     /// Example: ["/Packages", "/node_modules"]
     #[serde(default)]
     pub exclude: Vec<String>,
+
+    /// Indicates whether the package can be published or not.
+    ///
+    /// Example: true
+    #[serde(default)]
+    pub private: bool,
 }
 
 // Metadata we require when this manifest will be used to generate package folders

src/test_package.rs

@@ -38,6 +38,7 @@ impl PackageBuilder {
                 authors: Vec::new(),
                 include: Vec::new(),
                 exclude: Vec::new(),
+                private: false,
             },
             place: Default::default(),
             dependencies: Default::default(),

test-projects/private-package/default.project.json

@@ -0,0 +1,6 @@
+{
+	"name": "private-package",
+	"tree": {
+		"$path": "src"
+	}
+}

test-projects/private-package/src/init.lua

@@ -0,0 +1 @@
+return "Private Package"

test-projects/private-package/wally.toml

@@ -0,0 +1,7 @@
+[package]
+name = "biff/private-package"
+version = "0.1.0"
+license = "MIT"
+realm = "server"
+registry = "test-registries/primary-registry"
+private = true

tests/integration/publish.rs

@@ -60,3 +60,29 @@ fn check_mismatched_names() {
     // default.project.json should now contain mismatched-name instead of Mismatched-name
     assert_eq!(project_name, "mismatched-name");
 }
+
+/// If the private field in wally.toml is set to true, it should not publish
+/// the package.
+#[test]
+fn check_private_field() {
+    let test_projects = Path::new(concat!(env!("CARGO_MANIFEST_DIR"), "/test-projects",));
+
+    let args = Args {
+        global: GlobalOptions {
+            test_registry: true,
+            use_temp_index: true,
+            ..Default::default()
+        },
+        subcommand: Subcommand::Publish(PublishSubcommand {
+            project_path: test_projects.join("private-package"),
+        }),
+    };
+
+    let error = args.run().expect_err("Expected publish to return an error");
+
+    assert!(
+        error.to_string().contains("Cannot publish"),
+        "Expected error message that a private package cannot be published. Instead we got: {:#}",
+        error
+    )
+}