vcpm 0.1.0 → 0.2.0

package/README.md

@@ -1,3 +1,25 @@
 # 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
+
+## Instalation
+
+```
+npm i -g vcpm
+```
+
+## Usage
+
+### Build
+```
+vcpm build
+```
+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
+```
+vcpm build -d | -dev
+```
+Creates a zip archive for development use, without removing any files or folders.
+
+Archive format [pack_id]\_[version].zip

package/dist/commands/build.js

@@ -17,21 +17,22 @@ const getPackData = () => {
         version: jsonData.version,
     };
 };
-const createDistZip = () => {
+const createDistZip = (isDev) => {
     if (!isExists("package.json")) {
         console.log("Not found package.json!");
         return;
     }
-    if (isExists("dist/build.zip")) {
-        fs_1.default.rmSync("dist/build.zip");
-    }
     const packData = getPackData();
-    const output = fs_1.default.createWriteStream(`dist/${packData.id}_${packData.version}.zip`);
+    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: ["**/.*/**", "**/.*", "modules/types/**", "dist/**"],
+        ignore: isDev ? [] : ["**/.*/**", "**/.*", "modules/types/**", "dist/**"],
         dot: true,
     });
     archive.finalize();
@@ -42,7 +43,7 @@ const checkDistFolder = () => {
         fs_1.default.mkdirSync("dist");
     }
 };
-exports.default = () => {
+exports.default = (options) => {
     checkDistFolder();
-    createDistZip();
+    createDistZip(options.dev);
 };

package/dist/index.js

@@ -14,5 +14,6 @@ program
 program
     .command("build")
     .description("Build project for production")
+    .option("-d, --dev", "Build project for development", false)
     .action(build_1.default);
 program.parse();

package/dist/types/buildOptions.js

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

package/dist/types/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./packInfo"), exports);
+__exportStar(require("./buildOptions"), exports);

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "vcpm",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "VCPM - Voxel Core Project Manager. Is unoficall CLI util for managing content packs",
   "main": "dist/index.js",
   "preferGlobal": "true",
-  "bin": {
-    "vcpm": "./dist/index.js"
-  },
+  "bin": "./dist/index.js",
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "tsc",
     "dev": "ts-node src/index.ts"
@@ -16,6 +19,10 @@
     "CLI",
     "Utility"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TraumDE/vcpm.git"
+  },
   "author": "Eugene301|TraumDE",
   "license": "MIT",
   "packageManager": "yarn@4.12.0",

package/.editorconfig

@@ -1,8 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true

package/.gitattributes

@@ -1,4 +0,0 @@
-/.yarn/**            linguist-vendored
-/.yarn/releases/*    binary
-/.yarn/plugins/**/*  binary
-/.pnp.*              binary linguist-generated

package/.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-  "recommendations": [
-    "arcanis.vscode-zipfs"
-  ]
-}

package/.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-  "search.exclude": {
-    "**/.yarn": true,
-    "**/.pnp.*": true
-  },
-  "typescript.tsdk": ".yarn/sdks/typescript/lib",
-  "typescript.enablePromptUseWorkspaceTsdk": true
-}

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules

package/src/commands/build.ts

@@ -1,59 +0,0 @@
-import { cwd } from "process";
-import fs from "fs";
-import { join } from "path";
-import archiver from "archiver";
-import type { PackInfo } from "../types";
-
-const isExists = (path: string): boolean => {
-  return fs.existsSync(join(cwd(), path));
-};
-
-const getPackData = (): PackInfo => {
-  const jsonData = JSON.parse(
-    fs.readFileSync(join(cwd(), "package.json"), "utf-8")
-  );
-
-  return {
-    id: jsonData.id,
-    version: jsonData.version,
-  };
-};
-
-const createDistZip = (): void => {
-  if (!isExists("package.json")) {
-    console.log("Not found package.json!");
-    return;
-  }
-
-  if (isExists("dist/build.zip")) {
-    fs.rmSync("dist/build.zip");
-  }
-
-  const packData: PackInfo = getPackData();
-
-  const output = fs.createWriteStream(
-    `dist/${packData.id}_${packData.version}.zip`
-  );
-  const archive = archiver("zip", { zlib: { level: 9 } });
-
-  archive.pipe(output);
-  archive.glob("**/*", {
-    cwd: ".",
-    ignore: ["**/.*/**", "**/.*", "modules/types/**", "dist/**"],
-    dot: true,
-  });
-  archive.finalize();
-
-  console.log("Project builded for production!");
-};
-
-const checkDistFolder = (): void => {
-  if (!isExists("dist")) {
-    fs.mkdirSync("dist");
-  }
-};
-
-export default (): void => {
-  checkDistFolder();
-  createDistZip();
-};

package/src/index.ts

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-import { Command } from "commander";
-import build from "./commands/build";
-
-const program: Command = new 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")
-  .action(build);
-
-program.parse();

package/src/types/index.ts

@@ -1 +0,0 @@
-export * from "./packInfo";

package/src/types/packInfo.ts

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

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "moduleResolution": "node",
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "declaration": false,
-    "sourceMap": false,
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*"]
-}