Merge pull request #32 from full-pack/1.0.0-dev

Author: ram-amoncar

README.md

@@ -9,6 +9,7 @@ A lightweight and versatile String Utility Package for Node.js & Browser.
 <img src="https://user-images.githubusercontent.com/6517308/121813242-859a9700-cc6b-11eb-99c0-49e5bb63005b.jpg">
 
 # Contents
+
 * [Install](#install)
 * [require](#require)
 * [import](#import)
@@ -37,14 +38,11 @@ A lightweight and versatile String Utility Package for Node.js & Browser.
   * [isAlpha](#isalpha)
   * [isAlphaNumeric](#isalphanumeric)
   * [reverse](#reverse)
-
-  (Coming Soon)
-  * [StringBuilder](#)
-  * [StringValidator](#)
  * [Build](#build)
  * [License](#license)
 
-## install
+## Install
+
 ```sh
 npm install @full-pack/string-pack
 ```
@@ -61,13 +59,16 @@ const { ... } = require('@full-pack/string-pack');
 import { ... } from '@full-pack/string-pack';
 ```
 
-## API
+## APIs
+
+### Padding
 
-### padding
 Adds padding to given string.
 
 ##### padStart
+
 Pads the start of a string with a specified fill string a certain number of times.
+
 ```js
 // Basic Usage
 padStart('hello', 'abc', 3) // abcabcabchello
@@ -77,7 +78,9 @@ padStart('hello', 'abc', 3, 8) // abchello
 ```
 
 ##### padEnd
+
 Pads the end of a string with a specified fill string a certain number of times.
+
 ```js
 // Basic Usage
 padEnd('hello', 'abc', 3); // helloabcabcabc
@@ -87,20 +90,25 @@ padEnd('hello', 'abc', 3, 8); // helloabc
 ```
 
 ##### padBidirectional
+
 Pads a string with a specified fill string a certain number of times on both ends.
+
 ```js
 // Basic usage
-padBidirectional('hello', '*', 2); // '**hello**'
+padBidirectional('hello', '*', {repeatCount: 2}); // '**hello**'
 
 // Limiting total length
-padBidirectional('world', '-', 3, 10); // '--world---'
+padBidirectional('world', '-', {repeatCount: 3, maxLen: 10}); // '--world---'
 
 // Controlling padding distribution
-padBidirectional('example', '*', 2, 10, 0); // '**example*'
+padBidirectional('example', '*', {repeatCount: 2, maxLen: 10, bias: PaddingBias.START}); 
+// '**example*'
 ```
 
 ### merge
+
 Merges an array of strings into a single string using a specified separator.
+
 ```js
 merge('-', 'apple', 'orange', 'banana'); // 'apple-orange-banana'
 
@@ -110,31 +118,39 @@ merge(false, 'apple', 'orange', 'banana'); // 'appleorangebanana'
 ```
 
 ### compare
+
 Performs a strict comparison between two strings.
+
 ```js
 compare("hello", "hello"); // true
 
 compare("abc", "ABC"); // false
 ```
 
 ### looseCompare
+
 Performs a case-insensitive loose comparison between two strings.
+
 ```js
 looseCompare("hello", "HELLO"); // true
 
 looseCompare('abc', '123'); // false
 ```
 
 ### capitalizeInitial
+
 Capitalizes the first letter of a word in a string.
+
 ```js
 capitalizeInitial('hello'); // 'Hello'
 
 capitalizeInitial(':> hello');  // ':> Hello'
 ```
 
 ### capitalizeWords
+
 Capitalizes the first letter of each word in a given string.
+
 ```js
 capitalizeWords('hello world'); // 'Hello World'
 
@@ -144,31 +160,39 @@ capitalizeWords('Sphinx of black quartz:-judge my vow'); // 'Sphinx Of Black Qua
 ### Case Conversion
 
 #### snakeCase
+
 Converts a string to snake_case format.
+
 ```js
 snakeCase('hello WorLd'); // 'hello_world'
 snakeCase('from-kebab-case'); // 'from_kebab_case'
 snakeCase('snake Case With Numbers123', true); // 'snake_case_with_numbers_one_two_three'
 ```
 
 #### kebabCase
+
 Converts a string to kebab-case format.
+
 ```js
 kebabCase('h3llo WoRld'); // 'h3llo-world'
 kebabCase('from_snake_case'); // 'from-snake-case'
 kebabCase('kebab Case With Numbers123', true); // 'kebab-case-with-numbers-one-two-three'
 ```
 
 #### camelCase
+
 Converts a string to camelCase format.
+
 ```js
 camelCase('hello WoRld'); // 'helloWorld'
 camelCase('Test CaSe ExamplE'); // 'testCaseExample'
 camelCase('camel Case With Numbers123'); // 'camelCaseWithNumbers'
 ```
 
 #### pascalCase
+
 Converts a string to PascalCase format.
+
 ```js
 pascalCase('hello WoRld'); // 'HelloWorld'
 pascalCase('Test CaSe ExamplE'); // 'TestCaseExample'
@@ -178,7 +202,9 @@ pascalCase('pasCal Case With Numbers123'); // 'PascalCaseWithNumbers'
 ### Case Validation
 
 #### isSnakeCase
+
 Checks if a string is in snake_case format.
+
 ```js
 // Valid
 isSnakeCase('snake_case_example'); // true
@@ -195,7 +221,9 @@ isSnakeCase('no_CAPS'); // false
 ```
 
 #### isKebabCase
+
 Checks if a string is in kebab-case format.
+
 ```js
 // Valid
 isKebabCase('kebab-case-example'); // true
@@ -212,7 +240,9 @@ isKebabCase('no-CAPS'); // false
 ```
 
 #### isCamelCase
+
 Checks if a string is in camelCase format.
+
 ```js
 // Valid
 isCamelCase('camelCaseExample'); // true
@@ -225,7 +255,9 @@ isCamelCase('withThe1234'); // false
 ```
 
 #### isPascalCase
+
 Checks if a string is in PascalCase format.
+
 ```js
 // Valid
 isPascalCase('PascalCaseExample'); // true
@@ -238,7 +270,9 @@ isPascalCase('WithThe1234'); // false
 ```
 
 ### regionMatch
+
 Compares two strings or regions for equality.
+
 ```js
 // Matching identical strings
 regionMatch('hello', 'hello'); // true
@@ -255,7 +289,9 @@ regionMatch('hello world', 'hello there', 6, 11); // false
 ```
 
 ### looseRegionMatch
+
 Performs a loose comparison of two strings or regions for equality.
+
 ```js
 // Loose matching identical strings
 looseRegionMatch('hello', 'HeLLo'); // true
@@ -267,29 +303,39 @@ looseRegionMatch(str1, str2); // true
 ```
 
 ### isAlpha
+
 Checks if a string contains only alphabetic characters (A-Z, a-z).
+
 ```js
 isAlpha("HelloWorld"); // true
 isAlpha("Hello123"); // false
 ```
 
 ### isAlphaNumeric
+
 Checks if a string contains only alphanumeric characters (A-Z, a-z, 0-9).
+
 ```js
 isAlphaNumeric("Hello01"); // true
 isAlphaNumeric("1234567890"); // false
 ```
 
 ### Reverse
+
 Reverses the sequence of characters in given string.
+
 ```js
 reverse('bad') // 'dab'
 ```
 
+Full documentation [here](https://full-pack.github.io/string-pack)
+
 ## Build
+
 ```
 npm run build
 ```
 
 ## License
+
 The MIT License. Full License is [here](LICENSE)

eslint.config.js

@@ -1,13 +1,15 @@
 'use strict'
 
+import { defineConfig, globalIgnores } from 'eslint/config'
 import stylistic from '@stylistic/eslint-plugin'
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
 import jest from 'eslint-plugin-jest'
 import love from 'eslint-config-love'
 
-export default [
+export default defineConfig([
+    globalIgnores(['dist/', '**/*.js']),
     {
-        ignores: ['dist', '**/*.js']
+        files: ['**/*.ts']
     },
     // Stylistic
     {
@@ -39,9 +41,16 @@ export default [
     // Custom
     {
         rules: {
-            '@typescript-eslint/no-magic-numbers': 'off',
-            'jest/consistent-test-it': ['error', { fn: 'test' }]
+            'jest/consistent-test-it': ['error', { fn: 'test' }],
+            'max-nested-callbacks': 'off',
+            'max-lines': 'off'
         },
         files: ['tests/**.test.ts']
+    },
+    {
+        files: ['**/*.ts'],
+        rules: {
+            '@typescript-eslint/no-magic-numbers': 'off'
+        }
     }
-]
+])