Add Homepage and Repository fields to manifests (#211)

Co-authored-by: MobiusCraftFlip <[email protected]>

README.md

@@ -171,6 +171,15 @@ realm = "shared"
 # keep internal code private and isolated.
 registry = "https://github.com/upliftgames/wally-index"
 
+# Wally will display this link on the package's page on wally.run.
+# A value should only be set if there is a dedicated website for
+# the package other than the source repository. 
+homepage = "https://eryn.io/roblox-lua-promise/"
+
+# Wally will display this link on package's page on wally.run.
+# The repository field should be a URL to the source repository for a package.
+repository = "https://github.com/evaera/roblox-lua-promise"
+
 # You can also specify files to include or exclude from the package
 # By default gitignore files are respected and Wally won't include hidden
 # files/directories or packages downloaded by Wally.

src/manifest.rs

@@ -126,6 +126,18 @@ pub struct Package {
     /// Example: true
     #[serde(default)]
     pub private: bool,
+
+    /// URL of the package homepage.
+    ///
+    /// Example: "https://github.com/sleitnick/knit"
+    #[serde(default)]
+    pub homepage: Option<String>,
+
+    /// URL of the package source repository.
+    ///
+    /// Example: "https://github.com/Sleitnick/Knit.git"
+    #[serde(default)]
+    pub repository: Option<String>,
 }
 
 // Metadata we require when this manifest will be used to generate package folders

src/test_package.rs

@@ -39,6 +39,8 @@ impl PackageBuilder {
                 include: Vec::new(),
                 exclude: Vec::new(),
                 private: false,
+                homepage: None,
+                repository: None,
             },
             place: Default::default(),
             dependencies: Default::default(),

test-projects/manifest-links/default.project.json

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

test-projects/manifest-links/src/init.luau

@@ -0,0 +1 @@
+return "hey"

test-projects/manifest-links/wally.toml

@@ -0,0 +1,8 @@
+[package]
+name = "biff/minimal"
+version = "0.1.0"
+license = "MIT"
+realm = "server"
+registry = "test-registries/primary-registry"
+repository = "https://github.com/UpliftGames/player-module.git"
+homepage = "https://github.com/UpliftGames/player-module"

test-registries/primary-registry/index/biff/manifest-links

@@ -0,0 +1 @@
+{"package":{"name":"biff/minimal","version":"0.1.0","registry":"test-registries/primary-registry","realm":"server","description":null,"license":"MIT","authors":[],"include":[],"exclude":[],"private":false,"homepage":"https://github.com/UpliftGames/player-module","repository":"https://github.com/UpliftGames/player-module.git"},"place":{"shared-packages":null,"server-packages":null},"dependencies":{},"server-dependencies":{},"dev-dependencies":{}}

tests/integration/install.rs

@@ -42,6 +42,11 @@ fn cross_realm_explicit_dependency() {
     run_install_test("cross-realm-explicit-dependency");
 }
 
+#[test]
+fn manifest_links() {
+    run_install_test("manifest-links");
+}
+
 #[test]
 fn locked_pass() {
     let result = run_locked_install("diamond-graph/root/latest");

tests/integration/snapshots/integration__install__manifest_links.snap

@@ -0,0 +1,9 @@
+---
+source: tests/integration/install.rs
+expression: result
+---
+default.project.json: "{\n  \"name\": \"minimal\",\n  \"tree\": {\n    \"$path\": \"src\"\n  }\n}"
+src:
+  init.luau: "return \"hey\"\n"
+wally.lock: "# This file is automatically @generated by Wally.\n# It is not intended for manual editing.\nregistry = \"test\"\n\n[[package]]\nname = \"biff/minimal\"\nversion = \"0.1.0\"\ndependencies = []\n"
+wally.toml: "[package]\nname = \"biff/minimal\"\nversion = \"0.1.0\"\nlicense = \"MIT\"\nrealm = \"server\"\nregistry = \"test-registries/primary-registry\"\nrepository = \"https://github.com/UpliftGames/player-module.git\"\nhomepage = \"https://github.com/UpliftGames/player-module\"\n"

wally-registry-frontend/src/app/package/[packageScope]/[packageName]/page.tsx

@@ -192,6 +192,40 @@ const DependencyLink = ({ packageInfo }: { packageInfo: string }) => {
   return <DependencyLinkItem href={"/"}>{packageInfo}</DependencyLinkItem>
 }
 
+const MetadataLink = ({
+  url
+}: {
+  url: string
+
+}) => {
+  const Link = styled.a`
+    overflow: hidden;
+    text-overflow: ellipsis;
+    display: flex;
+    white-space: nowrap;
+    width: 100%;
+    display: inline-block;
+    font-size: 18px;
+  `
+
+  const urlNoSchema = (original: string) => {
+    try {
+      const url = new URL(original)
+      return `${url.host}${url?.pathname}`
+    } catch {
+      return original
+    }
+  }
+
+  return (
+    <>
+      <Link href={url} title={url}>
+        {urlNoSchema(url)}
+      </Link>
+    </>
+  )
+}
+
 const DownloadLink = ({
   url,
   filename,
@@ -288,8 +322,8 @@ export default function Package() {
       (pack: WallyPackageMetadata) => !pack.package.version.includes("-")
     )
       ? packageData.versions.filter(
-          (pack: WallyPackageMetadata) => !pack.package.version.includes("-")
-        )
+        (pack: WallyPackageMetadata) => !pack.package.version.includes("-")
+      )
       : packageData.versions
 
     setPackageHistory(filteredPackageData)
@@ -443,14 +477,17 @@ export default function Package() {
               {capitalize(packageMetadata.package.realm)}
             </MetaItem>
 
-            {/* TODO: Re-implement when Wally API supports custom source repos */}
-            {/* {packageMetadata?.package.registry && (
-                <MetaItem title="Repository" width="full">
-                  <a href={packageMetadata?.package.registry}>
-                    {packageMetadata?.package.registry.replace("https://", "")}
-                  </a>
-                </MetaItem>
-              )} */}
+            {packageMetadata?.package.homepage && (
+              <MetaItem title="Homepage" width="full">
+                <MetadataLink url={packageMetadata?.package.homepage} />
+              </MetaItem>
+            )}
+
+            {packageMetadata?.package.repository && (
+              <MetaItem title="Repository" width="full">
+                <MetadataLink url={packageMetadata?.package.repository} />
+              </MetaItem>
+            )}
 
             {packageMetadata.package.authors.length > 0 && (
               <MetaItem title="Authors" width="full">

wally-registry-frontend/src/types/wally.d.ts

@@ -14,6 +14,8 @@ export interface WallyPackageMetadata {
     realm: string
     registry: string
     version: string
+    homepage: string?,
+    repository: string?,
   }
 
   place: {