genlayer 0.0.1 → 0.0.2

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Release & Publish Package to NPM
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 8-cli-github-action-to-manage-release-process-to-npm
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: "18"
+      - name: Install the dependencies
+        run: npm ci
+      - name: Initialize Git User
+        run: |
+          git config --global user.email "github-actions[bot]@genlayer.com"
+          git config --global user.name "github-actions[bot]"
+      - name: Initialize the NPM configuration
+        run: npm config set //registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+      - run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.REPO_PERSONAL_ACCESS_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.release-it.json

@@ -0,0 +1,64 @@
+{
+  "git": {
+    "commitMessage": "Release v${version}",
+    "tagName": "v${version}",
+    "requireCleanWorkingDir": false,
+    "requireUpstream": false,
+    "requireCommits": false,
+    "push": true
+  },
+  "github": {
+    "release": true,
+    "tokenRef": "GITHUB_TOKEN"
+  },
+  "npm": {
+    "publish": true
+  },
+  "plugins": {
+    "@release-it/conventional-changelog": {
+      "preset": "conventionalcommits",
+      "infile": "CHANGELOG.md",
+      "types": [
+        {
+          "type": "feat",
+          "section": "Features"
+        },
+        {
+          "type": "fix",
+          "section": "Bug Fixes"
+        },
+        {
+          "type": "chore",
+          "section": "Improvement Tasks"
+        },
+        {
+          "type": "ci",
+          "section": "Continuous Integration"
+        },
+        {
+          "type": "docs",
+          "section": "Documentation"
+        },
+        {
+          "type": "style",
+          "section": "Styles"
+        },
+        {
+          "type": "refactor",
+          "section": "Refactor Tasks"
+        },
+        {
+          "type": "perf",
+          "section": "Performance Improvements"
+        },
+        {
+          "type": "test",
+          "section": "Testing"
+        }
+      ]
+    }
+  },
+  "hooks": {
+    "after:bump": "npm run build"
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+
+## 0.0.2 (2024-04-23)
+
+
+### Bug Fixes
+
+* updated package name ([e27a6b8](https://github.com/yeagerai/genlayer-cli/commit/e27a6b86201771eb39c6fe221df1d9c287c66418))

package/esbuild.config.dev

@@ -0,0 +1,11 @@
+module.exports = {
+  context: {
+    tsconfig: "./tsconfig.json",
+    entryPoints: ["src/index.ts"],
+    bundle: true, // Bundle all dependencies
+    outfile: "dist/index.js", // Output file
+    platform: "node",
+    target: "es6",
+  },
+  watch: true,
+};

package/esbuild.config.js

@@ -1,17 +1,14 @@
 const esbuild = require("esbuild");
+const isProduction = process.env.NODE_ENV === "production";
+const config = require(isProduction ? "./esbuild.config.prod" : "./esbuild.config.dev");
 
 const run = async () => {
-  // Start build with esbuild
-  const context = await esbuild.context({
-    tsconfig: "./tsconfig.json",
-    entryPoints: ["src/index.ts"],
-    bundle: true, // Bundle all dependencies
-    outfile: "dist/index.js", // Output file
-    platform: "node",
-    target: "es6",
-  });
-
-  await context.watch();
+  if (config.watch) {
+    const context = await esbuild.context(config.context);
+    await context.watch();
+  } else {
+    await esbuild.build(config.context);
+  }
 };
 
 run().catch(e => {

package/esbuild.config.prod

@@ -0,0 +1,11 @@
+module.exports = {
+  context: {
+    tsconfig: "./tsconfig.json",
+    entryPoints: ["src/index.ts"],
+    bundle: true, // Bundle all dependencies
+    outfile: "dist/index.js", // Output file
+    platform: "node",
+    target: "es6",
+  },
+  watch: false,
+};

package/jest.config.js

@@ -1,5 +1,8 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};
+  preset: "ts-jest",
+  testEnvironment: "node",
+  moduleNameMapper: {
+    "^@/(.*)$": "<rootDir>/src/$1",
+  },
+};

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "genlayer",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "GenLayer Command Line Tool",
   "main": "src/index.ts",
   "scripts": {
     "test": "jest",
-    "dev": "node esbuild.config.js"
+    "dev": "node esbuild.config.js",
+    "build": "cross-env NODE_ENV=production node esbuild.config.js",
+    "release": "release-it --ci"
   },
   "repository": {
     "type": "git",
@@ -25,12 +27,14 @@
   },
   "homepage": "https://github.com/yeagerai/genlayer-cli#readme",
   "devDependencies": {
+    "@release-it/conventional-changelog": "^8.0.1",
     "@types/inquirer": "^9.0.7",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.12.7",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^7.7.0",
     "@typescript-eslint/parser": "^7.7.0",
+    "cross-env": "^7.0.3",
     "esbuild": "^0.20.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
@@ -38,7 +42,7 @@
     "eslint-plugin-import": "^2.29.1",
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
-    "sinon": "^17.0.1",
+    "release-it": "^17.2.0",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
@@ -47,8 +51,5 @@
     "commander": "^12.0.0",
     "inquirer": "^9.2.19",
     "node-fetch": "^3.3.2"
-  },
-  "directories": {
-    "test": "tests"
   }
 }

package/src/commands/general/index.ts

@@ -6,7 +6,7 @@ export function initializeGeneralCommands(program: Command) {
   program
     .command("init")
     .description("Initialize the GenLayer Environment")
-    .option("-n, --numValidators <numValidators>", "Number of validators")
+    .option("-n, --numValidators <numValidators>", "Number of validators", "5")
     .action(initAction);
   return program;
 }

package/tests/commands/init.test.ts

@@ -1,7 +1,7 @@
 import {program} from "commander";
 
 import {initializeGeneralCommands} from "../../src/commands/general";
-import {getCommand} from "../utils";
+import {getCommand, getCommandOption} from "../utils";
 
 jest.mock("inquirer", () => ({
   prompt: jest.fn().mockResolvedValue({}),
@@ -29,6 +29,12 @@ describe("init command", () => {
     expect(() => program.parse(["node", "test", "init", "--numValidators", "10"])).not.toThrow();
   });
 
+  test("option -n, --numValidators default value is 5", async () => {
+    // Given // When
+    const numValidatorsOption = getCommandOption(initCommand, "--numValidators");
+    expect(numValidatorsOption?.defaultValue).toBe("5");
+  });
+
   test("random option is not accepted", async () => {
     initCommand?.exitOverride();
     expect(() => program.parse(["node", "test", "init", "-random"])).toThrow(

package/tests/utils.ts

@@ -1,5 +1,13 @@
-import {Command, program} from "commander";
+import {Command, Option, program} from "commander";
 
-export function getCommand(commandName: string): Command | undefined {
-  return program.commands.find(command => command.name() === commandName);
+export function getCommand(commandName: string): Command {
+  const command = program.commands.find(command => command.name() === commandName);
+  if (!command) {
+    throw new Error(`Command ${commandName} not found`);
+  }
+  return command;
+}
+
+export function getCommandOption(command: Command, optionName: string): Option | undefined {
+  return command.options.find(option => option.long === optionName);
 }