Merge pull request #27 from benjGam/develop

Release 2.2.0

Author: benjGam

.github/workflows/cd.yml

@@ -1,8 +1,8 @@
 name: Node.js CD
 
 on:
-  release:
-    types: [created]
+  push:
+    branches: ['main']
 
 jobs:
   publish-npm:

.github/workflows/coverage.yml

@@ -15,3 +15,5 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: ArtiomTr/jest-coverage-report-action@v2
+        with:
+          custom-title: Package coverage

CHANGELOG.md

@@ -1,12 +1,17 @@
-# VERSION 2.1.0
+# Version 2.2.0
+
+- `Added`:
+  - `StringUtilsWord.formatWords(toFormat: string | string[])` apply `StringUtilsWord.formatWord(str)` to a complete sentence or table of words.
+
+# Version 2.1.0
 
 - `Fixes`:
   - `StringUtilsCase.splitByCase()` method doesn't remove spaces anymore while splitting `lowercase` and `uppercase` formed strings.
 - `Added`:
   - `type Case` is now provided to reliably link managed cases.
   - `StringUtilsCase.convertToCase(str: string, caseToConvert: Case)` has been implemented.
 
-# VERSION 2.0.0
+# Version 2.0.0
 
 - Added:
   - Unit testing is now part of this project.

README.md

@@ -14,7 +14,7 @@ This package is a way to help third-party developers but also a way to help myse
 
 (I'm pretty sure that kind of module already exists and are better than mine, but, in any case, it will be usefull to me)
 
-## Features (2.0.0 version)
+## Features (2.1.0 version)
 
 ### StringUtilsWord class
 
@@ -33,7 +33,7 @@ This class is responsible to manage some operations on case of strings, we have
 
 - `determineCase()`: This method could be useful if you want to know the case of a string (i.e: camelCase, snake_case, PascalCase, UPPERCASE, lowercase)
 - `splitByCase()`: This method could be useful if you want to split a string cased as a certain way, but you want each terms separated in a table.
-- `convertToCase()`: This method could be useful if you want to convert a string from a case to another one (Not implement yet)
+- `convertToCase()`: This method could be useful if you want to convert a string from a case to another one.
 
 ### StringUtils class
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "string-utils-ts",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Provide some useful functions for strings",
   "main": "./lib",
   "scripts": {

src/word-ending-utils.ts

@@ -195,4 +195,29 @@ export default class StringUtilsWord {
       .filter((subsequence) => !StringUtils.isBlank(subsequence))
       .join(' ');
   }
+
+  /**
+   * Return a string with each words formated.
+   *
+   * @param {string | string[]} toFormat - The string or table of strings to format
+   *
+   * @example
+   * toFormat: 'Hello this is my example'
+   * returns: 'Hello This Is My Example'
+   *
+   * @example
+   * toFormat: ['Hello', 'this', 'is', 'my', 'example']
+   * returns: 'Hello This Is My Example'
+   */
+  public static formatWords(toFormat: string | string[]): string {
+    if (!Array.isArray(toFormat)) {
+      if (StringUtils.isBlank(toFormat)) return toFormat;
+      toFormat = toFormat.split(' ');
+    }
+    if (StringUtils.isBlank(toFormat.join(''))) return toFormat.join('');
+
+    return toFormat
+      .map((subSequence) => this.formatWord(subSequence))
+      .join(' ');
+  }
 }

test/words.spec.ts

@@ -191,4 +191,18 @@ describe('Normalization of stuffs', () => {
       );
     });
   }
+
+  const formatWordsExpectedReturns = new Map<string | string[], string>([
+    ['This is my test', 'This Is My Test'],
+    [['This', 'is', 'my', 'test'], 'This Is My Test'],
+    [['        ', ''], '        '],
+    ['      ', '      '],
+    [['This ', 'is ', 'my ', 'test'], 'This  Is  My  Test'],
+  ]);
+
+  for (const [key, value] of formatWordsExpectedReturns.entries()) {
+    test(`Should return '${value}' for '${key}'`, () => {
+      expect(StringUtilsWord.formatWords(key)).toEqual(value);
+    });
+  }
 });