Move and improve tests

.gitignore

@@ -3,7 +3,7 @@
 .lock-wscript
 .DS_Store
 .project
-.DS_Store
 node_modules/
 test-addon/build/
+bin-*/
 *.log

doc/README.md

@@ -21,10 +21,8 @@ For **GYP**, the include directory is accessible with:
 ],
 ```
 
-For more examples, see [code snippets here](snippets.md).
 
-
-### Logging
+## Logging
 
 Console logging and "global" logging helpers for C++ side are available:
 
@@ -48,13 +46,6 @@ See JS Utils section in [README](/README.md).
 ```
 
 
-
-### ES5 Classes
-
-Addon Tools provides C++ macro helpers for ES5 Classes (`function`-based).
-See the [class-wrapping doc here](class-wrapping.md).
-
-
 ### Function Helpers
 
 Most of the helpers work within functions, where `Napi::CallbackInfo info` is
@@ -242,3 +233,9 @@ calls `getArrayData` or `getArrayData` on it. Otherwise, if
 `value.data` is a `TypedArray|Buffer`,
 calls `getArrayData` or `getArrayData` on it.
 Returns `nullptr` in other cases.
+
+
+### ES5 Classes
+
+Addon Tools provides C++ macro helpers for ES5 Classes (`function`-based).
+See the [class-wrapping doc here](class-wrapping.md).

doc/class-wrapping.md

@@ -14,7 +14,7 @@ and on C++ side there is `inheritEs5` function.
 
 ## Class Declaration
 
-```
+```cpp
 class ClassName {
 DECLARE_ES5_CLASS(ClassName, JSClassName);
 
@@ -48,7 +48,7 @@ the second is the name of the setter to be created.
 
 ## Class Implementation
 
-```
+```cpp
 IMPLEMENT_ES5_CLASS(ClassName);
 
 // Fill the properties and export the class

index.d.ts

@@ -371,21 +371,40 @@ declare module "addon-tools-raub" {
 	type TGlobalLoggerLevel = keyof TGlobalLoggerMethods;
 
 	type TGlobalLoggerOpts = TGlobalLoggerMethods & Readonly<{
+		/** Globally available name for a new logger */
 		name: string,
 	}>;
 
 	type TGlobalLogger = TGlobalLoggerMethods & Readonly<{
+		/** Replace a logger channel in an existing logger */
 		replace: (level: string, fn: TLoggerFn) => void,
 	}>;
 
 	/**
 	 * Create a named global logger
-	 *
-	 * Copy a folder with all the contained files
+	 * 
+	 * It will be also available from
+	 * `global.AddonTools.log(name, level, arg1, arg2, ...);`
 	 */
 	export const createLogger: (opts: TGlobalLoggerOpts) => TGlobalLogger;
+
+	/**
+	 * Set logger level or `null` to turn off
+	 */
 	export const setLevel: (level: TGlobalLoggerLevel | null) => void;
+
+	/**
+	 * Get logger level
+	 */
 	export const getLevel: () => (TGlobalLoggerLevel | null);
+
+	/**
+	 * Get an object containing all registered loggers
+	 */
 	export const getLoggers: () => Readonly<Record<string, TGlobalLogger>>
+
+	/**
+	 * Get a logger by name, returns null if  not found
+	 */
 	export const getLogger: () => (TGlobalLogger | null)
 }

package.json

@@ -19,14 +19,11 @@
 	],
 	"files": [
 		"include",
-		"utils.js",
-		"utils.d.ts",
 		"index.js",
 		"index.d.ts",
 		"utils",
 		"LICENSE",
-		"package.json",
-		"README.md"
+		"package.json"
 	],
 	"engines": {
 		"node": ">=22.9.0",

tests/download.test.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const assert = require('node:assert').strict;
+const { describe, it } = require('node:test');
+
+const { download } = require('..');
+
+
+const url = 'https://raw.githubusercontent.com/node-3d/image-raub/refs/tags/4.3.0/test/freeimage.jpg';
+
+
+describe('AT / Download', async () => {
+	const data = await download(url);
+
+	it('data is Buffer', () => {
+		assert.strictEqual(data.constructor, Buffer);
+	});
+
+	it('downloaded byte count is correct', async () => {
+		assert.strictEqual(data.length, 7972);
+	});
+});

include.test.js → tests/include.test.js

@@ -3,10 +3,10 @@
 const assert = require('node:assert').strict;
 const { describe, it } = require('node:test');
 
-const tools = require('.');
+const tools = require('..');
 
 
-describe('AT / include', () => {
+describe('AT / Include', () => {
 	const stringMethods = ['getBin', 'getPlatform', 'getInclude'];
 
 	stringMethods.forEach((name) => {

tests/install.test.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const assert = require('node:assert').strict;
+const { describe, it } = require('node:test');
+
+const { install, exists, getBin } = require('..');
+
+
+const prefix = 'https://github.com/node-3d/segfault-raub/releases/download';
+const tag = '2.3.0';
+
+
+describe('AT / Install', async () => {
+	const status = await install(`${prefix}/${tag}`);
+
+	it('status is true', () => {
+		assert.strictEqual(status, true);
+	});
+
+	it('platform folder exists', async () => {
+		const isFolderCreated = await exists(`${__dirname}/../${getBin()}`);
+		assert.strictEqual(isFolderCreated, true);
+	});
+
+	it('platform binary exists', async () => {
+		const isAddonAvailable = await exists(`${__dirname}/../${getBin()}/segfault.node`);
+		assert.strictEqual(isAddonAvailable, true);
+	});
+});

logger.test.js → tests/logger.test.js

@@ -3,7 +3,7 @@
 const assert = require('node:assert').strict;
 const { describe, it } = require('node:test');
 
-const utils = require('.');
+const utils = require('..');
 
 describe('AT / Logger', () => {
 	let logged = '';

utils.test.js → tests/utils.test.js

@@ -3,7 +3,7 @@
 const assert = require('node:assert').strict;
 const { describe, it } = require('node:test');
 
-const utils = require('.');
+const utils = require('..');
 
 
 describe('AT / Util Exports', () => {