@offckb/cli 0.1.0-rc7 → 0.1.0

package/dist/cmd/clean.js

@@ -1,12 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clean = void 0;
 const const_1 = require("../cfg/const");
 const util_1 = require("../util");
+const fs_1 = __importDefault(require("fs"));
 function clean() {
     if ((0, util_1.isFolderExists)(const_1.devnetDataPath)) {
         try {
-            (0, util_1.removeFolderSync)(const_1.devnetDataPath);
+            fs_1.default.rmSync(const_1.devnetDataPath, { recursive: true });
             console.log(`Chain data cleaned.`);
         }
         catch (error) {

package/dist/cmd/install.d.ts

@@ -1 +1,15 @@
 export declare function installDependency(): Promise<void>;
+export declare function downloadBinaryAndUnzip(): Promise<void>;
+export declare function downloadAndSaveCKBBinary(tempFilePath: string): Promise<void>;
+export declare function unZipFile(filePath: string, extractDir: string, useTar?: boolean): Promise<void>;
+export declare function decompressTarGzAsync(tarballPath: string, destinationDir: string): Promise<void>;
+export declare function getInstalledVersion(): string | null;
+export declare function isVersionOutdated(installedVersion: string): boolean;
+export declare function getOS(): string;
+export declare function getArch(): string;
+export declare function getExtension(): 'tar.gz' | 'zip';
+export declare function buildDownloadUrl(version: string, opt?: {
+    os?: string;
+    arch?: string;
+    ext?: string;
+}): string;

package/dist/cmd/install.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installDependency = void 0;
+exports.buildDownloadUrl = exports.getExtension = exports.getArch = exports.getOS = exports.isVersionOutdated = exports.getInstalledVersion = exports.decompressTarGzAsync = exports.unZipFile = exports.downloadAndSaveCKBBinary = exports.downloadBinaryAndUnzip = exports.installDependency = void 0;
 const axios_1 = __importDefault(require("axios"));
 const child_process_1 = require("child_process");
 const fs = __importStar(require("fs"));
@@ -43,6 +43,7 @@ const path = __importStar(require("path"));
 const semver_1 = __importDefault(require("semver"));
 const os_1 = __importDefault(require("os"));
 const adm_zip_1 = __importDefault(require("adm-zip"));
+const tar = __importStar(require("tar"));
 const const_1 = require("../cfg/const");
 const BINARY = const_1.ckbBinPath;
 const MINIMAL_VERSION = const_1.minimalRequiredCKBVersion;
@@ -53,7 +54,6 @@ function installDependency() {
         if (version) {
             if (isVersionOutdated(version)) {
                 console.log(`${BINARY} version ${version} is outdated, download and install the new version ${MINIMAL_VERSION}..`);
-                console.log(buildDownloadUrl(MINIMAL_VERSION));
             }
             else {
                 return;
@@ -62,22 +62,24 @@ function installDependency() {
         else {
             console.log(`${BINARY} not found, download and install the new version ${MINIMAL_VERSION}..`);
         }
+        yield downloadBinaryAndUnzip();
+    });
+}
+exports.installDependency = installDependency;
+function downloadBinaryAndUnzip() {
+    return __awaiter(this, void 0, void 0, function* () {
         const arch = getArch();
         const osname = getOS();
+        const ext = getExtension();
         const ckbVersionOSName = `ckb_v${MINIMAL_VERSION}_${arch}-${osname}`;
         try {
-            const downloadURL = buildDownloadUrl(MINIMAL_VERSION);
-            const response = yield axios_1.default.get(downloadURL, {
-                responseType: 'arraybuffer',
-            });
-            const tempFilePath = path.join(os_1.default.tmpdir(), `${ckbVersionOSName}.zip`);
-            fs.writeFileSync(tempFilePath, response.data);
+            const tempFilePath = path.join(os_1.default.tmpdir(), `${ckbVersionOSName}.${ext}`);
+            yield downloadAndSaveCKBBinary(tempFilePath);
             // Unzip the file
-            const zip = new adm_zip_1.default(tempFilePath);
             const extractDir = path.join(const_1.targetEnvironmentPath, `ckb_v${MINIMAL_VERSION}`);
-            zip.extractAllTo(extractDir, /*overwrite*/ true);
-            const sourcePath = path.join(extractDir, ckbVersionOSName);
+            yield unZipFile(tempFilePath, extractDir, ext === 'tar.gz');
             // Install the extracted files
+            const sourcePath = path.join(extractDir, ckbVersionOSName);
             fs.renameSync(sourcePath, const_1.ckbFolderPath); // Move binary to desired location
             fs.chmodSync(const_1.ckbBinPath, '755'); // Make the binary executable
             console.log('CKB installed successfully.');
@@ -87,7 +89,53 @@ function installDependency() {
         }
     });
 }
-exports.installDependency = installDependency;
+exports.downloadBinaryAndUnzip = downloadBinaryAndUnzip;
+function downloadAndSaveCKBBinary(tempFilePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const downloadURL = buildDownloadUrl(MINIMAL_VERSION);
+        const response = yield axios_1.default.get(downloadURL, {
+            responseType: 'arraybuffer',
+        });
+        fs.writeFileSync(tempFilePath, response.data);
+    });
+}
+exports.downloadAndSaveCKBBinary = downloadAndSaveCKBBinary;
+function unZipFile(filePath, extractDir, useTar = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Ensure the destination directory exists, if not create it
+        if (!fs.existsSync(extractDir)) {
+            fs.mkdirSync(extractDir, { recursive: true });
+        }
+        if (useTar === true) {
+            return yield decompressTarGzAsync(filePath, extractDir);
+        }
+        const zip = new adm_zip_1.default(filePath);
+        zip.extractAllTo(extractDir, true);
+    });
+}
+exports.unZipFile = unZipFile;
+function decompressTarGzAsync(tarballPath, destinationDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new Promise((resolve, reject) => {
+            // Create a readable stream from the .tar.gz file
+            const tarballStream = fs.createReadStream(tarballPath);
+            // Extract the contents of the .tar.gz file to the destination directory
+            tarballStream
+                .pipe(tar.x({
+                cwd: destinationDir,
+            }))
+                .on('error', (err) => {
+                console.error('Error extracting tarball:', err);
+                reject(err); // Reject with error if extraction fails
+            })
+                .on('finish', () => {
+                console.log('Extraction complete.');
+                resolve(); // Resolve when extraction completes
+            });
+        });
+    });
+}
+exports.decompressTarGzAsync = decompressTarGzAsync;
 function getInstalledVersion() {
     try {
         const versionOutput = (0, child_process_1.execSync)(`${BINARY} --version`, {
@@ -103,9 +151,11 @@ function getInstalledVersion() {
         return null;
     }
 }
+exports.getInstalledVersion = getInstalledVersion;
 function isVersionOutdated(installedVersion) {
     return semver_1.default.lt(installedVersion, MINIMAL_VERSION);
 }
+exports.isVersionOutdated = isVersionOutdated;
 function getOS() {
     const platform = os_1.default.platform();
     if (platform === 'darwin') {
@@ -121,6 +171,7 @@ function getOS() {
         throw new Error('Unsupported operating system');
     }
 }
+exports.getOS = getOS;
 function getArch() {
     const arch = os_1.default.arch();
     if (arch === 'x64') {
@@ -133,8 +184,19 @@ function getArch() {
         throw new Error('Unsupported architecture');
     }
 }
-function buildDownloadUrl(version) {
-    const os = getOS();
-    const arch = getArch();
-    return `https://github.com/nervosnetwork/ckb/releases/download/v${version}/ckb_v${version}_${arch}-${os}.zip`;
+exports.getArch = getArch;
+function getExtension() {
+    const platform = os_1.default.platform();
+    if (platform === 'linux') {
+        return 'tar.gz';
+    }
+    return 'zip';
+}
+exports.getExtension = getExtension;
+function buildDownloadUrl(version, opt = {}) {
+    const os = opt.os || getOS();
+    const arch = opt.arch || getArch();
+    const extension = opt.ext || getExtension();
+    return `https://github.com/nervosnetwork/ckb/releases/download/v${version}/ckb_v${version}_${arch}-${os}.${extension}`;
 }
+exports.buildDownloadUrl = buildDownloadUrl;

package/dist/util.d.ts

@@ -3,8 +3,8 @@ export declare function copyFolderSync(source: string, destination: string): voi
 export declare function copyFileSync(source: string, target: string): void;
 export declare function copyFilesWithExclusion(sourceDir: string, destinationDir: string, excludedFolders: string[]): Promise<void>;
 export declare function copyRecursive(source: string, destination: string, excludedFolders: string[]): Promise<void>;
-export declare function removeFolderSync(folderPath: string): void;
-export declare function gitCloneAndDownloadFolderSync(repoUrl: string, branch: string, subFolderName: string, targetPath: string): void;
+export declare function isGitInstalled(): boolean;
+export declare function gitCloneAndDownloadFolderSync(repoUrl: string, branch: string, subFolderName: string, targetPath: string): undefined;
 export interface TemplateOption {
     name: string;
     value: string;

package/dist/util.js

@@ -35,7 +35,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadTemplateOpts = exports.gitCloneAndDownloadFolderSync = exports.removeFolderSync = exports.copyRecursive = exports.copyFilesWithExclusion = exports.copyFileSync = exports.copyFolderSync = exports.isFolderExists = void 0;
+exports.loadTemplateOpts = exports.gitCloneAndDownloadFolderSync = exports.isGitInstalled = exports.copyRecursive = exports.copyFilesWithExclusion = exports.copyFileSync = exports.copyFolderSync = exports.isFolderExists = void 0;
 const child_process_1 = require("child_process");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
@@ -58,7 +58,7 @@ function isFolderExists(folderPath) {
 exports.isFolderExists = isFolderExists;
 function copyFolderSync(source, destination) {
     if (!fs.existsSync(destination)) {
-        fs.mkdirSync(destination);
+        fs.mkdirSync(destination, { recursive: true });
     }
     const files = fs.readdirSync(source);
     for (const file of files) {
@@ -128,41 +128,47 @@ function copyRecursive(source, destination, excludedFolders) {
     });
 }
 exports.copyRecursive = copyRecursive;
-function removeFolderSync(folderPath) {
-    if (fs.existsSync(folderPath)) {
-        fs.readdirSync(folderPath).forEach((file) => {
-            const curPath = path.join(folderPath, file);
-            if (fs.lstatSync(curPath).isDirectory()) {
-                // Recursive call for directories
-                removeFolderSync(curPath);
-            }
-            else {
-                // Delete files
-                fs.unlinkSync(curPath);
-            }
-        });
-        // Remove the directory itself
-        fs.rmdirSync(folderPath);
+function isGitInstalled() {
+    try {
+        (0, child_process_1.execSync)('git --version');
+        return true;
+    }
+    catch (error) {
+        return false;
     }
 }
-exports.removeFolderSync = removeFolderSync;
+exports.isGitInstalled = isGitInstalled;
 function gitCloneAndDownloadFolderSync(repoUrl, branch, subFolderName, targetPath) {
     console.log('start cloning the dapp template..');
     const tempFolder = path.resolve(const_1.dappTemplatePath, 'temp-clone-folder');
+    if (!isGitInstalled()) {
+        console.log('Git is not installed, please check https://git-scm.com/');
+        return process.exit(1);
+    }
     // Empty the temp folder if it exists
     if (fs.existsSync(tempFolder)) {
-        fs.rmdirSync(tempFolder, { recursive: true });
+        fs.rmSync(tempFolder, { recursive: true });
     }
     // Create the temp folder
     fs.mkdirSync(tempFolder, { recursive: true });
-    const cloneCommand = `
-git clone -n --depth=1 --single-branch --branch ${branch} --filter=tree:0 \
-${repoUrl} ${tempFolder}
-cd ${tempFolder}
-git sparse-checkout set ${subFolderName}
-git checkout
-`;
-    (0, child_process_1.execSync)(cloneCommand);
+    // Clone the repository
+    try {
+        const cloneCommand = `git clone -n --depth=1 --single-branch --branch ${branch} --filter=tree:0 ${repoUrl} ${tempFolder}`;
+        (0, child_process_1.execSync)(cloneCommand);
+    }
+    catch (error) {
+        console.error('Error:', error);
+        process.exit(1);
+    }
+    // checkout the examples sub folder
+    try {
+        (0, child_process_1.execSync)(`git sparse-checkout set ${subFolderName}`, { cwd: tempFolder });
+        (0, child_process_1.execSync)(`git checkout`, { cwd: tempFolder });
+    }
+    catch (error) {
+        console.error('Error:', error);
+        process.exit(1);
+    }
     // Ensure targetPath exists and is a directory
     if (!fs.existsSync(targetPath) || !fs.statSync(targetPath).isDirectory()) {
         fs.mkdirSync(targetPath, { recursive: true });
@@ -171,7 +177,7 @@ git checkout
     copyFolderSync(source, targetPath);
     // Empty the temp folder if it exists
     if (fs.existsSync(tempFolder)) {
-        fs.rmdirSync(tempFolder, { recursive: true });
+        fs.rmSync(tempFolder, { recursive: true });
     }
     console.log(`Folder ${subFolderName} downloaded successfully from ${repoUrl} and moved to ${targetPath}`);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.1.0-rc7",
+  "version": "0.1.0",
   "description": "ckb development network for your first try",
   "author": "Retric Su <retric@cryptape.com>",
   "license": "MIT",
@@ -48,6 +48,7 @@
     "@types/adm-zip": "^0.5.5",
     "@types/node": "^20.11.19",
     "@types/semver": "^7.5.7",
+    "@types/tar": "^6.1.11",
     "@typescript-eslint/eslint-plugin": "^7.0.2",
     "@typescript-eslint/parser": "^7.0.2",
     "eslint": "^8.57.0",
@@ -64,6 +65,7 @@
     "axios": "^1.6.7",
     "child_process": "^1.0.2",
     "commander": "^12.0.0",
-    "semver": "^7.6.0"
+    "semver": "^7.6.0",
+    "tar": "^6.2.1"
   }
 }