[minor] add optional options input to collapseWhiteSpace

electrovir · Feb 1, 2024 · 9d231b1 · 9d231b1
1 parent 04e48c9
commit 9d231b1
Show file tree

Hide file tree

Showing 14 changed files with 101 additions and 87 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "augment-vir",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {

diff --git a/packages/browser-testing/package.json b/packages/browser-testing/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/browser-testing",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,8 +23,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^23.1.1",
-        "@augment-vir/testing": "^23.1.1",
+        "@augment-vir/common": "^23.2.0",
+        "@augment-vir/testing": "^23.2.0",
         "@open-wc/testing": "^4.0.0",
         "@types/mocha": "^10.0.6",
         "@web/test-runner-commands": "^0.9.0",

diff --git a/packages/browser/package.json b/packages/browser/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/browser",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/browser",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,12 +24,12 @@
         "test:watch": "web-test-runner --color --config configs/web-test-runner.config.mjs --watch"
     },
     "dependencies": {
-        "@augment-vir/common": "^23.1.1",
+        "@augment-vir/common": "^23.2.0",
         "html-spec-tags": "^1.0.3",
         "run-time-assertions": "^0.3.0"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^23.1.1",
+        "@augment-vir/browser-testing": "^23.2.0",
         "@open-wc/testing": "^4.0.0",
         "@types/chai": "^4.3.11",
         "@types/mocha": "^10.0.6",

diff --git a/packages/chai/package.json b/packages/chai/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/chai",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -23,8 +23,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^23.1.1",
-        "@augment-vir/testing": "^23.1.1",
+        "@augment-vir/common": "^23.2.0",
+        "@augment-vir/testing": "^23.2.0",
         "type-fest": "^4.9.0"
     },
     "devDependencies": {

diff --git a/packages/common-tests/package.json b/packages/common-tests/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common-tests",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "private": true,
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common-tests",
     "bugs": {
@@ -22,9 +22,9 @@
         "test:types": "tsc --noEmit"
     },
     "devDependencies": {
-        "@augment-vir/chai": "^23.1.1",
-        "@augment-vir/common": "^23.1.1",
-        "@augment-vir/node-js": "^23.1.1",
+        "@augment-vir/chai": "^23.2.0",
+        "@augment-vir/common": "^23.2.0",
+        "@augment-vir/node-js": "^23.2.0",
         "@electrovir/nyc": "^15.1.0-fix0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
         "@types/chai": "^4.3.11",

diff --git a/packages/common-tests/src/tests/common-string.test.ts b/packages/common-tests/src/tests/common-string.test.ts
@@ -93,26 +93,38 @@ describe(joinWithFinalConjunction.name, () => {
 });
 
 describe(collapseWhiteSpace.name, () => {
-    it(`check simple space collapsing`, () => {
-        expect(collapseWhiteSpace('hello           there')).to.equal('hello there');
-    });
-
-    it(`multiple space collapsing`, () => {
-        expect(
-            collapseWhiteSpace(
-                'hello           there          you        are a bold           one',
-            ),
-        ).to.equal('hello there you are a bold one');
-    });
-
-    it(`beginning and ending space is trimmed as well`, () => {
-        expect(collapseWhiteSpace('     hello   there     ')).to.equal('hello there');
-    });
-
-    it('should trim inner newlines', () => {
-        expect(collapseWhiteSpace('hello\n\nthere')).to.equal('hello there');
-        expect(collapseWhiteSpace('hello\n\nthere\n\nstuff')).to.equal('hello there stuff');
-    });
+    itCases(collapseWhiteSpace, [
+        {
+            it: 'works with single repeating spaces',
+            inputs: ['hello           there'],
+            expect: 'hello there',
+        },
+        {
+            it: 'works with multiple repeating spaces',
+            inputs: ['hello           there          you        are a bold           one'],
+            expect: 'hello there you are a bold one',
+        },
+        {
+            it: 'also trims',
+            inputs: ['     hello   there     '],
+            expect: 'hello there',
+        },
+        {
+            it: 'collapses newlines by default',
+            inputs: ['   \n  hello \n  there   \n\n  '],
+            expect: 'hello there',
+        },
+        {
+            it: 'can preserve newlines',
+            inputs: [
+                '   \n  hello \n  there   \n\n  ',
+                {
+                    keepNewLines: true,
+                },
+            ],
+            expect: 'hello\nthere',
+        },
+    ]);
 });
 
 describe(removeCommasFromNumberString.name, () => {

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"

diff --git a/packages/common/src/augments/common-string.ts b/packages/common/src/augments/common-string.ts
@@ -42,14 +42,16 @@ export function removeCommasFromNumberString(numberString: string): string {
 }
 
 /** Collapse all consecutive white space into just one space and trim surrounding whitespace. */
-export function collapseWhiteSpace(input: string): string {
-    return (
-        input
-            // sometimes \n isn't included in \s
-            .replace(/\n/g, ' ')
-            .trim()
-            .replace(/\s{2,}/g, ' ')
-    );
+export function collapseWhiteSpace(
+    input: string,
+    {keepNewLines}: PartialAndUndefined<{keepNewLines: boolean}> = {},
+): string {
+    const newLineReplacement = keepNewLines
+        ? input.replace(/[\s\n]*\n+[\s\n]*/g, '\n')
+        : // sometimes \n isn't included in \s
+          input.replace(/\n/g, ' ');
+
+    return newLineReplacement.trim().replace(/\s{2,}/g, ' ');
 }
 
 /** Same as String.prototype.split but includes the delimiter to split by in the output array. */

diff --git a/packages/docker/package.json b/packages/docker/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/docker",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/docker",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -22,8 +22,8 @@
         "test:coverage": "npm test"
     },
     "dependencies": {
-        "@augment-vir/common": "^23.1.1",
-        "@augment-vir/node-js": "^23.1.1"
+        "@augment-vir/common": "^23.2.0",
+        "@augment-vir/node-js": "^23.2.0"
     },
     "devDependencies": {
         "typescript": "5.3.3"

diff --git a/packages/node-js/package.json b/packages/node-js/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/node-js",
-    "version": "23.1.1",
+    "version": "23.2.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/node-js",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -22,7 +22,7 @@
         "test:coverage": "npm test coverage"
     },
     "dependencies": {
-        "@augment-vir/common": "^23.1.1",
+        "@augment-vir/common": "^23.2.0",
         "ansi-colors": "^4.1.3",
         "axios": "^1.6.5",
         "fs-extra": "^11.2.0",
@@ -31,7 +31,7 @@
         "type-fest": "^4.9.0"
     },
     "devDependencies": {
-        "@augment-vir/chai": "^23.1.1",
+        "@augment-vir/chai": "^23.2.0",
         "@electrovir/nyc": "^15.1.0-fix0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
         "@types/chai": "^4.3.11",