sandstone-cli 0.6.6 → 1.0.0

package/lib/index.js

@@ -1,5 +1,77 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
-var command_1 = require("@oclif/command");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });
+#!/usr/bin/env node
+import { Argument, Command } from 'commander';
+import figlet from 'figlet';
+import { buildCommand, createCommand, watchCommand } from './commands/index.js';
+const commander = new Command();
+console.log(figlet.textSync('Sandstone'));
+const CLI = commander
+    .version('1.0.0')
+    .description('The CLI for Sandstone - the minecraft pack creation library.');
+const BuildDeclares = {
+    // Flags
+    dry: ['-d, --dry', 'Do not save the pack. Mostly useful with `verbose`.'],
+    verbose: ['-v, --verbose', 'Log all resulting resources: functions, advancements...'],
+    root: ['-r, --root', 'Save the pack & resource pack in the .minecraft/datapacks & .minecraft/resource_packs folders. Override the value specified in the configuration file.'],
+    fullTrace: ['-t, --full-trace', 'Show the full stack trace on errors.'],
+    strictErrors: ['-s, --strict-errors', 'Stop pack compilation on type errors.'],
+    production: ['-p, --production', 'Runs Sandstone in production mode. This sets process.env.SANDSTONE_ENV to "production".'],
+    // Values
+    path: ['--path <path>', 'Path of the folder containing source files.', './src'],
+    config: ['--config-path', 'Path of the sandstone.config.ts folder.', './'],
+    name: ['-n, --name <name>', 'Name of the datapack. Override the value specified in the configuration file.'],
+    namespace: ['-ns, --namespace <namespace>', 'The default namespace. Override the value specified in the configuration file.'],
+    world: ['-w, --world <name>', 'The name of the world to save the packs in. Override the value specified in the configuration file.'],
+    clientPath: ['-c, --client-path <path>', 'Path of the client folder. Override the value specified in the configuration file.'],
+    serverPath: ['--server-path <path>', 'Path of the server folder. Override the value specified in the configuration file.'],
+    // TODO: ssh
+    // TODO: reimplement auto reload
+}; // Haha TypeScript funny
+const build = CLI
+    .command('build')
+    .description('Build the pack(s). ⛏');
+build.option.apply(build, BuildDeclares.dry)
+    .option.apply(build, BuildDeclares.verbose)
+    .option.apply(build, BuildDeclares.root)
+    .option.apply(build, BuildDeclares.fullTrace)
+    .option.apply(build, BuildDeclares.strictErrors)
+    .option.apply(build, BuildDeclares.production)
+    .option.apply(build, BuildDeclares.path)
+    .option.apply(build, BuildDeclares.config)
+    .option.apply(build, BuildDeclares.name)
+    .option.apply(build, BuildDeclares.namespace)
+    .option.apply(build, BuildDeclares.world)
+    .option.apply(build, BuildDeclares.clientPath)
+    .option.apply(build, BuildDeclares.serverPath)
+    .action(buildCommand);
+const watch = CLI
+    .command('watch')
+    .description('Build the packs, and rebuild them on file change. ⛏')
+    .action(watchCommand);
+watch.option.apply(watch, BuildDeclares.dry)
+    .option.apply(watch, BuildDeclares.verbose)
+    .option.apply(watch, BuildDeclares.root)
+    .option.apply(watch, BuildDeclares.fullTrace)
+    .option.apply(watch, BuildDeclares.strictErrors)
+    .option.apply(watch, BuildDeclares.path)
+    .option.apply(watch, BuildDeclares.config)
+    .option.apply(watch, BuildDeclares.name)
+    .option.apply(watch, BuildDeclares.namespace)
+    .option.apply(watch, BuildDeclares.world)
+    .option.apply(watch, BuildDeclares.clientPath)
+    .option.apply(watch, BuildDeclares.serverPath);
+const create = CLI
+    .command('create')
+    .description('Create a new Sandstone project. ⛏')
+    .action(createCommand)
+    .addArgument(new Argument('<projectName>', 'Not the name of the output pack'));
+create.option.apply(create, BuildDeclares.name)
+    .option.apply(create, BuildDeclares.namespace)
+    .option.apply(create, BuildDeclares.world)
+    .option.apply(create, BuildDeclares.clientPath)
+    .option.apply(create, BuildDeclares.serverPath);
+// TODO
+/*CLI
+  .command('update')
+  .description('Update Sandstone & Sandstone-CLI.. ⛏')
+  .action(updateCommand)*/
+CLI.parse(process.argv);

package/lib/utils.d.ts

@@ -1,6 +1,5 @@
-import { InputQuestion, Answers } from 'inquirer';
-export declare function getFlagOrPrompt<T extends Answers = Answers>(flags: Record<string, string | undefined | void | boolean>, name: string, inquirerProps: Omit<InputQuestion<T>, 'name'>): Promise<string>;
 export declare function hasYarn(): boolean;
+export declare function hasPnpm(): boolean;
 /**
  * Get the .minecraft path
  */
@@ -22,9 +21,10 @@ export declare function getWorldPath(worldName: string, minecraftPath?: string |
  * @return The path on success, `null` if no the file is found in any parent.
  */
 export declare function getFileFolder(filename: string, from?: string): string | null;
-export declare type ProjectFolders = {
+export type ProjectFolders = {
     absProjectFolder: string;
     rootFolder: string;
     sandstoneConfigFolder: string;
 };
 export declare function getProjectFolders(projectFolder: string): ProjectFolders;
+export declare const capitalize: (s: string) => string;

package/lib/utils.js

@@ -1,67 +1,58 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectFolders = exports.getFileFolder = exports.getWorldPath = exports.getWorldsList = exports.getMinecraftPath = exports.hasYarn = exports.getFlagOrPrompt = void 0;
-const inquirer_1 = __importDefault(require("inquirer"));
-const fs_1 = __importDefault(require("fs"));
-const os_1 = __importDefault(require("os"));
-const path_1 = __importDefault(require("path"));
-const child_process_1 = require("child_process");
-const chalk_1 = __importDefault(require("chalk"));
-async function getFlagOrPrompt(flags, name, inquirerProps) {
-    const flagValue = flags[name];
-    if (typeof flagValue === 'string') {
-        return flagValue;
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+import { execSync } from 'child_process';
+import chalk from 'chalk';
+export function hasYarn() {
+    try {
+        execSync('yarn --version');
+        return true;
+    }
+    catch (error) {
+        return false;
     }
-    return (await inquirer_1.default.prompt({ name, ...inquirerProps }))[name];
 }
-exports.getFlagOrPrompt = getFlagOrPrompt;
-function hasYarn() {
+export function hasPnpm() {
     try {
-        (0, child_process_1.execSync)('yarn --version');
+        execSync('pnpm --version');
         return true;
     }
     catch (error) {
         return false;
     }
 }
-exports.hasYarn = hasYarn;
 /**
  * Get the .minecraft path
  */
-function getMinecraftPath() {
+export function getMinecraftPath() {
     function getMCPath() {
-        switch (os_1.default.platform()) {
+        switch (os.platform()) {
             case 'win32':
-                return path_1.default.join(os_1.default.homedir(), 'AppData/Roaming/.minecraft');
+                return path.join(os.homedir(), 'AppData/Roaming/.minecraft');
             case 'darwin':
-                return path_1.default.join(os_1.default.homedir(), 'Library/Application Support/minecraft');
+                return path.join(os.homedir(), 'Library/Application Support/minecraft');
             case 'linux':
             default:
-                return path_1.default.join(os_1.default.homedir(), '.minecraft');
+                return path.join(os.homedir(), '.minecraft');
         }
     }
     const mcPath = getMCPath();
-    if (!fs_1.default.existsSync(mcPath)) {
+    if (!fs.existsSync(mcPath)) {
         throw new Error('Unable to locate the .minecraft folder. Please specify it manually.');
     }
     return mcPath;
 }
-exports.getMinecraftPath = getMinecraftPath;
-function getWorldsList() {
+export function getWorldsList() {
     const mcPath = getMinecraftPath();
-    const savesPath = path_1.default.join(mcPath, 'saves');
-    return fs_1.default.readdirSync(savesPath, { withFileTypes: true }).filter((f) => f.isDirectory).map((f) => f.name);
+    const savesPath = path.join(mcPath, 'saves');
+    return fs.readdirSync(savesPath, { withFileTypes: true }).filter((f) => f.isDirectory).map((f) => f.name);
 }
-exports.getWorldsList = getWorldsList;
 /**
  * @param worldName The name of the world
  * @param minecraftPath The optional location of the .minecraft folder.
  * If left unspecified, the .minecraft will be found automatically.
  */
-function getWorldPath(worldName, minecraftPath = undefined) {
+export function getWorldPath(worldName, minecraftPath = undefined) {
     let mcPath;
     if (minecraftPath) {
         mcPath = minecraftPath;
@@ -69,15 +60,14 @@ function getWorldPath(worldName, minecraftPath = undefined) {
     else {
         mcPath = getMinecraftPath();
     }
-    const savesPath = path_1.default.join(mcPath, 'saves');
-    const worldPath = path_1.default.join(savesPath, worldName);
-    if (!fs_1.default.existsSync(worldPath)) {
-        const existingWorlds = fs_1.default.readdirSync(savesPath, { withFileTypes: true }).filter((f) => f.isDirectory).map((f) => f.name);
+    const savesPath = path.join(mcPath, 'saves');
+    const worldPath = path.join(savesPath, worldName);
+    if (!fs.existsSync(worldPath)) {
+        const existingWorlds = fs.readdirSync(savesPath, { withFileTypes: true }).filter((f) => f.isDirectory).map((f) => f.name);
         throw new Error(`Unable to locate the "${worldPath}" folder. Word ${worldName} does not exists. List of existing worlds: ${JSON.stringify(existingWorlds, null, 2)}`);
     }
     return worldPath;
 }
-exports.getWorldPath = getWorldPath;
 /**
  * Recursively search for a file.
  * Starts in the current folder, and go to the parent, recursively.
@@ -87,11 +77,11 @@ exports.getWorldPath = getWorldPath;
  *
  * @return The path on success, `null` if no the file is found in any parent.
  */
-function getFileFolder(filename, from = '.') {
-    let fileFolder = path_1.default.resolve(from);
-    while (!fs_1.default.existsSync(path_1.default.join(fileFolder, filename))) {
+export function getFileFolder(filename, from = '.') {
+    let fileFolder = path.resolve(from);
+    while (!fs.existsSync(path.join(fileFolder, filename))) {
         // Go up 1 folder
-        const newFileFolder = path_1.default.dirname(fileFolder);
+        const newFileFolder = path.dirname(fileFolder);
         if (newFileFolder == fileFolder) {
             // If we arrived to the root folder, give up.
             return null;
@@ -100,22 +90,21 @@ function getFileFolder(filename, from = '.') {
     }
     return fileFolder;
 }
-exports.getFileFolder = getFileFolder;
-function getProjectFolders(projectFolder) {
-    const absProjectFolder = path_1.default.resolve(projectFolder);
+export function getProjectFolders(projectFolder) {
+    const absProjectFolder = path.resolve(projectFolder);
     /// GETTING ALL MANDATORY FILES ///
     // Resolve the location of package.json, in order to get the node_modules folder.
     const rootFolder = getFileFolder('package.json', projectFolder);
     if (!rootFolder) {
-        throw new Error((0, chalk_1.default) `{red Failed to find {bold package.json} in the "${absProjectFolder}" folder, or in any parent folder.}`);
+        throw new Error(chalk `{red Failed to find {bold package.json} in the "${absProjectFolder}" folder, or in any parent folder.}`);
     }
     // Resolve the location of sandstone.config.ts
     const sandstoneConfigFolder = getFileFolder('sandstone.config.ts', projectFolder);
     if (!sandstoneConfigFolder) {
-        throw new Error((0, chalk_1.default) `{red Failed to find {bold sandstone.config.ts} in the "${absProjectFolder}" folder, or in any parent folder.}`);
+        throw new Error(chalk `{red Failed to find {bold sandstone.config.ts} in the "${absProjectFolder}" folder, or in any parent folder.}`);
     }
     return {
         absProjectFolder, rootFolder, sandstoneConfigFolder
     };
 }
-exports.getProjectFolders = getProjectFolders;
+export const capitalize = (s) => s.charAt(0).toUpperCase() + s.slice(1);

package/package.json

@@ -1,7 +1,29 @@
 {
   "name": "sandstone-cli",
-  "description": "The CLI for Sandstone - the datapack creation library.",
-  "version": "0.6.6",
+  "version": "1.0.0",
+  "description": "The CLI for Sandstone - the minecraft pack creation library.",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "bin": {
+    "sand": "./lib/index.js"
+  },
+  "scripts": {
+    "test": "echo NO TESTS",
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sandstone-mc/sandstone-cli.git"
+  },
+  "keywords": [
+    "sandstone",
+    "cli",
+    "command",
+    "line",
+    "interface",
+    "datapack",
+    "minecraft"
+  ],
   "contributors": [
     {
       "name": "TheMrZZ - Florian ERNST",
@@ -13,93 +35,35 @@
       "url": "https://github.com/MulverineX"
     }
   ],
-  "bin": {
-    "sand": "./bin/run"
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sandstone-mc/sandstone-cli/issues"
   },
-  "bugs": "https://github.com/TheMrZZ/sandstone-cli/issues",
+  "homepage": "https://github.com/sandstone-mc/sandstone-cli#readme",
   "dependencies": {
-    "@oclif/command": "^1",
-    "@oclif/config": "^1",
-    "@oclif/plugin-help": "^3",
-    "@oclif/plugin-warn-if-update-available": "^1.7.0",
-    "@types/adm-zip": "^0.5.0",
-    "@types/delete-empty": "^3.0.2",
-    "@types/node": "^18.15.0",
-    "@types/semver": "^7.3.4",
+    "@types/node": "^20.8.6",
     "adm-zip": "^0.5.10",
-    "chalk": "^4.1.0",
-    "chokidar": "^3.4.3",
+    "chalk": "^5.3.0",
+    "chokidar": "^3.5.3",
+    "commander": "^10.0.1",
     "delete-empty": "^3.0.0",
-    "fs-extra": "^9.0.1",
-    "inquirer": "^7.3.3",
-    "klaw": "^3.0.0",
-    "lodash.debounce": "^4.0.8",
-    "madge": "^5.0.1",
-    "minecraft-protocol": "^1.24.2",
-    "nanoid": "^3.1.20",
-    "pretty-error": "^2.1.2",
-    "remove": "^0.1.5",
-    "semver": "^7.3.4",
-    "ts-node": "^9.0.0"
+    "figlet": "^1.6.0",
+    "fs-extra": "^11.1.1",
+    "inquirer": "^9.2.9",
+    "klaw": "^4.1.0",
+    "nanoid": "^4.0.2",
+    "pretty-error": "^4.0.0",
+    "semver": "^7.5.4",
+    "ts-node": "^10.9.1"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1",
-    "@types/fs-extra": "^9.0.4",
-    "@types/inquirer": "^7.3.1",
+    "@types/adm-zip": "^0.5.0",
+    "@types/delete-empty": "^3.0.2",
+    "@types/figlet": "^1.5.6",
+    "@types/fs-extra": "^11.0.1",
+    "@types/inquirer": "^9.0.3",
     "@types/klaw": "^3.0.3",
-    "@types/lodash.debounce": "^4.0.6",
-    "@types/madge": "^5.0.0",
-    "@types/nodemon": "^1.19.0",
-    "chokidar-cli": "^3.0.0",
-    "eslint": "^5.13",
-    "eslint-config-oclif": "^3.1",
-    "eslint-config-oclif-typescript": "^0.1",
-    "globby": "^10",
-    "rimraf": "^3.0.2",
-    "typescript": "^4.3.2"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "files": [
-    "/bin",
-    "/lib",
-    "/npm-shrinkwrap.json",
-    "/oclif.manifest.json"
-  ],
-  "homepage": "https://github.com/TheMrZZ/sandstone-cli",
-  "keywords": [
-    "sandstone",
-    "cli",
-    "command",
-    "line",
-    "interface",
-    "datapack",
-    "minecraft"
-  ],
-  "license": "MIT",
-  "main": "lib/index.js",
-  "oclif": {
-    "commands": "./lib/commands",
-    "bin": "sand",
-    "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-warn-if-update-available"
-    ],
-    "warn-if-update-available": {
-      "timeoutInDays": 7,
-      "message": "<%= chalk.rgb(229,193,0)(config.name) %> has a new update available: <%= chalk.greenBright(latest) %> (current version: <%= chalk.greenBright(config.version) %>).\nUpdate with <%= chalk.gray('npm run update') %> or <%= chalk.gray('yarn update') %>."
-    }
-  },
-  "repository": "TheMrZZ/sandstone-cli",
-  "scripts": {
-    "postpack": "rimraf oclif.manifest.json",
-    "posttest": "eslint . --ext .ts --config .eslintrc",
-    "prepack": "npm run build",
-    "build": "rimraf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "watch": "npm run build && chokidar \"src/**/*\" -c \"npm run build\"",
-    "test": "echo NO TESTS",
-    "version": "oclif-dev readme && git add README.md"
-  },
-  "types": "lib/index.d.ts"
+    "@types/semver": "^7.5.0",
+    "typescript": "^5.1.6"
+  }
 }