spacetrim - npm Package Compare versions

Comparing version 0.6.2 to 0.7.0

dist/esm/spaceTrim.js

@@ -28,7 +28,7 @@ /*! *****************************************************************************
 
-function topTrim(str) {
+function topTrim(content) {
     var e_1, _a;
     var linesWithContent = [];
     var contentStarted = false;
-    var lines = str.split('\n');
+    var lines = content.split('\n');
     try {
@@ -55,20 +55,27 @@ for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
 
-function verticalTrim(str) {
-    str = topTrim(str);
-    str = topTrim(str.split('\n').reverse().join('\n'))
+function verticalTrim(content) {
+    content = topTrim(content);
+    content = topTrim(content.split('\n').reverse().join('\n'))
         .split('\n')
         .reverse()
         .join('\n');
-    return str;
+    return content;
 }
 
-function spaceTrim(str /* TODO: , char: RegExp = /\s/*/) {
+function spaceTrim(content) {
+    var isFunctional = false;
+    if (typeof content === 'function') {
+        isFunctional = true;
+        content = content(function (blockContent) {
+            return blockContent.split('\n').join('__NEWLINE__');
+        });
+    }
     // ✂️ Trimming from top and bottom
-    str = verticalTrim(str);
+    content = verticalTrim(content);
     // ✂️ Trimming from left and right
-    var lines = str.split('\n');
+    var lines = content.split('\n');
     var lineStats = lines
         .filter(function (line) { return line.trim() !== ''; })
         .map(function (line) {
-        var contentStart = line.length - line.trimLeft().length;
+        var contentStart = line.length - line.trimStart().length;
         var contentEnd = contentStart + line.trim().length;
@@ -93,9 +100,23 @@ return { contentStart: contentStart, contentEnd: contentEnd };
     }), minContentStart = _a.minContentStart, maxContentEnd = _a.maxContentEnd;
-    str = lines
-        .map(function (line) { return line.substring(minContentStart, maxContentEnd); })
-        .join('\n');
-    return str;
+    var linesHorizontalyTrimmed = lines.map(function (line) {
+        return line.substring(minContentStart, maxContentEnd);
+    });
+    if (isFunctional) {
+        linesHorizontalyTrimmed = linesHorizontalyTrimmed.map(function (line) {
+            var sublines = line.split('__NEWLINE__');
+            var firstSubine = sublines[0];
+            var contentStart = firstSubine.length - firstSubine.trimStart().length;
+            var indentation = ' '.repeat(contentStart);
+            return sublines
+                .map(function (subline) { return "" + indentation + subline.trimStart(); })
+                .join('\n');
+        });
+    }
+    return linesHorizontalyTrimmed.join('\n');
 }
+/**
+ *  TODO: Allow to change split char , char: RegExp = /\s/
+ */
 
 export { spaceTrim as default, spaceTrim };
 //# sourceMappingURL=spaceTrim.js.map

dist/esm/typings/spaceTrim.d.ts

 export default spaceTrim;
-export declare function spaceTrim(str: string): string;
+export declare function spaceTrim(content: string | ((block: (blockContent: string) => string) => string)): string;
+/**
+ *  TODO: Allow to change split char , char: RegExp = /\s/
+ */

dist/esm/typings/topTrim.d.ts

@@ -1,1 +0,1 @@
-export declare function topTrim(str: string): string;
+export declare function topTrim(content: string): string;

dist/esm/typings/verticalTrim.d.ts

@@ -1,1 +0,1 @@
-export declare function verticalTrim(str: string): string;
+export declare function verticalTrim(content: string): string;

dist/umd/spaceTrim.js

@@ -34,7 +34,7 @@ (function (global, factory) {
 
-    function topTrim(str) {
+    function topTrim(content) {
         var e_1, _a;
         var linesWithContent = [];
         var contentStarted = false;
-        var lines = str.split('\n');
+        var lines = content.split('\n');
         try {
@@ -61,20 +61,27 @@ for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
 
-    function verticalTrim(str) {
-        str = topTrim(str);
-        str = topTrim(str.split('\n').reverse().join('\n'))
+    function verticalTrim(content) {
+        content = topTrim(content);
+        content = topTrim(content.split('\n').reverse().join('\n'))
             .split('\n')
             .reverse()
             .join('\n');
-        return str;
+        return content;
     }
 
-    function spaceTrim(str /* TODO: , char: RegExp = /\s/*/) {
+    function spaceTrim(content) {
+        var isFunctional = false;
+        if (typeof content === 'function') {
+            isFunctional = true;
+            content = content(function (blockContent) {
+                return blockContent.split('\n').join('__NEWLINE__');
+            });
+        }
         // ✂️ Trimming from top and bottom
-        str = verticalTrim(str);
+        content = verticalTrim(content);
         // ✂️ Trimming from left and right
-        var lines = str.split('\n');
+        var lines = content.split('\n');
         var lineStats = lines
             .filter(function (line) { return line.trim() !== ''; })
             .map(function (line) {
-            var contentStart = line.length - line.trimLeft().length;
+            var contentStart = line.length - line.trimStart().length;
             var contentEnd = contentStart + line.trim().length;
@@ -99,7 +106,21 @@ return { contentStart: contentStart, contentEnd: contentEnd };
         }), minContentStart = _a.minContentStart, maxContentEnd = _a.maxContentEnd;
-        str = lines
-            .map(function (line) { return line.substring(minContentStart, maxContentEnd); })
-            .join('\n');
-        return str;
+        var linesHorizontalyTrimmed = lines.map(function (line) {
+            return line.substring(minContentStart, maxContentEnd);
+        });
+        if (isFunctional) {
+            linesHorizontalyTrimmed = linesHorizontalyTrimmed.map(function (line) {
+                var sublines = line.split('__NEWLINE__');
+                var firstSubine = sublines[0];
+                var contentStart = firstSubine.length - firstSubine.trimStart().length;
+                var indentation = ' '.repeat(contentStart);
+                return sublines
+                    .map(function (subline) { return "" + indentation + subline.trimStart(); })
+                    .join('\n');
+            });
+        }
+        return linesHorizontalyTrimmed.join('\n');
     }
+    /**
+     *  TODO: Allow to change split char , char: RegExp = /\s/
+     */
 
@@ -106,0 +127,0 @@ exports["default"] = spaceTrim;

dist/umd/typings/spaceTrim.d.ts

 export default spaceTrim;
-export declare function spaceTrim(str: string): string;
+export declare function spaceTrim(content: string | ((block: (blockContent: string) => string) => string)): string;
+/**
+ *  TODO: Allow to change split char , char: RegExp = /\s/
+ */

dist/umd/typings/topTrim.d.ts

@@ -1,1 +0,1 @@
-export declare function topTrim(str: string): string;
+export declare function topTrim(content: string): string;

dist/umd/typings/verticalTrim.d.ts

@@ -1,1 +0,1 @@
-export declare function verticalTrim(str: string): string;
+export declare function verticalTrim(content: string): string;

package.json

 {
     "name": "spacetrim",
-    "version": "0.6.2",
+    "version": "0.7.0",
     "description": "Trimming string from all 4 sides",
@@ -5,0 +5,0 @@ "sideEffects": false,

README.md

 # ✂️ Space trim
 
-[![Package Quality](https://packagequality.com/badge/spacetrim.png)](https://packagequality.com/#?package=spacetrim)
+[![Package Quality](https://packagequality.com/shield/spacetrim.svg)](https://packagequality.com/#?package=spacetrim)
 [![NPM Version](https://badge.fury.io/js/spacetrim.svg)](https://www.npmjs.com/package/spacetrim)
@@ -47,1 +47,35 @@ [![Test](https://github.com/hejny/spacetrim/actions/workflows/test.yml/badge.svg)](https://github.com/hejny/spacetrim/actions/workflows/test.yml)
 ```
+
+_See more examples in [simple spaceTrim tests](./src/spaceTrim.test.ts)._
+
+## Nesting
+
+This is very usefull when you want to trim multiline strings inside multiline strings.
+
+```typescript
+import { spaceTrim } from 'spacetrim';
+
+const trimmed = spaceTrim(
+    (block) => `
+
+                  Numbers
+                    ${block(['1', '2', '3'].join('\n'))}
+                  Chars
+                       ${block(['A', 'B', 'C'].join('\n'))}
+
+`,
+);
+
+console.log(trimmed);
+
+/*Numbers
+  1
+  2
+  3
+Chars
+     A
+     B
+     C*/
+```
+
+_See more examples in [nesting tests](./src/nesting.test.ts)._

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47411

increased by9.44%

Number of package files

26

increased by8.33%

Lines of code

303

increased by19.76%

Number of lines in readme file

81

increased by72.34%

No dependency changes