amxxpack 0.0.4 → 0.0.8

package/README.md

@@ -11,6 +11,9 @@ This system will be useful for projects with multiple plugins and assets. Using
 - 🔥 Hot reload
 - 🧸 Assets builder
 
+## 🔄Requirements
+- Node.js 10.0.0+
+
 ## 🔧 Installation
 **AMXXPack** is available through the npm registry.
 Installation can be done using the `npm install` command:
@@ -29,6 +32,7 @@ npm install -g amxxpack
 - Execute `npm init -y` command to init the package
 - Execute `npm install amxxpack --save-dev` command to install `amxxpack` locally
 - Execute `npx amxxpack init` command to create new config
+- Extract the **Amx Mod X** compiler to the `./compiler` dir of the project (content of `scripting` folder).
 - Use `npx amxxpack build` command to build the project
 - Adding build scripts *(optional)*
 

package/lib/builder/builder.js

@@ -73,12 +73,13 @@ var mkdirp_1 = __importDefault(require("mkdirp"));
 var glob_promise_1 = __importDefault(require("glob-promise"));
 var chokidar_1 = __importDefault(require("chokidar"));
 var normalize_path_1 = __importDefault(require("normalize-path"));
+var lodash_1 = require("lodash");
 var amxxpc_1 = __importStar(require("./amxxpc"));
 var logger_1 = __importDefault(require("../services/logger"));
 var constants_1 = require("./constants");
 var AmxxBuilder = /** @class */ (function () {
     function AmxxBuilder(config) {
-        var compiler = config.compiler, input = config.input, output = config.output;
+        var compiler = config.compiler, input = config.input, output = config.output, rules = config.rules;
         this.logger = new logger_1.default();
         this.config = {
             compiler: {
@@ -95,6 +96,9 @@ var AmxxBuilder = /** @class */ (function () {
                 plugins: path_1.default.resolve(output.plugins),
                 include: path_1.default.resolve(output.include),
                 assets: path_1.default.resolve(output.assets)
+            },
+            rules: {
+                flatCompilation: (0, lodash_1.get)(rules, 'flatCompilation', true)
             }
         };
     }
@@ -308,13 +312,17 @@ var AmxxBuilder = /** @class */ (function () {
     };
     AmxxBuilder.prototype.compilePlugin = function (filePath) {
         return __awaiter(this, void 0, void 0, function () {
-            var srcPath, destDir, relateiveSrcPath, result, destPath, relativeFilePath;
+            var srcPath, destDir, srcDir, relateiveSrcPath, result, destPath, relativeFilePath;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         srcPath = path_1.default.resolve(filePath);
                         destDir = path_1.default.resolve(this.config.output.plugins);
+                        if (!this.config.rules.flatCompilation) {
+                            srcDir = path_1.default.parse(srcPath).dir;
+                            destDir = path_1.default.join(destDir, path_1.default.relative(this.config.input.scripts, srcDir));
+                        }
                         relateiveSrcPath = path_1.default.relative(process.cwd(), srcPath);
                         return [4 /*yield*/, (0, mkdirp_1.default)(destDir)];
                     case 1:

package/lib/builder/types.d.ts

@@ -14,4 +14,7 @@ export interface IAmxxBuilderConfig {
         include: string;
         assets: string;
     };
+    rules?: {
+        flatCompilation?: boolean;
+    };
 }

package/lib/cli/controller.d.ts

@@ -5,6 +5,12 @@ declare class Controller {
     init(projectDir: string): Promise<void>;
     compile(scriptPath: string, configPath: string): Promise<void>;
     build(configPath: string, watch: boolean): Promise<void>;
+    fetchCompiler({ configPath, version, dev, addons }: {
+        configPath: string;
+        version: string;
+        dev: boolean;
+        addons: string[];
+    }): Promise<void>;
 }
 declare const _default: Controller;
 export default _default;

package/lib/cli/controller.js

@@ -44,6 +44,7 @@ var fs_1 = __importDefault(require("fs"));
 var mkdirp_1 = __importDefault(require("mkdirp"));
 // import childProcess from 'child_process';
 var builder_1 = __importDefault(require("../builder"));
+var compiler_downloader_1 = __importDefault(require("../compiler-downloader"));
 function resolveConfigPath(configPath) {
     return path_1.default.isAbsolute(configPath) ? configPath : path_1.default.join(process.cwd(), configPath);
 }
@@ -158,6 +159,24 @@ var Controller = /** @class */ (function () {
             });
         });
     };
+    Controller.prototype.fetchCompiler = function (_a) {
+        var configPath = _a.configPath, version = _a.version, dev = _a.dev, addons = _a.addons;
+        return __awaiter(this, void 0, void 0, function () {
+            var config, compilerPath;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, this.loadConfig(configPath)];
+                    case 1:
+                        config = _b.sent();
+                        compilerPath = path_1.default.parse(config.compiler.executable).dir;
+                        return [4 /*yield*/, (0, compiler_downloader_1.default)({ path: path_1.default.resolve(compilerPath), dists: addons, version: version, dev: dev })];
+                    case 2:
+                        _b.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     return Controller;
 }());
 exports.default = new Controller();

package/lib/cli/program.js

@@ -64,11 +64,14 @@ program
 program
     .command('compile')
     .argument('<path>', 'Script path or glob')
-    .option('--config, -c', 'Config file', '.amxxpack.json')
+    .option('--config, -c <path>', 'Config file', '.amxxpack.json')
     .action(function (str, options) { return __awaiter(void 0, void 0, void 0, function () {
+    var configPath;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, controller_1.default.compile(str, options.C)];
+            case 0:
+                configPath = options.C;
+                return [4 /*yield*/, controller_1.default.compile(str, configPath)];
             case 1:
                 _a.sent();
                 return [2 /*return*/];
@@ -78,16 +81,36 @@ program
 program
     .command('build')
     .option('--watch, -w', 'Watch project')
-    .option('--config, -c', 'Config file', '.amxxpack.json')
+    .option('--config, -c <path>', 'Config file', '.amxxpack.json')
     .action(function (str, options) { return __awaiter(void 0, void 0, void 0, function () {
-    var opts;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
+    var _a, configPath, watch;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
             case 0:
-                opts = options.opts();
-                return [4 /*yield*/, controller_1.default.build(opts.C, opts.W)];
+                _a = options.opts(), configPath = _a.C, watch = _a.W;
+                return [4 /*yield*/, controller_1.default.build(configPath, watch)];
             case 1:
-                _a.sent();
+                _b.sent();
+                return [2 /*return*/];
+        }
+    });
+}); });
+program
+    .command('fetch-compiler')
+    .option('--config, -c <path>', 'Config file', '.amxxpack.json')
+    .option('--version, -v <version>', 'Version', '1.8.2')
+    .option('--addon, -a <addon>', 'Addon', 'base')
+    .option('--dev, -d', 'Dev build flag', false)
+    .action(function (str, options) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, dev, addon, version, configPath, addons;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                _a = options.opts(), dev = _a.D, addon = _a.A, version = _a.V, configPath = _a.C;
+                addons = addon.split(' ');
+                return [4 /*yield*/, controller_1.default.fetchCompiler({ configPath: configPath, version: version, dev: dev, addons: addons })];
+            case 1:
+                _b.sent();
                 return [2 /*return*/];
         }
     });

package/lib/compiler-downloader/constants.d.ts

@@ -0,0 +1,13 @@
+export declare const DOWNLOAD_HOST = "https://www.amxmodx.org";
+export declare const SCRIPTING_DIR = "addons/amxmodx/scripting/";
+export declare const EXTENSIONS_IGNORE_LIST: string[];
+export declare const DOWNLOAD_DIR = ".downloads";
+export declare enum CompilerPlatform {
+    Windows = "windows",
+    Linux = "linux",
+    Mac = "mac"
+}
+export declare enum DistSource {
+    Dev = "amxxdrop",
+    Release = "release"
+}

package/lib/compiler-downloader/constants.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DistSource = exports.CompilerPlatform = exports.DOWNLOAD_DIR = exports.EXTENSIONS_IGNORE_LIST = exports.SCRIPTING_DIR = exports.DOWNLOAD_HOST = void 0;
+exports.DOWNLOAD_HOST = 'https://www.amxmodx.org';
+exports.SCRIPTING_DIR = 'addons/amxmodx/scripting/';
+exports.EXTENSIONS_IGNORE_LIST = ['.sma'];
+exports.DOWNLOAD_DIR = '.downloads';
+var CompilerPlatform;
+(function (CompilerPlatform) {
+    CompilerPlatform["Windows"] = "windows";
+    CompilerPlatform["Linux"] = "linux";
+    CompilerPlatform["Mac"] = "mac";
+})(CompilerPlatform = exports.CompilerPlatform || (exports.CompilerPlatform = {}));
+var DistSource;
+(function (DistSource) {
+    DistSource["Dev"] = "amxxdrop";
+    DistSource["Release"] = "release";
+})(DistSource = exports.DistSource || (exports.DistSource = {}));

package/lib/compiler-downloader/downloader.d.ts

@@ -0,0 +1,2 @@
+import { IDownloadCompilerOptions } from './types';
+export default function downloadCompiler(options: IDownloadCompilerOptions): Promise<void>;

package/lib/compiler-downloader/downloader.js

@@ -0,0 +1,173 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var fs_1 = __importDefault(require("fs"));
+var path_1 = __importDefault(require("path"));
+var https_1 = __importDefault(require("https"));
+var mkdirp_1 = __importDefault(require("mkdirp"));
+var normalize_path_1 = __importDefault(require("normalize-path"));
+var decompress_1 = __importDefault(require("decompress"));
+var resolvers_1 = require("./resolvers");
+var constants_1 = require("./constants");
+function downloadDist(dist) {
+    return __awaiter(this, void 0, void 0, function () {
+        var downloadDir, fileName, filePath, file;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    downloadDir = path_1.default.join(__dirname, constants_1.DOWNLOAD_DIR);
+                    return [4 /*yield*/, (0, mkdirp_1.default)(downloadDir)];
+                case 1:
+                    _a.sent();
+                    fileName = (0, resolvers_1.resolveFileName)(dist);
+                    filePath = path_1.default.join(downloadDir, fileName);
+                    file = fs_1.default.createWriteStream(filePath);
+                    return [2 /*return*/, new Promise(function (resolve, reject) {
+                            var source = (0, resolvers_1.resolveSource)(dist);
+                            var url = (0, resolvers_1.resolveUrl)(source, fileName);
+                            console.log('Fetching dist from', url, '...');
+                            var done = function () {
+                                file.close();
+                                resolve({ dist: dist, path: filePath });
+                            };
+                            var cancel = function (err) {
+                                fs_1.default.unlink(filePath, function () { return reject(err); });
+                            };
+                            var request = https_1.default.get(url, function (response) {
+                                if (!response.statusCode || response.statusCode < 200 || response.statusCode >= 300) {
+                                    cancel(new Error("HTTP Error: ".concat(response.statusCode)));
+                                    return;
+                                }
+                                response.pipe(file);
+                            });
+                            file.on('finish', done);
+                            request.on('error', cancel);
+                            file.on('error', cancel);
+                        })];
+            }
+        });
+    });
+}
+function extractDist(archivePath, outDir) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, mkdirp_1.default)(outDir)];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, (0, decompress_1.default)(archivePath, outDir, {
+                            map: function (file) {
+                                var newFile = __assign({}, file);
+                                var filePath = (0, normalize_path_1.default)(newFile.path);
+                                if (filePath.startsWith(constants_1.SCRIPTING_DIR)) {
+                                    newFile.path = newFile.path.slice(constants_1.SCRIPTING_DIR.length);
+                                }
+                                return newFile;
+                            },
+                            filter: function (file) {
+                                var filePath = (0, normalize_path_1.default)(file.path);
+                                if (!filePath.startsWith(constants_1.SCRIPTING_DIR)) {
+                                    return false;
+                                }
+                                var ext = path_1.default.parse(file.path).ext;
+                                return !constants_1.EXTENSIONS_IGNORE_LIST.includes(ext);
+                            }
+                        })];
+                case 2:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    });
+}
+function downloadCompiler(options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var version, dev, dists, compilerPath, platform, newDists, _i, newDists_1, dist, distArchive;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    version = options.version, dev = options.dev, dists = options.dists, compilerPath = options.path;
+                    platform = (0, resolvers_1.resolvePlatform)();
+                    newDists = __spreadArray([], dists, true);
+                    if (!newDists.includes('base')) {
+                        newDists.unshift('base');
+                    }
+                    _i = 0, newDists_1 = newDists;
+                    _a.label = 1;
+                case 1:
+                    if (!(_i < newDists_1.length)) return [3 /*break*/, 5];
+                    dist = newDists_1[_i];
+                    return [4 /*yield*/, downloadDist({ name: dist, version: version, platform: platform, dev: dev })];
+                case 2:
+                    distArchive = _a.sent();
+                    return [4 /*yield*/, extractDist(distArchive.path, compilerPath)];
+                case 3:
+                    _a.sent();
+                    _a.label = 4;
+                case 4:
+                    _i++;
+                    return [3 /*break*/, 1];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.default = downloadCompiler;

package/lib/compiler-downloader/index.d.ts

@@ -0,0 +1 @@
+export { default } from './downloader';

package/lib/compiler-downloader/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
+// eslint-disable-next-line no-restricted-exports
+var downloader_1 = require("./downloader");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(downloader_1).default; } });

package/lib/compiler-downloader/resolvers.d.ts

@@ -0,0 +1,6 @@
+import { IDist } from './types';
+import { CompilerPlatform } from './constants';
+export declare function resolveSource({ dev, version }: IDist): string;
+export declare function resolveFileName({ name: dist, version, platform }: IDist): string;
+export declare function resolvePlatform(): CompilerPlatform;
+export declare function resolveUrl(source: string, file: string): string;

package/lib/compiler-downloader/resolvers.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveUrl = exports.resolvePlatform = exports.resolveFileName = exports.resolveSource = void 0;
+var os_1 = __importDefault(require("os"));
+var constants_1 = require("./constants");
+function resolveSource(_a) {
+    var dev = _a.dev, version = _a.version;
+    var urlPath = [
+        dev ? constants_1.DistSource.Dev : constants_1.DistSource.Release
+    ];
+    if (dev) {
+        urlPath.push(version.split('.').slice(0, 2).join('.'));
+    }
+    return urlPath.join('/');
+}
+exports.resolveSource = resolveSource;
+function resolveFileName(_a) {
+    var dist = _a.name, version = _a.version, platform = _a.platform;
+    var ext = platform === 'linux' ? '.tar.gz' : '.zip';
+    return "amxmodx-".concat(version, "-").concat(dist, "-").concat(platform).concat(ext);
+}
+exports.resolveFileName = resolveFileName;
+function resolvePlatform() {
+    var platform = os_1.default.platform();
+    switch (platform) {
+        case 'win32': return constants_1.CompilerPlatform.Windows;
+        case 'linux': return constants_1.CompilerPlatform.Linux;
+        case 'darwin': return constants_1.CompilerPlatform.Mac;
+    }
+    throw new Error("Unable to resolve platform for ".concat(platform));
+}
+exports.resolvePlatform = resolvePlatform;
+function resolveUrl(source, file) {
+    return "".concat(constants_1.DOWNLOAD_HOST, "/").concat(source, "/").concat(file);
+}
+exports.resolveUrl = resolveUrl;

package/lib/compiler-downloader/types.d.ts

@@ -0,0 +1,16 @@
+export interface IDist {
+    name: string;
+    version: string;
+    platform: string;
+    dev: boolean;
+}
+export interface IDistFile {
+    dist: IDist;
+    path: string;
+}
+export interface IDownloadCompilerOptions {
+    path: string;
+    version: string;
+    dev: boolean;
+    dists: string[];
+}

package/lib/compiler-downloader/types.js

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

package/package.json

@@ -2,7 +2,7 @@
   "name": "amxxpack",
   "description": "AMXXPack",
   "author": "Hedgehog Fog",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "license": "MIT",
   "main": "lib/builder/index.js",
   "types": "lib/builder/index.d.ts",
@@ -34,12 +34,13 @@
     "pawn"
   ],
   "dependencies": {
-    "chalk": "^5.0.0",
     "chokidar": "^3.5.3",
     "colors": "^1.4.0",
     "commander": "^9.0.0",
+    "decompress": "^4.2.1",
     "glob": "^7.2.0",
     "glob-promise": "^4.2.2",
+    "lodash": "^4.17.21",
     "mkdirp": "^1.0.4",
     "normalize-path": "^3.0.0"
   },
@@ -47,6 +48,8 @@
     "@types/chokidar": "^2.1.3",
     "@types/colors": "^1.2.1",
     "@types/commander": "^2.12.2",
+    "@types/decompress": "^4.2.4",
+    "@types/lodash": "^4.14.178",
     "@types/mkdirp": "^1.0.2",
     "@types/normalize-path": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^5.12.0",

package/resources/default-config.json

@@ -15,5 +15,8 @@
     "plugins": "./dist/addons/amxmodx/plugins",
     "include": "./dist/addons/amxmodx/scripting/include",
     "assets": "./dist"
+  },
+  "rules": {
+    "flatCompilation": true
   }
 }