pareto-core-dev 0.11.0

package/dist/get_location_info.d.ts

@@ -0,0 +1,13 @@
+export type Source_Location = {
+    'file': string;
+    'line': number;
+    'column': number;
+};
+/**
+ * provides the source location (filepath and line number) of the source code file where this function is called,
+ * or if the depth is bigger than 0, the source location of the function at that stack depth
+ * @param depth
+ * @returns
+ */
+export declare function get_location_info(depth: number): Source_Location;
+export declare function location_to_string(location: Source_Location): string;

package/dist/get_location_info.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get_location_info = get_location_info;
+exports.location_to_string = location_to_string;
+/**
+ * provides the source location (filepath and line number) of the source code file where this function is called,
+ * or if the depth is bigger than 0, the source location of the function at that stack depth
+ * @param depth
+ * @returns
+ */
+function get_location_info(depth) {
+    //we create an error, not to be thrown but to be disected for its stack
+    const e = new Error(); //don't move this statement to another function, it will change the depth of its stack
+    function get_line(e, depth) {
+        if (e.stack === undefined) {
+            throw new Error(`NO STACK INFO`);
+        }
+        const line = e.stack.split("\n")[depth + 2]; //get the right line from the stack (the first two lines are "Error" and this function call)
+        const regex = /\((.*)\)$/; //matches the content inside parentheses at the end of a line (the file path with line and column)
+        const match = regex.exec(line);
+        if (match !== null) {
+            //we have a match
+            return match[1];
+        }
+        const begin = "    at /";
+        if (line.startsWith(begin)) {
+            return line.substring(begin.length - 1);
+        }
+        throw new Error(`COULD NOT PARSE STACK LINE: ${line}`);
+    }
+    const line = get_line(e, depth);
+    const split = line.split(":");
+    if (split.length !== 3) {
+        throw new Error(`UNEXPECTED LOCATION FORMAT (CHECK THE DEPTH PARAMETER): ${line} (Expected 'file:line:column')`);
+    }
+    return {
+        'file': split[0],
+        'line': Number(split[1]),
+        'column': Number(split[2]),
+    };
+}
+function location_to_string(location) {
+    return `${location.file}:${location.line}:${location.column}`;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./public/implement_me";
+export * from "./public/log_debug_message";

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./public/implement_me"), exports);
+__exportStar(require("./public/log_debug_message"), exports);

package/dist/public/implement_me.d.ts

@@ -0,0 +1,8 @@
+/**
+ * use this function as a placeholder when you want to compile but have not fully developed all functionality yet.
+ *
+ * this function should only be called from code that is in the development phase,
+ * before publishing, the usages should be removed
+ * @param message the string to be printed to stderr
+ */
+export declare function implement_me(marker: string): never;

package/dist/public/implement_me.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.implement_me = implement_me;
+const get_location_info_1 = require("../get_location_info");
+/**
+ * use this function as a placeholder when you want to compile but have not fully developed all functionality yet.
+ *
+ * this function should only be called from code that is in the development phase,
+ * before publishing, the usages should be removed
+ * @param message the string to be printed to stderr
+ */
+function implement_me(marker) {
+    throw new Error(`IMPLEMENT ME ${marker ? `: '${marker}'` : ''}@ ${(0, get_location_info_1.location_to_string)((0, get_location_info_1.get_location_info)(1))}`);
+}

package/dist/public/log_debug_message.d.ts

@@ -0,0 +1,7 @@
+/**
+ * logs a debug message
+ * this function should only be called from code that is in the development phase,
+ * before publishing, the usages should be removed
+ * @param message the string to be printed to stdout
+ */
+export declare function log_debug_message<T>(message: string, handler: () => T): T;

package/dist/public/log_debug_message.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log_debug_message = log_debug_message;
+/**
+ * logs a debug message
+ * this function should only be called from code that is in the development phase,
+ * before publishing, the usages should be removed
+ * @param message the string to be printed to stdout
+ */
+function log_debug_message(message, handler) {
+    console.log("DEBUG", message);
+    return handler();
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "pareto-core-dev",
+  "version": "0.11.0",
+  "license": "ISC",
+  "description": "a pareto package that contains functions that are useful during development",
+  "author": "Corno",
+  "keywords": [
+    "pareto",
+    "development",
+    "log_debug_message",
+    "implement_me"
+  ],
+  "homepage": "https://github.com/corno/pareto-core-dev#readme",
+  "bugs": {
+    "url": "https://github.com/corno/pareto-core-dev/issues"
+  },
+  "main": "./dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/corno/pareto-core-dev.git"
+  },
+  "dependencies": {}
+}