Merge pull request #12 from labscommunity/fix/changesets

Add changeset config for cli and other cli & template fixes
labscommunity · Nov 4, 2023 · 18ecf7d · 18ecf7d
2 parents 65b09d6 + 50beed6
commit 18ecf7d
Show file tree

Hide file tree

Showing 20 changed files with 96 additions and 82 deletions.
diff --git a/.changeset/good-houses-float.md b/.changeset/good-houses-float.md
@@ -0,0 +1,11 @@
+---
+"create-arweave-app": patch
+---
+
+Changeset config, CLI dependency and template issue fixes
+
+- Fixed changeset configuration.
+- Added credits comment to CLI code.
+- Improved dependency handling and logging.
+- Resolved `hasStamped` fetching issue in template.
+- Enhanced asset fetching without dependencies in template.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -4,9 +4,8 @@ on:
     workflows: ["CI"]
     types:
       - completed
-  push:
     branches:
-      - "main"
+      - main
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 

diff --git a/.gitignore b/.gitignore
@@ -63,4 +63,7 @@ yarn-error.log*
 Thumbs.db
 
 # Typescript
-*.tsbuildinfo
+*.tsbuildinfo
+
+# cli changesets
+apps/cli/.changeset/*.md
diff --git a/apps/cli/.changeset/config.json b/apps/cli/.changeset/config.json
@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    { "repo": "labscommunity/starterkit" }
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["web"],
+  "changedFilePatterns": ["src/**", "template/**"]
+}
diff --git a/apps/cli/package.json b/apps/cli/package.json
@@ -64,9 +64,7 @@
     "validate-npm-package-name": "^5.0.0"
   },
   "devDependencies": {
-    "@types/figlet": "^1.5.7",
     "@types/fs-extra": "^11.0.1",
-    "@types/inquirer": "^9.0.3",
     "@types/node": "^18.16.0",
     "@types/validate-npm-package-name": "^4.0.1",
     "@typescript-eslint/eslint-plugin": "^6.8.0",

diff --git a/apps/cli/src/helpers/installDependencies.ts b/apps/cli/src/helpers/installDependencies.ts
@@ -1,6 +1,8 @@
 import chalk from "chalk";
 import { execa, type StdioOption } from "execa";
 import ora, { type Ora } from "ora";
+import path from "path";
+import fs from "fs-extra";
 
 import { getUserPkgManager, type PackageManager } from "@/utils/getUserPkgManager.js";
 import { logger } from "@/utils/logger.js";
@@ -70,7 +72,19 @@ export const installDependencies = async ({ projectDir }: { projectDir: string }
 
   const installSpinner = await runInstallCommand(pkgManager, projectDir);
 
-  // If the spinner was used to show the progress, use succeed method on it
-  // If not, use the succeed on a new spinner
-  (installSpinner ?? ora()).succeed(chalk.green("Successfully installed dependencies!\n"));
+  const isDependenciesInstalled = fs.existsSync(path.join(projectDir, "node_modules"));
+  if (isDependenciesInstalled) {
+    // If the spinner was used to show the progress, use succeed method on it
+    // If not, use the succeed on a new spinner
+    (installSpinner ?? ora()).succeed(chalk.green("Successfully installed dependencies!\n"));
+    return false;
+  } else {
+    (installSpinner ?? ora()).fail(
+      chalk.red(
+        "Failed to install dependencies! Please refer to https://github.com/labscommunity/starterkit#getting-started for troubleshooting steps to resolve this issue.\n"
+      )
+    );
+
+    return true;
+  }
 };
diff --git a/apps/cli/src/index.ts b/apps/cli/src/index.ts
@@ -1,4 +1,10 @@
 #!/usr/bin/env node
+
+/**
+ * This CLI integrates contributions and portions of code sourced from various repositories.
+ * For a complete list of contributions and credits, please see https://github.com/labscommunity/starterkit/blob/main/CREDITS.md.
+ */
+
 import path from "path";
 import { execa } from "execa";
 import fs from "fs-extra";
@@ -79,8 +85,9 @@ const main = async () => {
     setImportAlias(projectDir, importAlias);
   }
 
+  let showInstallCommand = noInstall;
   if (!noInstall) {
-    await installDependencies({ projectDir });
+    showInstallCommand = await installDependencies({ projectDir });
   }
 
   // Rename _eslintrc.json to .eslintrc.json - we use _eslintrc.json to avoid conflicts with the monorepos linter
@@ -92,7 +99,7 @@ const main = async () => {
 
   await logNextSteps({
     projectName: appDir,
-    noInstall,
+    noInstall: showInstallCommand,
     projectDir,
   });
 

diff --git a/apps/cli/template/next/javascript/src/app/layout.jsx b/apps/cli/template/next/javascript/src/app/layout.jsx
@@ -37,7 +37,7 @@ export default function RootLayout({ children }) {
           <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
             <ArweaveWalletKit
               config={{
-                permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH", "ACCESS_PUBLIC_KEY", "SIGNATURE"],
+                permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH"],
                 ensurePermissions: true,
                 appInfo: {
                   name: "StarterKit",

diff --git a/apps/cli/template/next/javascript/src/components/assets.jsx b/apps/cli/template/next/javascript/src/components/assets.jsx
@@ -1,12 +1,10 @@
 "use client";
 
 import { AssetCard } from "@/components/asset-card";
-import { useUser } from "@/hooks/useUser";
 import { getAssetData } from "@/lib/query-assets";
 import * as React from "react";
 
 export function Assets() {
-  const { connected, address } = useUser();
   const [assets, setAssets] = React.useState([]);
 
   React.useEffect(() => {
@@ -15,7 +13,7 @@ export function Assets() {
       setAssets(data);
     }
     fetchData();
-  }, [connected, address]);
+  }, []);
 
   return (
     <div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-4 w-full gap-6">

diff --git a/apps/cli/template/next/javascript/src/components/stamp-like.jsx b/apps/cli/template/next/javascript/src/components/stamp-like.jsx
@@ -23,7 +23,7 @@ async function getStamps() {
 }
 
 export function Stamp(props) {
-  const { connected } = useUser();
+  const { connected, address } = useUser();
   const [stampCount, setStampCount] = React.useState(0);
   const [hasStamped, setHasStamped] = React.useState(false);
 
@@ -41,14 +41,16 @@ export function Stamp(props) {
     async function fetchStampData() {
       const stamps = await getStamps();
       const { total } = await stamps.count(props.txId);
-      const stampedStatus = await stamps.hasStamped(props.txId);
-
       setStampCount(total);
-      setHasStamped(stampedStatus);
+
+      if (address) {
+        const stampedStatus = await stamps.hasStamped(props.txId);
+        setHasStamped(stampedStatus);
+      }
     }
 
     fetchStampData();
-  }, [props.txId]);
+  }, [props.txId, address]);
 
   return (
     <HoverCard>
@@ -59,7 +61,7 @@ export function Stamp(props) {
           disabled={!connected || hasStamped}
           className={`
             transition 
-            ${hasStamped ? "text-red-500" : ""}
+            ${hasStamped && connected ? "text-red-500" : ""}
             ${!hasStamped && connected ? "hover:text-red-500" : ""}
           `}
         >

diff --git a/apps/cli/template/next/javascript/src/pages/_app.jsx b/apps/cli/template/next/javascript/src/pages/_app.jsx
@@ -12,7 +12,7 @@ export default function App({ Component, pageProps }) {
     <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
       <ArweaveWalletKit
         config={{
-          permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH", "ACCESS_PUBLIC_KEY", "SIGNATURE"],
+          permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH"],
           ensurePermissions: true,
           appInfo: {
             name: "StarterKit",

diff --git a/apps/cli/template/next/typescript/src/app/layout.tsx b/apps/cli/template/next/typescript/src/app/layout.tsx
@@ -47,13 +47,7 @@ export default function RootLayout({ children }: RootLayoutProps) {
           <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
             <ArweaveWalletKit
               config={{
-                permissions: [
-                  "ACCESS_ADDRESS",
-                  "SIGN_TRANSACTION",
-                  "DISPATCH",
-                  "ACCESS_PUBLIC_KEY",
-                  "SIGNATURE",
-                ],
+                permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH"],
                 ensurePermissions: true,
                 appInfo: {
                   name: "StarterKit",

diff --git a/apps/cli/template/next/typescript/src/components/assets.tsx b/apps/cli/template/next/typescript/src/components/assets.tsx
@@ -7,7 +7,6 @@ import { QueriedAsset } from "@/types/query";
 import * as React from "react";
 
 export function Assets() {
-  const { connected, address } = useUser();
   const [assets, setAssets] = React.useState<QueriedAsset[]>([]);
 
   React.useEffect(() => {
@@ -16,7 +15,7 @@ export function Assets() {
       setAssets(data);
     }
     fetchData();
-  }, [connected, address]);
+  }, []);
 
   return (
     <div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-4 w-full gap-6">

diff --git a/apps/cli/template/next/typescript/src/components/stamp-like.tsx b/apps/cli/template/next/typescript/src/components/stamp-like.tsx
@@ -31,7 +31,7 @@ interface StampProps {
 }
 
 export function Stamp(props: StampProps) {
-  const { connected } = useUser();
+  const { connected, address } = useUser();
   const [stampCount, setStampCount] = React.useState<number>(0);
   const [hasStamped, setHasStamped] = React.useState<boolean>(false);
 
@@ -49,14 +49,16 @@ export function Stamp(props: StampProps) {
     async function fetchStampData() {
       const stamps = await getStamps();
       const { total } = await stamps.count(props.txId);
-      const stampedStatus = await stamps.hasStamped(props.txId);
-
       setStampCount(total);
-      setHasStamped(stampedStatus);
+
+      if (address) {
+        const stampedStatus = await stamps.hasStamped(props.txId);
+        setHasStamped(stampedStatus);
+      }
     }
 
     fetchStampData();
-  }, [props.txId]);
+  }, [props.txId, address]);
 
   return (
     <HoverCard>
@@ -67,7 +69,7 @@ export function Stamp(props: StampProps) {
           disabled={!connected || hasStamped}
           className={`
             transition 
-            ${hasStamped ? "text-red-500" : ""}
+            ${hasStamped && connected ? "text-red-500" : ""}
             ${!hasStamped && connected ? "hover:text-red-500" : ""}
           `}
         >

diff --git a/apps/cli/template/next/typescript/src/pages/_app.tsx b/apps/cli/template/next/typescript/src/pages/_app.tsx
@@ -13,13 +13,7 @@ export default function App({ Component, pageProps }: AppProps) {
     <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
       <ArweaveWalletKit
         config={{
-          permissions: [
-            "ACCESS_ADDRESS",
-            "SIGN_TRANSACTION",
-            "DISPATCH",
-            "ACCESS_PUBLIC_KEY",
-            "SIGNATURE",
-          ],
+          permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH"],
           ensurePermissions: true,
           appInfo: {
             name: "StarterKit",

diff --git a/apps/web/src/_pages/_app.tsx b/apps/web/src/_pages/_app.tsx
@@ -13,13 +13,7 @@ export default function App({ Component, pageProps }: AppProps) {
     <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
       <ArweaveWalletKit
         config={{
-          permissions: [
-            "ACCESS_ADDRESS",
-            "SIGN_TRANSACTION",
-            "DISPATCH",
-            "ACCESS_PUBLIC_KEY",
-            "SIGNATURE",
-          ],
+          permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH"],
           ensurePermissions: true,
           appInfo: {
             name: "StarterKit",

diff --git a/apps/web/src/app/layout.tsx b/apps/web/src/app/layout.tsx
@@ -47,13 +47,7 @@ export default function RootLayout({ children }: RootLayoutProps) {
           <ThemeProvider attribute="class" defaultTheme="system" enableSystem>
             <ArweaveWalletKit
               config={{
-                permissions: [
-                  "ACCESS_ADDRESS",
-                  "SIGN_TRANSACTION",
-                  "DISPATCH",
-                  "ACCESS_PUBLIC_KEY",
-                  "SIGNATURE",
-                ],
+                permissions: ["ACCESS_ADDRESS", "SIGN_TRANSACTION", "DISPATCH"],
                 ensurePermissions: true,
                 appInfo: {
                   name: "StarterKit",

diff --git a/apps/web/src/components/assets.tsx b/apps/web/src/components/assets.tsx
@@ -7,7 +7,6 @@ import { QueriedAsset } from "@/types/query";
 import * as React from "react";
 
 export function Assets() {
-  const { connected, address } = useUser();
   const [assets, setAssets] = React.useState<QueriedAsset[]>([]);
 
   React.useEffect(() => {
@@ -16,7 +15,7 @@ export function Assets() {
       setAssets(data);
     }
     fetchData();
-  }, [connected, address]);
+  }, []);
 
   return (
     <div className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-4 w-full gap-6">

diff --git a/apps/web/src/components/stamp-like.tsx b/apps/web/src/components/stamp-like.tsx
@@ -31,7 +31,7 @@ interface StampProps {
 }
 
 export function Stamp(props: StampProps) {
-  const { connected } = useUser();
+  const { connected, address } = useUser();
   const [stampCount, setStampCount] = React.useState<number>(0);
   const [hasStamped, setHasStamped] = React.useState<boolean>(false);
 
@@ -49,14 +49,16 @@ export function Stamp(props: StampProps) {
     async function fetchStampData() {
       const stamps = await getStamps();
       const { total } = await stamps.count(props.txId);
-      const stampedStatus = await stamps.hasStamped(props.txId);
-
       setStampCount(total);
-      setHasStamped(stampedStatus);
+
+      if (address) {
+        const stampedStatus = await stamps.hasStamped(props.txId);
+        setHasStamped(stampedStatus);
+      }
     }
 
     fetchStampData();
-  }, [props.txId]);
+  }, [props.txId, address]);
 
   return (
     <HoverCard>
@@ -67,7 +69,7 @@ export function Stamp(props: StampProps) {
           disabled={!connected || hasStamped}
           className={`
             transition 
-            ${hasStamped ? "text-red-500" : ""}
+            ${hasStamped && connected ? "text-red-500" : ""}
             ${!hasStamped && connected ? "hover:text-red-500" : ""}
           `}
         >