vcpm 0.2.2 → 0.4.0

package/README.md

@@ -1,25 +1,147 @@
+![logo.png](logo.png)
+
 # VCPM - Voxel Core Project Manager
 
-CLI util for managing voxel core content packs, with vcpm we can start new project and build it for release
+CLI util for managing voxel core content packs, with vcpm we can start 
+new project and build it for release
 
-## Instalation
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/vcpm.svg)](https://npmjs.org/package/vcpm)
+[![Downloads/week](https://img.shields.io/npm/dw/vcpm.svg)](https://npmjs.org/package/vcpm)
+[![License](https://img.shields.io/github/license/TraumDE/vcpm?)](https://github.com/TraumDE/vcpm/blob/main/LICENSE)
 
-```
+- [Installation](#installation)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Roadmap](#roadmap)
+- [Support Shells](#support-shells)
+- [Support OS](#support-os)
+
+## Installation
+
+### With NPM
+```bash
 npm i -g vcpm
 ```
+### Standalone 
+#### Windows
+- [Windows-arm64 (.exe)](https://github.com/TraumDE/vcpm/releases/download/0.4.0/vcpm-v0.4.0-ef8c1e4-arm64.exe)
+- [Windows-x64 (.exe)](https://github.com/TraumDE/vcpm/releases/download/0.4.0/vcpm-v0.4.0-ef8c1e4-x64.exe)
+#### Linux
+- [Deb-amd64 (.deb)](https://github.com/TraumDE/vcpm/releases/download/0.4.0/vcpm_0.4.0.ef8c1e4-1_amd64.deb)
+- [Deb-arm64 (.deb)](https://github.com/TraumDE/vcpm/releases/download/0.4.0/vcpm_0.4.0.ef8c1e4-1_arm64.deb)
+
+#### MacOS
+- [MacOS-x64 (.pkg)](https://github.com/TraumDE/vcpm/releases/download/0.4.0/vcpm-v0.4.0-ef8c1e4-x64.pkg)
+- [MacOS-arm64 (.pkg)](https://github.com/TraumDE/vcpm/releases/download/0.4.0/vcpm-v0.4.0-ef8c1e4-arm64.pkg)
+
+Other releases can be found in latest release [here](https://github.com/TraumDE/vcpm/releases/latest)
 
 ## Usage
 
-### Build
+### Run command
+
+```Bash
+vcpm COMMAND
 ```
-vcpm build
+
+### Check version
+
+```Bash
+vcpm --version | -v
 ```
-Creates a zip archive for production use, removing in production build all files and folders which starts on dot, and remove type declarations folder.
 
-### Development Build
+### Help with command
+
+```Bash
+vcpm COMMAND --help
 ```
-vcpm build -d | -dev
+
+## Commands
+
+- [`vcpm build`](#vcpm-build)
+- [`vcpm autocomplete`](#vcpm-autocomplete)
+
+### `vcpm build`
+
+Build project
+
+```Bash
+USAGE
+  $ vcpm build [-d]
+
+FLAGS
+  -d, --dev  build in development mode
+
+DESCRIPTION
+  build project
 ```
-Creates a zip archive for development use, without removing any files or folders.
 
-Archive format [pack_id]\_[version].zip
+_See code: [src/commands/build/index.ts](https://github.com/TraumDE/vcpm/blob/main/src/commands/build/index.ts)_
+
+### `vcpm autocomplete`
+
+Display autocomplete installation instructions.
+
+```Bash
+USAGE
+  $ vcpm autocomplete [SHELL] [-r]
+
+ARGUMENTS
+  [SHELL]  (zsh|bash|powershell) Shell type
+
+FLAGS
+  -r, --refresh-cache  Refresh cache (ignores displaying instructions)
+
+DESCRIPTION
+  Display autocomplete installation instructions.
+
+EXAMPLES
+  $ vcpm autocomplete
+
+  $ vcpm autocomplete bash
+
+  $ vcpm autocomplete zsh
+
+  $ vcpm autocomplete powershell
+
+  $ vcpm autocomplete --refresh-cache
+```
+
+## Roadmap
+
+### Plans
+
+- [ ] Made standalone verison
+- [ ] Package management function
+- [ ] Create new project command
+- [ ] More features coming soon
+- [ ] Project Website
+
+### Ready
+
+- [x] Building project for production and development
+- [x] Autocomplete for crossplaforms
+
+## Support Shells
+
+- [x] Bash
+- [x] Zsh
+- [x] Powershell 7+
+- [x] Fish (Without Autocomplete)
+- [x] CMD (Without Autocomplete)
+- [x] Powershell < 7 (Without Autocomplete)
+
+## Support OS
+
+### Windows
+
+- Windows 11 ❓ - 0.2.2 (need update)
+
+### Linux
+
+- Arch Linux ✅ - 0.3.0
+
+### MacOS
+
+No tests on MacOS

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/build/index.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export declare class Build extends Command {
+    static description: string;
+    static flags: {
+        dev: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private addFile;
+    private build;
+    private fileExists;
+    private readPackage;
+}

package/dist/commands/build/index.js

@@ -0,0 +1,74 @@
+import { Command, Flags } from '@oclif/core';
+import { BlobReader, BlobWriter, ZipWriter } from '@zip.js/zip.js';
+import { glob } from 'glob';
+import { Buffer } from 'node:buffer';
+import { promises as fs } from 'node:fs';
+export class Build extends Command {
+    static description = 'Build project';
+    static flags = {
+        dev: Flags.boolean({ char: 'd', description: 'Build in development mode' }),
+    };
+    async run() {
+        await this.build();
+    }
+    async addFile(file, zipWriter) {
+        const relativePath = file.relative();
+        await zipWriter.add(relativePath, new BlobReader(new Blob([new Uint8Array(await fs.readFile(relativePath))])));
+    }
+    async build() {
+        const packageInfo = await this.readPackage();
+        const { flags } = await this.parse(Build);
+        this.log('Start building...');
+        if (await this.fileExists('dist')) {
+            this.log('Remove previous build...');
+            await fs.rm('dist', { force: true, recursive: true });
+        }
+        await fs.mkdir('dist');
+        const files = await glob('**/*', {
+            cwd: process.cwd(),
+            dot: true,
+            ignore: flags.dev ? [] : ['**/.*', '**/.*/**', 'dist/**/*', 'modules/types/**/*'],
+            nodir: true,
+            withFileTypes: true,
+        });
+        const zipFileWriter = new BlobWriter('application/zip');
+        const zipWriter = new ZipWriter(zipFileWriter);
+        const filePromises = files.map((file) => this.addFile(file, zipWriter));
+        await Promise.all(filePromises);
+        const zipBlob = await zipWriter.close();
+        const buffer = Buffer.from(await zipBlob.arrayBuffer());
+        await fs.writeFile(`dist/${packageInfo.id}_${packageInfo.version}${flags.dev ? '_dev' : ''}.zip`, buffer);
+        if (flags.dev) {
+            this.log('Development build completed!');
+        }
+        else {
+            this.log('Production build completed!');
+        }
+    }
+    async fileExists(file) {
+        try {
+            await fs.access(file, fs.constants.F_OK);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    async readPackage() {
+        if (!(await this.fileExists('package.json'))) {
+            this.error('package.json file does not exist', {
+                code: 'ENOENT',
+            });
+        }
+        const packageJsonParsed = JSON.parse(await fs.readFile('package.json', 'utf8'));
+        if (!packageJsonParsed.id && !packageJsonParsed.version) {
+            this.error('Its not voxel core content pack', {
+                code: 'EINVAL',
+            });
+        }
+        return {
+            id: packageJsonParsed.id,
+            version: packageJsonParsed.version,
+        };
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -1,19 +1 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const build_1 = __importDefault(require("./commands/build"));
-const program = new commander_1.Command();
-program
-    .name("vcpm")
-    .description("VCPM - Voxel Core Project Manager. Is unoficall CLI util for managing content packs")
-    .version("0.1.0");
-program
-    .command("build")
-    .description("Build project for production")
-    .option("-d, --dev", "Build project for development", false)
-    .action(build_1.default);
-program.parse();
+export { run } from '@oclif/core';

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './package-info.js';

package/dist/types/index.js

@@ -1,18 +1 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./packInfo"), exports);
-__exportStar(require("./buildOptions"), exports);
+export * from './package-info.js';

package/dist/types/package-info.d.ts

@@ -0,0 +1,4 @@
+export interface PackageInfo {
+    id: string;
+    version: string;
+}

package/dist/types/package-info.js

@@ -0,0 +1 @@
+export {};

package/oclif.manifest.json

@@ -0,0 +1,34 @@
+{
+  "commands": {
+    "build": {
+      "aliases": [],
+      "args": {},
+      "description": "Build project",
+      "flags": {
+        "dev": {
+          "char": "d",
+          "description": "Build in development mode",
+          "name": "dev",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "build",
+      "pluginAlias": "vcpm",
+      "pluginName": "vcpm",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "build",
+        "index.js"
+      ]
+    }
+  },
+  "version": "0.4.0"
+}

package/package.json

@@ -1,39 +1,81 @@
 {
   "name": "vcpm",
-  "version": "0.2.2",
-  "description": "VCPM - Voxel Core Project Manager. Is unoficall CLI util for managing content packs",
-  "main": "dist/index.js",
-  "preferGlobal": "true",
-  "bin": "./dist/index.js",
+  "description": "VCPM - Voxel Core Project Manager",
+  "version": "0.4.0",
+  "author": "Eugene301|TraumDE",
+  "bin": "./bin/run.js",
+  "bugs": "https://github.com/TraumDE/vcpm/issues",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-autocomplete": "^3.2.39",
+    "@zip.js/zip.js": "^2.8.15",
+    "glob": "^13.0.0"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.4.0"
+  },
   "files": [
-    "dist/",
-    "README.md",
-    "LICENSE"
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
   ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "ts-node src/index.ts"
-  },
+  "homepage": "https://github.com/TraumDE/vcpm",
   "keywords": [
-    "Voxel Core",
+    "oclif",
     "CLI",
-    "Utility"
+    "VCPM",
+    "Voxel Core Project Manager",
+    "Voxel Core",
+    "Utility",
+    "Util"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/TraumDE/vcpm.git"
-  },
-  "author": "Eugene301|TraumDE",
   "license": "MIT",
-  "packageManager": "yarn@4.12.0",
-  "devDependencies": {
-    "@types/archiver": "^7",
-    "@types/node": "^25.0.3",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.9.3"
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "macos": {
+      "identifier": "com.voxelcorepackagemanager.cli"
+    },
+    "bin": "vcpm",
+    "dirname": "vcpm",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-autocomplete"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
   },
-  "dependencies": {
-    "archiver": "^7.0.1",
-    "commander": "^14.0.2"
-  }
+  "repository": "TraumDE/vcpm",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts",
+  "packageManager": "yarn@4.12.0"
 }

package/dist/commands/build.js

@@ -1,54 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const process_1 = require("process");
-const fs_1 = __importDefault(require("fs"));
-const path_1 = require("path");
-const archiver_1 = __importDefault(require("archiver"));
-const isExists = (path) => {
-    return fs_1.default.existsSync((0, path_1.join)((0, process_1.cwd)(), path));
-};
-const getPackData = () => {
-    const jsonData = JSON.parse(fs_1.default.readFileSync((0, path_1.join)((0, process_1.cwd)(), "package.json"), "utf-8"));
-    return {
-        id: jsonData.id,
-        version: jsonData.version,
-    };
-};
-const createDistZip = (isDev) => {
-    if (!isExists("package.json")) {
-        console.log("Not found package.json!");
-        return;
-    }
-    const packData = getPackData();
-    const distPath = `dist/${packData.id}_${packData.version}.zip`;
-    if (isExists(distPath)) {
-        fs_1.default.rmSync(distPath);
-    }
-    const output = fs_1.default.createWriteStream(distPath);
-    const archive = (0, archiver_1.default)("zip", { zlib: { level: 9 } });
-    archive.pipe(output);
-    archive.glob("**/*", {
-        cwd: ".",
-        ignore: isDev ? [] : ["**/.*/**", "**/.*", "modules/types/**", "dist/**"],
-        dot: true,
-    });
-    archive.finalize();
-    if (isDev) {
-        console.log("Project builded for development!");
-    }
-    else {
-        console.log("Project builded for production!");
-    }
-};
-const checkDistFolder = () => {
-    if (!isExists("dist")) {
-        fs_1.default.mkdirSync("dist");
-    }
-};
-exports.default = (options) => {
-    checkDistFolder();
-    createDistZip(options.dev);
-};

package/dist/types/buildOptions.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/packInfo.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });