amxxpack 0.1.3 → 1.0.1

package/README.md

@@ -1,4 +1,4 @@
-# 📦 AMXXPack 
+# 📦 AMXXPack [![npm](https://img.shields.io/npm/v/amxxpack.svg)](https://www.npmjs.com/package/amxxpack)
 Simple build system and **CLI** for **AMX Mod X** projects.
 
 # 📄 About
@@ -27,32 +27,37 @@ npm install -g amxxpack
 ```
 
 ## ▶ Quick start
-- Create new directory for your project
-- Open a terminal inside the project directory
-- Execute `npm init -y` command to init the package
+- Open a terminal inside the project directory (existing or create a new one)
 - Execute `npm install amxxpack --save-dev` command to install `amxxpack` locally
-- Execute `npx amxxpack init` command to create new config
-- Execute `npx amxxpack fetch-compiler` to download latest compiler release
-- Use `npx amxxpack build` command to build the project
-- Adding build scripts *(optional)*
-
-  To use `npm run build` and `npm run watch` to build or watch the project update the `scripts` section in `package.json`:
-  ```json
-    "scripts": {
-      "build": "amxxpack build",
-      "watch": "amxxpack build --watch"
-    }
-  ```
+- Execute `npx amxxpack create .` command to create new config
+- Execute `npx amxxpack install` to download project dependencies (compiler, thirdparty etc.)
+- Use `npm run build` command to build the project
+- Use `npm run watch` command to build the project and watch changes
 
 ## 📋 Commands
-- `amxxpack init` - init config for a new project
+- `amxxpack create <name>` - create new project
+  - `--git` - initialize git
+  - `--nonpm` - don't initialize npm pacakge 
+  - `--version` - project version
+  - `--author` - project author
+  - `--description` - project name
+- `amxxpack config` - initialize project config in current workspace
+- `amxxpack install` - install project dependencies
+  - `--config` - config file
 - `amxxpack build` - command to build the project
   - `--watch` - flag to watch changes
   - `--config` - config file
 - `amxxpack compile <path|glob>` - compile specific plugin in the project
   - `--config` - config file
-- `amxxpack fetch-compiler` - fetch amxmodx compiler
+- `amxxpack new <script|lib|include> [name]` - create new file in the project workspace
   - `--config` - config file
-  - `--version` - compiler version
-  - `--addon` - addon name
-  - `--dev` - search for dev build
+  - `--name` - plugin name
+  - `--version` - plugin version
+  - `--author` - plugin author
+  - `--lib` - library name
+  - `--include` - include list separated by a comma
+  - `--overwrite` - overwrite file if it already exists
+- `amxpack i` - alias to `install` command
+- `amxpack n` - alias to `new` command
+- `amxpack b` - alias to `build` command
+- `amxpack c` - alias to `compile` command

package/lib/builder/amxxpc.d.ts

@@ -1,27 +1,27 @@
-export declare enum AMXPCMessageType {
-    Echo = "echo",
-    Error = "error",
-    Warning = "warning",
-    FatalError = "fatal error"
-}
-interface IMessage {
-    filename?: string;
-    startLine?: number;
-    endLine?: number;
-    code?: number;
-    type: AMXPCMessageType;
-    text: string;
-}
-interface IParseOutputResult {
-    messages: IMessage[];
-    aborted: boolean;
-    error: boolean;
-}
-interface ICompileResult {
-    output: IParseOutputResult;
-    plugin: string;
-    error?: string;
-    success: boolean;
-}
-declare function compile(params: any): Promise<ICompileResult>;
-export default compile;
+export declare enum AMXPCMessageType {
+    Echo = "echo",
+    Error = "error",
+    Warning = "warning",
+    FatalError = "fatal error"
+}
+interface IMessage {
+    filename?: string;
+    startLine?: number;
+    endLine?: number;
+    code?: number;
+    type: AMXPCMessageType;
+    text: string;
+}
+interface IParseOutputResult {
+    messages: IMessage[];
+    aborted: boolean;
+    error: boolean;
+}
+interface ICompileResult {
+    output: IParseOutputResult;
+    plugin: string;
+    error?: string;
+    success: boolean;
+}
+declare function compile(params: any): Promise<ICompileResult>;
+export default compile;

package/lib/builder/amxxpc.js

@@ -1,122 +1,122 @@
-"use strict";
-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 });
-exports.AMXPCMessageType = void 0;
-var path_1 = __importDefault(require("path"));
-var child_process_1 = __importDefault(require("child_process"));
-var mkdirp_1 = __importDefault(require("mkdirp"));
-var accumulator_1 = __importDefault(require("../utils/accumulator"));
-var PLUGIN_EXT = 'amxx';
-var AMXPCMessageType;
-(function (AMXPCMessageType) {
-    AMXPCMessageType["Echo"] = "echo";
-    AMXPCMessageType["Error"] = "error";
-    AMXPCMessageType["Warning"] = "warning";
-    AMXPCMessageType["FatalError"] = "fatal error";
-})(AMXPCMessageType = exports.AMXPCMessageType || (exports.AMXPCMessageType = {}));
-var MessageRegExp = {
-    filename: /([a-zA-Z0-9.\-_/:\\\s]+)/,
-    line: /\(([0-9]+)(?:\s--\s([0-9]+))?\)/,
-    type: /((?:fatal\s)?error|warning)/,
-    code: /([0-9]+)/,
-    text: /(.*)/
-};
-function buildMessageRegExp() {
-    var filename = MessageRegExp.filename, line = MessageRegExp.line, type = MessageRegExp.type, code = MessageRegExp.code, text = MessageRegExp.text;
-    var pattern = [
-        filename,
-        line,
-        /\s:\s/,
-        type,
-        /\s/,
-        code,
-        /:\s/,
-        text
-    ].map(function (r) { return r.toString().slice(1, -1); }).join('');
-    return new RegExp(pattern);
-}
-var messageRegExp = buildMessageRegExp();
-function parseLine(line) {
-    var match = line.match(messageRegExp);
-    if (!match) {
-        return { type: AMXPCMessageType.Echo, text: line };
-    }
-    var filename = match[1], startLine = match[2], endLine = match[3], type = match[4], code = match[5], text = match[6];
-    return {
-        filename: filename,
-        startLine: +startLine,
-        endLine: endLine ? +endLine : -1,
-        type: type,
-        code: +code,
-        text: text
-    };
-}
-function isAbortedEcho(line) {
-    return line.startsWith('Compilation aborted.')
-        || line.startsWith('Could not locate output file');
-}
-function parseOutput(output) {
-    var result = { messages: [], aborted: false, error: false };
-    output.split('\n').forEach(function (line) {
-        var message = parseLine(line);
-        var type = message.type;
-        if (type === AMXPCMessageType.Error || type === AMXPCMessageType.FatalError) {
-            result.error = true;
-        }
-        else if (type === AMXPCMessageType.Echo && isAbortedEcho(line)) {
-            result.error = true;
-            result.aborted = true;
-        }
-        result.messages.push(message);
-    });
-    return result;
-}
-function formatArgs(params, outPath) {
-    var includeArgs = params.includeDir instanceof Array
-        ? params.includeDir.map(function (dir) { return "-i".concat(dir); })
-        : ["-i".concat(params.includeDir)];
-    return __spreadArray([params.path, "-o".concat(outPath)], includeArgs, true);
-}
-function compile(params) {
-    var parsedPath = path_1.default.parse(params.path);
-    var fileName = "".concat(parsedPath.name, ".").concat(PLUGIN_EXT);
-    var dest = path_1.default.join(params.dest, fileName);
-    mkdirp_1.default.sync(params.dest);
-    return new Promise(function (resolve) {
-        var output = (0, accumulator_1.default)();
-        var done = function (error) {
-            var outputData = output();
-            var parsedOutput = parseOutput(outputData);
-            var errorMessage = error && error.message;
-            if (!errorMessage && parsedOutput.error) {
-                errorMessage = 'Compilation error';
-            }
-            resolve({
-                error: errorMessage,
-                plugin: fileName,
-                success: !errorMessage,
-                output: parsedOutput
-            });
-        };
-        var compilerProcess = child_process_1.default.spawn(params.compiler, formatArgs(params, dest), {
-            env: process.env,
-            cwd: path_1.default.parse(params.compiler).dir
-        });
-        compilerProcess.on('error', done);
-        compilerProcess.on('close', done);
-        compilerProcess.stdout.on('data', output);
-        compilerProcess.stderr.on('data', function (data) { return console.error(data); });
-    });
-}
-exports.default = compile;
+"use strict";
+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 });
+exports.AMXPCMessageType = void 0;
+var path_1 = __importDefault(require("path"));
+var child_process_1 = __importDefault(require("child_process"));
+var mkdirp_1 = __importDefault(require("mkdirp"));
+var accumulator_1 = __importDefault(require("../utils/accumulator"));
+var PLUGIN_EXT = 'amxx';
+var AMXPCMessageType;
+(function (AMXPCMessageType) {
+    AMXPCMessageType["Echo"] = "echo";
+    AMXPCMessageType["Error"] = "error";
+    AMXPCMessageType["Warning"] = "warning";
+    AMXPCMessageType["FatalError"] = "fatal error";
+})(AMXPCMessageType = exports.AMXPCMessageType || (exports.AMXPCMessageType = {}));
+var MessageRegExp = {
+    filename: /([a-zA-Z0-9.\-_/:\\\s]+)/,
+    line: /\(([0-9]+)(?:\s--\s([0-9]+))?\)/,
+    type: /((?:fatal\s)?error|warning)/,
+    code: /([0-9]+)/,
+    text: /(.*)/
+};
+function buildMessageRegExp() {
+    var filename = MessageRegExp.filename, line = MessageRegExp.line, type = MessageRegExp.type, code = MessageRegExp.code, text = MessageRegExp.text;
+    var pattern = [
+        filename,
+        line,
+        /\s:\s/,
+        type,
+        /\s/,
+        code,
+        /:\s/,
+        text
+    ].map(function (r) { return r.toString().slice(1, -1); }).join('');
+    return new RegExp(pattern);
+}
+var messageRegExp = buildMessageRegExp();
+function parseLine(line) {
+    var match = line.match(messageRegExp);
+    if (!match) {
+        return { type: AMXPCMessageType.Echo, text: line };
+    }
+    var filename = match[1], startLine = match[2], endLine = match[3], type = match[4], code = match[5], text = match[6];
+    return {
+        filename: filename,
+        startLine: +startLine,
+        endLine: endLine ? +endLine : -1,
+        type: type,
+        code: +code,
+        text: text
+    };
+}
+function isAbortedEcho(line) {
+    return line.startsWith('Compilation aborted.')
+        || line.startsWith('Could not locate output file');
+}
+function parseOutput(output) {
+    var result = { messages: [], aborted: false, error: false };
+    output.split('\n').forEach(function (line) {
+        var message = parseLine(line);
+        var type = message.type;
+        if (type === AMXPCMessageType.Error || type === AMXPCMessageType.FatalError) {
+            result.error = true;
+        }
+        else if (type === AMXPCMessageType.Echo && isAbortedEcho(line)) {
+            result.error = true;
+            result.aborted = true;
+        }
+        result.messages.push(message);
+    });
+    return result;
+}
+function formatArgs(params, outPath) {
+    var includeArgs = params.includeDir instanceof Array
+        ? params.includeDir.map(function (dir) { return "-i".concat(dir); })
+        : ["-i".concat(params.includeDir)];
+    return __spreadArray([params.path, "-o".concat(outPath)], includeArgs, true);
+}
+function compile(params) {
+    var parsedPath = path_1.default.parse(params.path);
+    var fileName = "".concat(parsedPath.name, ".").concat(PLUGIN_EXT);
+    var dest = path_1.default.join(params.dest, fileName);
+    mkdirp_1.default.sync(params.dest);
+    return new Promise(function (resolve) {
+        var output = (0, accumulator_1.default)();
+        var done = function (error) {
+            var outputData = output();
+            var parsedOutput = parseOutput(outputData);
+            var errorMessage = error && error.message;
+            if (!errorMessage && parsedOutput.error) {
+                errorMessage = 'Compilation error';
+            }
+            resolve({
+                error: errorMessage,
+                plugin: fileName,
+                success: !errorMessage,
+                output: parsedOutput
+            });
+        };
+        var compilerProcess = child_process_1.default.spawn(params.compiler, formatArgs(params, dest), {
+            env: process.env,
+            cwd: path_1.default.parse(params.compiler).dir
+        });
+        compilerProcess.on('error', done);
+        compilerProcess.on('close', done);
+        compilerProcess.stdout.on('data', output);
+        compilerProcess.stderr.on('data', function (data) { return console.error(data); });
+    });
+}
+exports.default = compile;

package/lib/builder/builder.d.ts

@@ -1,22 +1,21 @@
-import { IAmxxBuilderConfig } from './types';
-export default class AmxxBuilder {
-    private logger;
-    private config;
-    constructor(config: IAmxxBuilderConfig);
-    build(): Promise<void>;
-    watch(): Promise<void>;
-    buildSrc(): Promise<void>;
-    buildInclude(): Promise<void>;
-    buildAssets(): Promise<void>;
-    watchSrc(): Promise<void>;
-    watchInclude(): Promise<void>;
-    watchAssets(): Promise<void>;
-    updatePlugin(filePath: string): Promise<void>;
-    updateScript(filePath: string): Promise<void>;
-    updateAsset(filePath: string): Promise<void>;
-    updateInclude(filePath: string): Promise<void>;
-    findPlugins(pattern: string): Promise<string[]>;
-    compilePlugin(filePath: string): Promise<void>;
-    private buildDir;
-    private watchDir;
-}
+import { IProjectConfig } from '../types';
+export default class AmxxBuilder {
+    private config;
+    constructor(config: IProjectConfig);
+    build(): Promise<void>;
+    watch(): Promise<void>;
+    buildSrc(): Promise<void>;
+    buildInclude(): Promise<void>;
+    buildAssets(): Promise<void>;
+    watchSrc(): Promise<void>;
+    watchInclude(): Promise<void>;
+    watchAssets(): Promise<void>;
+    updatePlugin(filePath: string): Promise<void>;
+    updateScript(filePath: string): Promise<void>;
+    updateAsset(filePath: string): Promise<void>;
+    updateInclude(filePath: string): Promise<void>;
+    findPlugins(pattern: string): Promise<string[]>;
+    compilePlugin(filePath: string): Promise<void>;
+    private buildDir;
+    private watchDir;
+}