amxxpack 1.1.1 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hedgehog Fog
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,7 @@
-# 📦 AMXXPack [![npm](https://img.shields.io/npm/v/amxxpack.svg)](https://www.npmjs.com/package/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
+## 📄 About
 
 This system will be useful for projects with multiple plugins and assets. Using the command-line interface you can build entire project with a single command. It also supports hot rebuild to keep your plugins and assets up to date during the work.
 
@@ -47,8 +47,11 @@ npm install -g amxxpack
 - `amxxpack build` - command to build the project
   - `--watch` - flag to watch changes
   - `--config` - config file
+  - `--ignore` - ignore build errors
+  - `--no-cache` - disable caching
 - `amxxpack compile <path|glob>` - compile specific plugin in the project
   - `--config` - config file
+  - `--no-cache` - disable caching
 - `amxxpack new <script|lib|include> [name]` - create new file in the project workspace
   - `--config` - config file
   - `--name` - plugin name
@@ -61,3 +64,79 @@ npm install -g amxxpack
 - `amxpack n` - alias to `new` command
 - `amxpack b` - alias to `build` command
 - `amxpack c` - alias to `compile` command
+
+## 🦸 Advanced configuration
+
+### Thir-party dependencies
+In case your project requires third-party modules you can specify a link to third-party archives and these archives will be downloaded and extracted to the third-party directory.
+```json
+{
+  "thirdparty": {
+    "dir": "./.thirdparty",
+    "dependencies": [
+      {
+        "name": "somemodule",
+        "url": "https://website/somemodule-v100.zip"
+      }
+    ]
+  }
+}
+```
+
+configuration above will download `somemodule-v100.zip` archive and extract it to the `./.thirdparty/somemodule` directory then you can use thirparty files in your project. For example add thirparty directory to include list:
+```json
+{
+    "include": [
+      "./.thirdparty/somemodule/include"
+    ]
+}
+```
+
+### Multiple directories as an input
+You can use multiple directories as builder inputs, just specify an array of directories in the project configuration. Example:
+
+```json
+  {
+    "input": {
+      "scripts": ["./src/scripts", "./src/extra-scripts"],
+      "include": ["./src/include", "./src/extra-include"],
+      "assets": ["./assets", "./extra-assets"]
+    }
+  }
+```
+
+### Assets filtering and subdirectories
+Using glob filters you can specify which assets should be copied.
+
+For example, you can exclude all assets except `*.mdl`:
+```json
+  {
+    "input": {
+      "assets": [
+        { "dir": "./assets", "filter": "*.mdl" }
+      ]
+    }
+  }
+```
+
+or exclude `*.tga` and `*.wav` files:
+```json
+  {
+    "input": {
+      "assets": [
+        { "dir": "./assets", "filter": "*.!(tga|wav)" }
+      ]
+    }
+  }
+```
+
+You can also specify subdirectories for copying. With this configuration the builder will copy all files from `./assets/models` to `./models/myproject` of the project build directory.
+```json
+  {
+    "input": {
+      "assets": [
+        { "dir": "./assets/models", "dest": "./models/myproject" }
+      ]
+    }
+  }
+```

package/lib/builder/amxxpc.js

@@ -90,9 +90,12 @@ function formatArgs(params, outPath) {
 }
 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);
+    var dest = params.dest.endsWith(".".concat(PLUGIN_EXT))
+        ? params.dest
+        : path_1.default.join(params.dest, "".concat(parsedPath.name, ".").concat(PLUGIN_EXT));
+    var parsedDest = path_1.default.parse(dest);
+    var fileName = path_1.default.parse(dest).base;
+    mkdirp_1.default.sync(parsedDest.dir);
     return new Promise(function (resolve) {
         var output = (0, accumulator_1.default)();
         var done = function (error) {

package/lib/builder/builder.d.ts

@@ -1,21 +1,28 @@
-import { IProjectConfig } from '../types';
+import { IAssetInput, IResolvedProjectConfig } from '../types';
+export interface CompileOptions {
+    ignoreErrors?: boolean;
+    noCache?: boolean;
+}
 export default class AmxxBuilder {
-    private config;
-    constructor(config: IProjectConfig);
-    build(): Promise<void>;
-    watch(): Promise<void>;
-    buildSrc(): Promise<void>;
+    private projectConfig;
+    private pluginCache;
+    constructor(projectConfig: IResolvedProjectConfig);
+    build(compileOptions: CompileOptions): Promise<void>;
+    watch(compileOptions: CompileOptions): Promise<void>;
+    buildScripts(compileOptions: CompileOptions): Promise<boolean>;
     buildInclude(): Promise<void>;
     buildAssets(): Promise<void>;
-    watchSrc(): Promise<void>;
+    watchScripts(compileOptions: CompileOptions): Promise<void>;
     watchInclude(): Promise<void>;
     watchAssets(): Promise<void>;
-    updatePlugin(filePath: string): Promise<void>;
-    updateScript(filePath: string): Promise<void>;
-    updateAsset(filePath: string): Promise<void>;
+    updatePlugin(srcDir: string, srcFile: string, compileOptions: CompileOptions): Promise<boolean>;
+    updateScript(srcDir: string, srcFile: string): Promise<void>;
+    updateAsset(filePath: string, assetInput: IAssetInput): Promise<void>;
     updateInclude(filePath: string): Promise<void>;
     findPlugins(pattern: string): Promise<string[]>;
-    compilePlugin(filePath: string): Promise<void>;
+    compilePlugin(srcDir: string, srcFile: string, compileOptions?: CompileOptions): Promise<void>;
     private buildDir;
     private watchDir;
+    private initPluginCache;
+    private execPathFilter;
 }