Merge pull request #27 from sevensc/updatedeps

Implement methods without using "String".

Author: sevensc

.circleci/config.yml

@@ -3,10 +3,10 @@ version: 2.1
 executors:
   nodejs:
       docker:
-        - image: circleci/node:7.10
+        - image: cimg/node:18.7.0
 
 commands:
-  ceckout-and-restore-cache:
+  checkout-and-restore-cache:
     description: "restore cache"
     steps:
       - checkout
@@ -22,26 +22,37 @@ commands:
             - node_modules
 
 jobs:
+  lint:
+    executor: nodejs
+    steps:
+      - checkout-and-restore-cache
+      - run: yarn install
+      - save-node-modules-cache
+      - run: yarn lint
+
   build:
     executor: nodejs
     steps:
-      - ceckout-and-restore-cache
-      - run: npm install
+      - checkout-and-restore-cache
+      - run: yarn install
       - save-node-modules-cache
-      - run: npm run build
+      - run: yarn build
 
   test:
     executor: nodejs
     steps:
-      - ceckout-and-restore-cache
-      - run: npm install
-      - run: npm run build
-      - run: npm run test
+      - checkout-and-restore-cache
+      - run: yarn install
+      - run: yarn build
+      - run: yarn test
 
 workflows:
   build-and-deploy:
     jobs:
-      - build
+      - lint
+      - build:
+          requires:
+            - lint
       - test:
           requires:
             - build

.eslintignore

@@ -0,0 +1,2 @@
+*.js
+*.d.ts

.eslintrc.json

@@ -0,0 +1,58 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "overrides": [],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": [
+            "off"
+        ],
+        "@typescript-eslint/no-var-requires": [
+            "off"
+        ],
+        "@typescript-eslint/no-inferrable-types": [
+            "off"
+        ],
+        "indent": [
+            "off",
+            "tab"
+        ],
+        "linebreak-style": [
+            "warn",
+            "unix"
+        ],
+        "no-mixed-spaces-and-tabs": [
+            "warn",
+            "smart-tabs"
+        ],
+        "quotes": [
+            "warn",
+            "single",
+            {
+                "allowTemplateLiterals": true
+            }
+        ],
+        "semi": [
+            "warn",
+            "always"
+        ],
+        "comma-dangle": [
+            "warn",
+            "always-multiline"
+        ]
+    }
+}

.gitignore

@@ -1,7 +1,6 @@
 node_modules
 .vscode/*
-
-dist/*.js
+ui
 
 # Compiled source #
 ###################
@@ -12,7 +11,8 @@ dist/*.js
 *.o
 *.so
 *.min.js
-
+*.d.ts.map
+dist
 # Packages #
 ############
 # it's better to unpack these files and commit the raw source
@@ -40,4 +40,4 @@ dist/*.js
 .Spotlight-V100
 .Trashes
 ehthumbs.db
-Thumbs.db
+Thumbs.db

CHANGELOG.md

@@ -8,4 +8,12 @@
 - feature: added `AppendLine` and `AppendLineFormat`
 - feature: added hexadecimal conversion specifier
 - bugfix: `StringBuilder` initialization without parameter adds empty string to internal Values Array.
-- bugfix: When there is no placeholder in the template passed to String.Format it should return the original template
+- bugfix: When there is no placeholder in the template passed to String.format it should return the original template
+
+#### 1.5.0
+- Using latest typescript version, please check if your environment still works with this version before upgrading!
+- feature: !IMPORTANT methods/properties starting with uppercase are marked deprecated now and will be removed in future versions! Check the deprecated infos
+- feature: added class `$String` for everybody who is facing issues when `String` is used.
+- feature: `String.isNullOrWhiteSpace` accepts null or undefined now
+- chore: Updated packages
+- chore: added linting

CONTRIBUTING.md

@@ -1,10 +1,9 @@
-# Readme for developers
+# Contributing
 
 ## Getting Started
 
 1. clone this repo
-1. execute `npm install -g gulp`
-1. execute `npm install`
+1. execute `yarn install (not npm!)`
 1. code!
-1. build using `npm run build`
-1. test using `npm run test`
+1. build using `yarn build`
+1. test using `yarn test`

readme.md renamed to README.md

@@ -1,55 +1,65 @@
 
+[![CircleCI](https://circleci.com/gh/sevensc/typescript-string-operations.svg?style=shield)](https://app.circleci.com/pipelines/github/sevensc/typescript-string-operations)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sevensc_typescript-string-operations&metric=alert_status)](https://sonarcloud.io/dashboard?id=sevensc_typescript-string-operations)
+![npm](https://img.shields.io/npm/v/typescript-string-operations)
+![npm](https://img.shields.io/npm/dw/typescript-string-operations)
+
 
-![CircleCI](https://img.shields.io/circleci/build/github/iwt-svenulrich/typescript-string-operations?logo=circleci&token=9234d9f6803b37ebfcd4887fa2d6d51aa2cf5214)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sevensc_typescript-string-operations&metric=alert_status)](https://sonarcloud.io/dashboard?id=sevensc_typescript-string-operations)![npm](https://img.shields.io/npm/v/typescript-string-operations)![npm](https://img.shields.io/npm/dw/typescript-string-operations)
 # Simple lightweight string operation library for Typescript.
 ## No jQuery required! Unit tested, works with Angular.
 
+
 ```typescript
- import { String, StringBuilder } from 'typescript-string-operations';
+ import { StringBuilder, join, format, isNullOrWhiteSpace } from 'typescript-string-operations';
  ```
+ 
+When migrating from Version 1.4.1 or lower, you can also import the class `String`. Using this String class would override the native `String` object from JavaScript. We will remove this declaration with the next major release
+
+```typescript
+ import { String } from 'typescript-string-operations';
+```
 
 #### USAGE:
 
-### String.Empty
+### String.empty
 ```typescript
-var id = String.Empty;
+var id = emptyString; // or String.empty
+// output: id = '';
 ```
 
-### String.IsNullOrWhiteSpace():
+### String.isNullOrWhiteSpace():
 ```typescript
 var id = image.GetId();
-if(String.IsNullOrWhiteSpace(id))
+if(isNullOrWhiteSpace(id)) // String.isNullOrWhiteSpace(id)
 	return image;
 ```
-### String.Format():
+### String.format():
 
 ```typescript
 var id = image.GetId()
-String.Format("image_{0}.jpg", id)
+formatString("image_{0}.jpg", id) // or String.format()
 output: "image_2db5da20-1c5d-4f1a-8fd4-b41e34c8c5b5.jpg";
 ```
 
 Specifier available!
 ```typescript
-var value = String.Format("{0:L}", "APPLE"); //output "apple"
-
-value = String.Format("{0:U}", "apple"); // output "APPLE"
+var value = formatString("{0:L}", "APPLE"); //output "apple"
 
-value = String.Format("{0:d}", "2017-01-23 00:00"); //output "23.01.2017"
+value = formatString("{0:U}", "apple"); // output "APPLE"
 
+value = formatString("{0:d}", "2017-01-23 00:00"); //output "23.01.2017"
 
-value = String.Format("{0:s}", "21.03.2017 22:15:01") //output "2017-03-21T22:15:01"
+value = formatString("{0:s}", "21.03.2017 22:15:01") //output "2017-03-21T22:15:01"
 
-value = String.Format("{0:n}", 1000000);
+value = formatString("{0:n}", 1000000);
 //output "1.000.000"
 
-value = String.Format("{0:00}", 1);
+value = formatString("{0:00}", 1);
 //output "01"
 ```
 
 ## UPDATE
-#### String Format for Objects including specifiers
+#### String.format for Objects including specifiers
 
 ```typescript
 var fruit = new Fruit();
@@ -58,7 +68,7 @@ fruit.color = "RED";
 fruit.shippingDate = new Date(2018, 1, 1);
 fruit.amount = 10000;
 
-String.Format("the {type:U} is {color:L} shipped on {shippingDate:s} with an amount of {amount:n}", fruit);
+format("the {type:U} is {color:L} shipped on {shippingDate:s} with an amount of {amount:n}", fruit);
 // output: the APPLE is red shipped on 2018-01-01 with an amount of 10.000
 
 ```
@@ -75,33 +85,33 @@ String.Format("the {type:U} is {color:L} shipped on {shippingDate:s} with an amo
 
 
 
-### String.Join():
+### String.join():
 
 ```typescript
-var value = String.Join("; ", "Apple", "Banana");
+var value = joinString("; ", "Apple", "Banana"); // or String.join()
 //output: "Apple; Banana";
 ```
 #### OR
 
 ```typescript
  let object = { Name: "Foo", Value: "Bar" };
- var value = String.Join('.', object);
+ var value = joinString('.', object);
 //output: "Foo.Bar";
 
 var array = ['Apple', 'Banana']
-var value = String.Join("; ", array);
+var value = joinString("; ", array);
 //output: "Apple; Banana";
 ```
 
 ## Methods
 
 | Method                    |  Type       |       Description          | Parameter  |
 | :------------------------:|:-----------:|:--------------------------:|:----------:|
-|  `Empty`                  | `Property`  |    simply returns `""`.    |
-| `IsNullOrWhiteSpace`      | `Method`    | returns true value if given parameter is either null, empty or undefined. | `format`, `args`
-| `Format`                  | `Method`    | Converts the value of objects to strings based on the formats specified and inserts them into another string. | `format`, `args`
-| `Join`                    | `Method`    |   Combines arguments delimited by given seperator.| `delimiter`,`args`
-| `Join`                    | `Method`    |   Combines arguments delimited by given seperator from array. | `delimiter`,`array` |
+|  `empty`                  | `Property`  |    simply returns `""`.    |
+| `isNullOrWhiteSpace`      | `Method`    | returns true value if given parameter is either null, empty or undefined. | `format`, `...args`
+| `format`/`formatString`   | `Method`    | Converts the value of objects to strings based on the formats specified and inserts them into another string. | `format`, `...args`
+| `join`/`joinString`       | `Method`    |   Combines arguments delimited by given seperator.| `delimiter`,`...args`
+| `join`/`joinString`       | `Method`    |   Combines arguments delimited by given seperator from array. | `delimiter`,`array` |
 
 
 ### StringBuilder
@@ -117,7 +127,7 @@ var builder = new StringBuilder("My favorite fruits are: ");
 builder.Append("Apples, ");
 builder.Append("Bananas ");
 
-// of course using String.Format()
+// using String.format() internally
 builder.AppendFormat("and especially {0:U}!", favoriteFruit);
 builder.AppendFormat(" I eat {0} every day!", 10);
 
@@ -131,8 +141,8 @@ var fruits = builder.ToString();
 | Method                    |  Type       |       Description          | Parameter  |
 | :------------------------:|:-----------:|:--------------------------:|:----------:|
 |  `Append`                 | `Method`    |    appends a string.       | `value`    |
-|  `AppendFormat`           | `Method`    |    see description for `String.Format()`| `format`, `args`|
+|  `AppendFormat`           | `Method`    |    see description for `format()`| `format`, `args`|
 |  `AppendLine`             | `Method`    |    appends a string in a new line. | `format`, `args`|
-|  `AppendLineFormat`       | `Method`    |    like `String.Format()` in a new line | `format`, `args`|
+|  `AppendLineFormat`       | `Method`    |    like `format()` in a new line | `format`, `args`|
 |  `Clear`		            | `Method`    |    clears the `StringBuilder`   |       |
 |  `ToString`	            | `Method`    |    creates the actual string.  |       |