@semaphore-protocol/cli 0.2.0 → 0.3.0

package/README.md

@@ -2,7 +2,7 @@
     <h1 align="center">
         Semaphore CLI
     </h1>
-    <p align="center">A command line tool to set up your Semaphore project and query groups.</p>
+    <p align="center">A command line tool to set up your Semaphore project and get group data.</p>
 </p>
 
 <p align="center">
@@ -46,23 +46,37 @@
     </h4>
 </div>
 
-| ... |
-| --- |
+| Setting up a project, although not particularly complex, can be a lengthy process for some people. A command line to initialize a Semaphore project can reduce the set-up time from a few minutes to a few seconds. In addition, the Semaphore CLI can also be used to obtain on-chain group data. |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 
 ## 🛠 Install
 
-### npm or yarn
-
-Install the `@semaphore-protocol/cli` package with npm:
+Install the `@semaphore-protocol/cli` package globally:
 
 ```bash
-npm i @semaphore-protocol/cli
+npm i -g @semaphore-protocol/cli
 ```
 
-or yarn:
+or run specific commands with `npx`:
 
 ```bash
-yarn add @semaphore-protocol/cli
+npx @semaphore-protocol/cli init my-app
 ```
 
 ## 📜 Usage
+
+```
+Usage: semaphore [options] [command]
+
+A command line tool to set up your Semaphore project and get group data.
+
+Options:
+-v, --version Show Semaphore CLI version.
+-h, --help Display this help.
+
+Commands:
+init <project-directory> Initialize a Semaphore project with a supported template.
+get-groups [options] Get the list of groups from a supported network (Goerli or Arbitrum).
+get-group [options] <group-id> Get the data of a group from a supported network (Goerli or Arbitrum).
+help [command] Display help for a specific command.
+```

package/dist/index.js

@@ -2,8 +2,8 @@
 
 /**
  * @module @semaphore-protocol/cli
- * @version 0.2.0
- * @file A command line tool to set up your Semaphore project and query groups.
+ * @version 0.3.0
+ * @file A command line tool to set up your Semaphore project and get group data.
  * @copyright Ethereum Foundation 2022
  * @license MIT
  * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/cli}
@@ -38,10 +38,10 @@ class Spinner {
 }
 
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`;
-const { version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"));
+const { description, version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"));
 program
     .name("semaphore")
-    .description("A command line tool to set up your Semaphore project and query groups.")
+    .description(description)
     .version(version, "-v, --version", "Show Semaphore CLI version.")
     .addHelpText("before", `${figlet.textSync("Semaphore")}\n`)
     .addHelpText("after", "\r")
@@ -58,18 +58,28 @@ program
     .argument("<project-directory>", "Directory of the project.")
     // .option("-t, --template <template-name>", "Supported Semaphore template.", "hardhat")
     .action(async (projectDirectory) => {
-    // const originalDirectory = process.cwd()
-    const spinner = new Spinner(`Creating '${projectDirectory}' project`);
+    const currentDirectory = process.cwd();
+    const spinner = new Spinner(`Creating your project in ${chalk.green(`./${projectDirectory}`)}`);
     const templateURL = `https://registry.npmjs.org/@semaphore-protocol/cli-template-hardhat/-/cli-template-hardhat-${version}.tgz`;
     if (existsSync(projectDirectory)) {
         console.info(`\n ${logSymbols.error}`, `error: the '${projectDirectory}' folder already exists\n`);
         return;
     }
     spinner.start();
-    await download(templateURL, "./", { extract: true });
-    renameSync("package", projectDirectory);
+    await download(templateURL, currentDirectory, { extract: true });
+    renameSync(`${currentDirectory}/package`, `${currentDirectory}/${projectDirectory}`);
     spinner.stop();
-    console.info(` ${logSymbols.success}`, `Your '${projectDirectory}' project is ready!\n`);
+    console.info(` ${logSymbols.success}`, `Your project is ready!\n`);
+    console.info(` Please, install your dependencies by running:\n`);
+    console.info(`   ${chalk.cyan("cd")} ${projectDirectory}`);
+    console.info(`   ${chalk.cyan("npm i")}\n`);
+    const { scripts } = JSON.parse(readFileSync(`${currentDirectory}/${projectDirectory}/package.json`, "utf8"));
+    if (scripts) {
+        console.info(` Available scripts:\n`);
+        console.info(`${Object.keys(scripts)
+            .map((s) => `   ${chalk.cyan(`npm run ${s}`)}`)
+            .join("\n")}\n`);
+    }
 });
 program
     .command("get-groups")

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@semaphore-protocol/cli",
     "type": "module",
-    "version": "0.2.0",
-    "description": "A command line tool to set up your Semaphore project and query groups.",
+    "version": "0.3.0",
+    "description": "A command line tool to set up your Semaphore project and get group data.",
     "license": "MIT",
     "bin": {
         "semaphore": "dist/index.js"

package/src/index.ts

@@ -10,11 +10,11 @@ import { fileURLToPath } from "url"
 import Spinner from "./spinner.js"
 
 const packagePath = `${dirname(fileURLToPath(import.meta.url))}/..`
-const { version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"))
+const { description, version } = JSON.parse(readFileSync(`${packagePath}/package.json`, "utf8"))
 
 program
     .name("semaphore")
-    .description("A command line tool to set up your Semaphore project and query groups.")
+    .description(description)
     .version(version, "-v, --version", "Show Semaphore CLI version.")
     .addHelpText("before", `${figlet.textSync("Semaphore")}\n`)
     .addHelpText("after", "\r")
@@ -32,8 +32,8 @@ program
     .argument("<project-directory>", "Directory of the project.")
     // .option("-t, --template <template-name>", "Supported Semaphore template.", "hardhat")
     .action(async (projectDirectory) => {
-        // const originalDirectory = process.cwd()
-        const spinner = new Spinner(`Creating '${projectDirectory}' project`)
+        const currentDirectory = process.cwd()
+        const spinner = new Spinner(`Creating your project in ${chalk.green(`./${projectDirectory}`)}`)
         const templateURL = `https://registry.npmjs.org/@semaphore-protocol/cli-template-hardhat/-/cli-template-hardhat-${version}.tgz`
 
         if (existsSync(projectDirectory)) {
@@ -43,13 +43,28 @@ program
 
         spinner.start()
 
-        await download(templateURL, "./", { extract: true })
+        await download(templateURL, currentDirectory, { extract: true })
 
-        renameSync("package", projectDirectory)
+        renameSync(`${currentDirectory}/package`, `${currentDirectory}/${projectDirectory}`)
 
         spinner.stop()
 
-        console.info(` ${logSymbols.success}`, `Your '${projectDirectory}' project is ready!\n`)
+        console.info(` ${logSymbols.success}`, `Your project is ready!\n`)
+        console.info(` Please, install your dependencies by running:\n`)
+        console.info(`   ${chalk.cyan("cd")} ${projectDirectory}`)
+        console.info(`   ${chalk.cyan("npm i")}\n`)
+
+        const { scripts } = JSON.parse(readFileSync(`${currentDirectory}/${projectDirectory}/package.json`, "utf8"))
+
+        if (scripts) {
+            console.info(` Available scripts:\n`)
+
+            console.info(
+                `${Object.keys(scripts)
+                    .map((s) => `   ${chalk.cyan(`npm run ${s}`)}`)
+                    .join("\n")}\n`
+            )
+        }
     })
 
 program