simple-file-templater 1.0.1 → 1.0.3

package/.gitignore

@@ -0,0 +1,38 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+tmp/
+cache/
+
+# dependencies
+node_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+*.launch
+.settings/
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage/*
+/libpeerconnection.log
+npm-debug.log
+testem.log
+/typings
+tests/env.json
+env.json
+
+# e2e
+/e2e/*.js
+/e2e/*.map
+
+#System Files
+.DS_Store
+Thumbs.db
+
+#visual studio history
+/.history

package/dist/templater.d.ts

@@ -0,0 +1,34 @@
+/** Get the content of a folder and move it with option to replace in files or in fileNames as you go */
+export declare function templater(
+/** absolute url of template (it can be a folder) */
+from: string, 
+/** absolute url of folder/file to be copied (it can be a folder) */
+to: string, 
+/** list of variables to interpolates
+ * * {myVar : myReplacement}
+ * * OR [[/myRegExp/g, 'myString'], ['myString1', 'myString2']...]
+ * * DON'T forget the g flag when using regexps
+*/
+replaceInFiles?: any[], 
+/** same as above but for fileNames (only valid when copying folders) */
+replaceInFileNames?: any[], 
+/** regexp array to check against path. Eg: /node_module/ <= file paths that includes the word node_module will not be taken in account */
+ignorePaths?: any[]): string[];
+/** Inject content into a file at specified place */
+export declare function injector(
+/** url of the file where the content will be injected */
+filePath: string, data: string, 
+/** Number == lineNumber || RegExp == will replace the first matching group || String == will place content after the string
+ * NOTE: don't forget **the g flag** for regexp if you want to match all occurences
+ */
+after: number | string | RegExp): boolean;
+/** Turns a file content into a list of lines */
+export declare function fileToLines(
+/** absolute path of file */
+filePath: string, 
+/** get only lines from the first matching group */
+regexp: any, 
+/** still count as a line;  avoid conflicting with regexp, for ex if regexp match all inside \(.*\), and a comment with "// 1] blah" is found is in the middle */
+ignoreInlineComments?: boolean, 
+/** Will trime each line */
+trim?: boolean): [lineNumber: number, content: string][];

package/dist/templater.js

@@ -0,0 +1,154 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fileToLines = exports.injector = exports.templater = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const fast_glob_1 = __importDefault(require("fast-glob"));
+/** Get the content of a folder and move it with option to replace in files or in fileNames as you go */
+function templater(
+/** absolute url of template (it can be a folder) */
+from, 
+/** absolute url of folder/file to be copied (it can be a folder) */
+to, 
+/** list of variables to interpolates
+ * * {myVar : myReplacement}
+ * * OR [[/myRegExp/g, 'myString'], ['myString1', 'myString2']...]
+ * * DON'T forget the g flag when using regexps
+*/
+replaceInFiles = [], 
+/** same as above but for fileNames (only valid when copying folders) */
+replaceInFileNames = [], 
+/** regexp array to check against path. Eg: /node_module/ <= file paths that includes the word node_module will not be taken in account */
+ignorePaths = []) {
+    try {
+        err500IfNotSet({ from, to, varz: replaceInFiles });
+        // convert all replacement data to array [ [regExpToReplace, replacer], ... ]
+        if (isObject(replaceInFiles))
+            replaceInFiles = Object.entries(replaceInFiles);
+        replaceInFiles.forEach(([toReplace, replacer], i, arr) => toReplace instanceof RegExp || (arr[i] = [new RegExp(toReplace, 'g'), replacer]));
+        if (isObject(replaceInFileNames))
+            replaceInFileNames = Object.entries(replaceInFileNames);
+        replaceInFileNames.forEach(([toReplace, replacer], i, arr) => toReplace instanceof RegExp || (arr[i] = [new RegExp(toReplace, 'g'), replacer]));
+        const createdPath = [];
+        let files = [from];
+        const templateIsDirectory = fs_extra_1.default.statSync(from).isDirectory();
+        // get directory structure
+        if (templateIsDirectory) {
+            if (fs_extra_1.default.existsSync(to) && !fs_extra_1.default.statSync(to).isDirectory())
+                throw '"from" argument is a directory but "to" arg is a file';
+            files = fast_glob_1.default.sync(`${from}/**/*`, { dot: true });
+        }
+        else if (fs_extra_1.default.existsSync(to) && fs_extra_1.default.statSync(to).isDirectory())
+            throw '"to" argument is a directory but "from" arg is a file';
+        for (const fileFullPath of files) {
+            if (ignorePaths.some(reg => reg.test(fileFullPath)))
+                continue;
+            let newFileFullPath = to;
+            if (templateIsDirectory) {
+                const [, filePath, fileName] = fileFullPath.match(/(.*)\/(.*)$/) || [];
+                const newFilePath = filePath.replace(from, to);
+                const newFileName = replaceInFileNames.reduce((str, [toReplace, replacer]) => str.replace(toReplace, replacer), fileName);
+                newFileFullPath = path_1.default.join(newFilePath, newFileName);
+            }
+            const oldFileContent = fs_extra_1.default.readFileSync(fileFullPath, 'utf-8');
+            const newFileContent = replaceInFiles.reduce((str, [toReplace, replacer]) => str.replace(toReplace, replacer), oldFileContent);
+            fs_extra_1.default.outputFileSync(newFileFullPath, newFileContent);
+            createdPath.push(newFileFullPath);
+        }
+        return createdPath;
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+exports.templater = templater;
+/** Inject content into a file at specified place */
+function injector(
+/** url of the file where the content will be injected */
+filePath, data, 
+/** Number == lineNumber || RegExp == will replace the first matching group || String == will place content after the string
+ * NOTE: don't forget **the g flag** for regexp if you want to match all occurences
+ */
+after) {
+    try {
+        err500IfNotSet({ filePath, data, after });
+        if (!fs_extra_1.default.existsSync(filePath))
+            throw 'file for injection do not exist';
+        const fileContent = fs_extra_1.default.readFileSync(filePath, 'utf-8');
+        let newFileContent;
+        if (after instanceof RegExp) {
+            newFileContent = fileContent.replace(after, (f, m1) => f.replace(m1, data));
+        }
+        else if (typeof after === 'number') {
+            newFileContent = fileContent.split('\n');
+            newFileContent.splice(after, 0, data);
+            newFileContent = newFileContent.join('\n');
+        }
+        else if (typeof after === 'string') {
+            newFileContent = fileContent.split(after).join(after + data);
+        }
+        else
+            throw 'Wrong type for after argument';
+        fs_extra_1.default.writeFileSync(filePath, newFileContent);
+        return true;
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+exports.injector = injector;
+/** Turns a file content into a list of lines */
+function fileToLines(
+/** absolute path of file */
+filePath, 
+/** get only lines from the first matching group */
+regexp, 
+/** still count as a line;  avoid conflicting with regexp, for ex if regexp match all inside \(.*\), and a comment with "// 1] blah" is found is in the middle */
+ignoreInlineComments = true, 
+/** Will trime each line */
+trim = true) {
+    try {
+        err500IfNotSet({ filePath });
+        if (!fs_extra_1.default.existsSync(filePath))
+            throw 'file for injection do not exist';
+        let fileContent = fs_extra_1.default.readFileSync(filePath, 'utf-8');
+        if (ignoreInlineComments)
+            fileContent = fileContent.replace(/\/\/.*/g, '<$COMMENT$>');
+        let lines, lineBegin = 0;
+        if (isset(regexp) && regexp instanceof RegExp) {
+            fileContent.replace(regexp, (f, m1, index, chain) => {
+                const linesBefore = chain.substring(0, index).split('\n');
+                lineBegin = linesBefore.length;
+                lines = m1.split('\n');
+            });
+            if (!isset(lines))
+                throw `regexp doesn't match the subject string`;
+        }
+        else {
+            lines = fileContent.split('\n');
+        }
+        if (lines[0] === '')
+            lines[0] = 'First line';
+        return lines
+            .map((lineContent, i) => [lineBegin + i, trim ? lineContent.trim() : lineContent])
+            .filter(([, content]) => content && !content.includes('<$COMMENT$>'));
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+exports.fileToLines = fileToLines;
+function isset(...elms) {
+    return elms.every(elm => typeof elm !== 'undefined' && elm !== null);
+}
+function isObject(obj) { return isset(obj) && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype; }
+function err500IfNotSet(objectWithVarDescription) {
+    Object.entries(objectWithVarDescription).forEach(([name, value], i) => {
+        if (!isset(value))
+            throw new Error(`Param number ${i} (${name}) is not set in templater function.`);
+    });
+}
+//# sourceMappingURL=templater.js.map

package/dist/templater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templater.js","sourceRoot":"","sources":["../templater.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAyB;AACzB,gDAAuB;AACvB,0DAA0B;AAG1B,wGAAwG;AACxG,SAAgB,SAAS;AACrB,oDAAoD;AACpD,IAAY;AACZ,oEAAoE;AACpE,EAAU;AACV;;;;EAIE;AACF,cAAc,GAAG,EAAE;AACnB,wEAAwE;AACxE,kBAAkB,GAAG,EAAE;AACvB,0IAA0I;AAC1I,WAAW,GAAG,EAAE;IAEhB,IAAI,CAAC;QACD,cAAc,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAA;QAElD,6EAA6E;QAC7E,IAAI,QAAQ,CAAC,cAAc,CAAC;YAAE,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC9E,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,YAAY,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC5I,IAAI,QAAQ,CAAC,kBAAkB,CAAC;YAAE,kBAAkB,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC1F,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,YAAY,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QAEhJ,MAAM,WAAW,GAAG,EAAc,CAAA;QAElC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAA;QAClB,MAAM,mBAAmB,GAAG,kBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5D,0BAA0B;QAC1B,IAAI,mBAAmB,EAAE,CAAC;YACtB,IAAI,kBAAE,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE;gBAAE,MAAM,uDAAuD,CAAC;YACvH,KAAK,GAAG,mBAAE,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,CAAC;aAAM,IAAI,kBAAE,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,kBAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE;YAAE,MAAM,uDAAuD,CAAC;QAE7H,KAAK,MAAM,YAAY,IAAI,KAAK,EAAE,CAAC;YAC/B,IAAI,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAAE,SAAS;YAC9D,IAAI,eAAe,GAAG,EAAE,CAAC;YACzB,IAAI,mBAAmB,EAAE,CAAC;gBACtB,MAAM,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBACvE,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC/C,MAAM,WAAW,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC1H,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM,cAAc,GAAG,kBAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC9D,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,cAAc,CAAC,CAAC;YAE/H,kBAAE,CAAC,cAAc,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;YAEnD,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACtC,CAAC;QAED,OAAO,WAAW,CAAA;IACtB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAAC,CAAC;AACzC,CAAC;AAtDD,8BAsDC;AAED,oDAAoD;AACpD,SAAgB,QAAQ;AACpB,yDAAyD;AACzD,QAAgB,EAChB,IAAY;AACZ;;GAEG;AACH,KAA+B;IAE/B,IAAI,CAAC;QACD,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,kBAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,MAAM,iCAAiC,CAAC;QAEtE,MAAM,WAAW,GAAG,kBAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAEvD,IAAI,cAAc,CAAC;QACnB,IAAI,KAAK,YAAY,MAAM,EAAE,CAAC;YAC1B,cAAc,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;QAChF,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACnC,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACzC,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;YACtC,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACnC,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;QACjE,CAAC;;YAAM,MAAM,+BAA+B,CAAC;QAE7C,kBAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAE3C,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAAC,CAAC;AACzC,CAAC;AA9BD,4BA8BC;AAED,gDAAgD;AAChD,SAAgB,WAAW;AACvB,4BAA4B;AAC5B,QAAgB;AAChB,mDAAmD;AACnD,MAAM;AACN,iKAAiK;AACjK,oBAAoB,GAAG,IAAI;AAC3B,2BAA2B;AAC3B,IAAI,GAAG,IAAI;IAEX,IAAI,CAAC;QACD,cAAc,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,kBAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,MAAM,iCAAiC,CAAC;QAEtE,IAAI,WAAW,GAAG,kBAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,oBAAoB;YAAE,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAEtF,IAAI,KAAK,EAAE,SAAS,GAAG,CAAC,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;YAC5C,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBAChD,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC1D,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC;gBAC/B,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;gBAAE,MAAM,yCAAyC,CAAC;QACvE,CAAC;aAAM,CAAC;YACJ,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;YAAE,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;QAE7C,OAAO,KAAK;aACP,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;aACjF,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IAC9E,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAAC,CAAC;AACzC,CAAC;AAlCD,kCAkCC;AAGD,SAAS,KAAK,CAAC,GAAG,IAAI;IAClB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC;AACzE,CAAC;AACD,SAAS,QAAQ,CAAC,GAAG,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;AAE3H,SAAS,cAAc,CAAC,wBAAwB;IAC5C,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE;QAClE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,IAAI,qCAAqC,CAAC,CAAA;IACvG,CAAC,CAAC,CAAA;AACN,CAAC"}

package/package.json

@@ -1,30 +1,39 @@
 {
     "name": "simple-file-templater",
-    "version": "1.0.1",
+    "version": "1.0.3",
     "description": "Simple templating system for file. Pattern replacer, file name replacer...",
-    "main": "templater.js",
+    "main": "./dist/templater.js",
     "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1",
-        "bump:major": "node node_modules/@cawita/bump-simple/bump-simple.js --major",
-        "bump:minor": "node node_modules/@cawita/bump-simple/bump-simple.js --minor",
-        "bump:patch": "node node_modules/@cawita/bump-simple/bump-simple.js --patch"
+        "build": "tsc",
+        "bump:major": "node node_modules/bump-simple/bump-simple.js --major",
+        "bump:minor": "node node_modules/bump-simple/bump-simple.js --minor",
+        "bump:patch": "node node_modules/bump-simple/bump-simple.js --patch"
     },
     "author": "538ROMEO",
     "license": "ISC",
     "repository": {
         "type": "git",
-        "url": "git+https://gitlab.com/cawita-technologies/modules/templater.git"
+        "url": "git+https://github.com/top-kat/simple-file-templater.git"
     },
     "bugs": {
-        "url": "https://gitlab.com/cawita-technologies/modules/templater/issues"
+        "url": "https://github.com/top-kat/simple-file-templater/issues"
     },
-    "homepage": "https://gitlab.com/cawita-technologies/modules/templater#readme",
+    "homepage": "https://github.com/top-kat/simple-file-templater",
     "dependencies": {
-        "topkat-utils": "^1.0.64",
         "fast-glob": "^3.0.4",
         "fs-extra": "^8.1.0"
     },
     "devDependencies": {
+        "@types/node": "^22.10.1",
         "bump-simple": "^1.0.0"
-    }
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "*.ts",
+        "model-types/*.ts",
+        "constants/*.ts",
+        "*"
+    ]
 }

package/{templater.js → templater.ts}

@@ -1,25 +1,25 @@
-const fs = require('fs-extra');
-const path = require('path');
-const fg = require('fast-glob');
-
-module.exports = {
-    templater,
-    injector,
-    fileToLines,
-};
-
-/**
- * @param {String} from absolute url of template (it can be a folder)
- * @param {String} to absolute url of folder/file to be copied (it can be a folder)
- * @param {Object|Array} replaceInFiles list of variables to interpolates
- * * {myVar : myReplacement}
- * * OR [[/myRegExp/g, 'myString'], ['myString1', 'myString2']...]
- * * DON'T forget the g flag when using regexps
- * @param {Object|Array} replaceInFileNames same as above but for fileNames (only valid when copying folders)
- * @param {RegExp[]} ignorePaths regexp array to check against path. Eg: /node_module/ <= file paths that includes the word node_module will not be taken in account
- * @return {Array} createdPaths
- */
-function templater(from, to, replaceInFiles = [], replaceInFileNames = [], ignorePaths = []) {
+import fs from 'fs-extra'
+import path from 'path'
+import fg from 'fast-glob'
+
+
+/** Get the content of a folder and move it with option to replace in files or in fileNames as you go */
+export function templater(
+    /** absolute url of template (it can be a folder) */
+    from: string,
+    /** absolute url of folder/file to be copied (it can be a folder) */
+    to: string,
+    /** list of variables to interpolates
+     * * {myVar : myReplacement}
+     * * OR [[/myRegExp/g, 'myString'], ['myString1', 'myString2']...]
+     * * DON'T forget the g flag when using regexps 
+    */
+    replaceInFiles = [],
+    /** same as above but for fileNames (only valid when copying folders) */
+    replaceInFileNames = [],
+    /** regexp array to check against path. Eg: /node_module/ <= file paths that includes the word node_module will not be taken in account */
+    ignorePaths = []
+) {
     try {
         err500IfNotSet({ from, to, varz: replaceInFiles })
 
@@ -29,8 +29,9 @@ function templater(from, to, replaceInFiles = [], replaceInFileNames = [], ignor
         if (isObject(replaceInFileNames)) replaceInFileNames = Object.entries(replaceInFileNames);
         replaceInFileNames.forEach(([toReplace, replacer], i, arr) => toReplace instanceof RegExp || (arr[i] = [new RegExp(toReplace, 'g'), replacer]));
 
-        const createdPath = [];
-        let files = [from];
+        const createdPath = [] as string[]
+
+        let files = [from]
         const templateIsDirectory = fs.statSync(from).isDirectory();
         // get directory structure
         if (templateIsDirectory) {
@@ -55,17 +56,20 @@ function templater(from, to, replaceInFiles = [], replaceInFileNames = [], ignor
             createdPath.push(newFileFullPath);
         }
 
-        return createdPath;
+        return createdPath
     } catch (err) { console.error(err); }
 }
 
-/** Inject content into a file at specified place
- * @param {String} filePath url of the file where the content will be injected
- * @param {String} data
- * @param {Number|RegExp|String} after Number == lineNumber || RegExp == will replace the first matching group || String == will place content after the string
- * NOTE: don't forget **the g flag** for regexp if you want to match all occurences
- */
-function injector(filePath, data, after) {
+/** Inject content into a file at specified place */
+export function injector(
+    /** url of the file where the content will be injected */
+    filePath: string,
+    data: string,
+    /** Number == lineNumber || RegExp == will replace the first matching group || String == will place content after the string
+     * NOTE: don't forget **the g flag** for regexp if you want to match all occurences
+     */
+    after: number | string | RegExp
+) {
     try {
         err500IfNotSet({ filePath, data, after });
         if (!fs.existsSync(filePath)) throw 'file for injection do not exist';
@@ -89,13 +93,17 @@ function injector(filePath, data, after) {
     } catch (err) { console.error(err); }
 }
 
-/** Turns a file content into a list of lines
- * @param {String} filePath absolute path of file
- * @param {RegExp} regexp get only lines from the first matching group
- * @param {Boolean} ignoreInlineComments still count as a line;  avoid conflicting with regexp, for ex if regexp match all inside \(.*\), and a comment with "// 1] blah" is found is in the middle
- * @return {array[]} [ [2, 'lineContentString' ], [3, 'line2']... ]   lineNumber, content
- */
-function fileToLines(filePath, regexp, ignoreInlineComments = true, trim = true) {
+/** Turns a file content into a list of lines */
+export function fileToLines(
+    /** absolute path of file */
+    filePath: string,
+    /** get only lines from the first matching group */
+    regexp,
+    /** still count as a line;  avoid conflicting with regexp, for ex if regexp match all inside \(.*\), and a comment with "// 1] blah" is found is in the middle */
+    ignoreInlineComments = true,
+    /** Will trime each line */
+    trim = true
+): [lineNumber: number, content: string][] {
     try {
         err500IfNotSet({ filePath });
         if (!fs.existsSync(filePath)) throw 'file for injection do not exist';

package/tsconfig.json

@@ -0,0 +1,32 @@
+{
+    "compilerOptions": {
+        "target": "ES2021",
+        "module": "CommonJS",
+        "lib": [
+            "es2021"
+        ],
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "allowJs": false,
+        "skipLibCheck": true,
+        "resolveJsonModule": true,
+        "noImplicitAny": false,
+        "noImplicitThis": true,
+        "declaration": true,
+        "moduleResolution": "node",
+        "sourceMap": true,
+        "outDir": "dist",
+        // "baseUrl": "./",
+        "paths": {
+            "*": [
+                "./node_modules/*"
+            ],
+            "src/*": [
+                "./src/*"
+            ]
+        },
+        "types": [
+            "node"
+        ]
+    },
+}