feature/NOTASK Initial functionality

Author: kas-elvirov

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -0,0 +1,127 @@
+# regexify-string
+
+The way to decorate string by using regex with: React components, HTML tags etc
+
+> perfectly works with: strings, html tags, react, react-native
+
+
+## Install
+
+```
+$ npm install --save regexify-string
+```
+
+## API
+
+### regexifyString({ pattern, decorator, input })
+
+#### pattern
+
+Type: `RegExp`
+
+#### decorator
+
+Type: `(match: string, index: number) => string | JSX.Element`
+
+- `match` string you would like to replace/decorate with something
+- `index` index number of the current match
+
+**NOTE:** Try do not forget to use keys for React collections if needed
+
+#### input
+
+Type: `string`
+
+## Usage
+
+#### with strings
+
+```js
+    const result = regexifyString({
+        pattern: /\[.*?\]/gim,
+        decorator: (match, index) => {
+            return `<${match}>`;
+        },
+        input: 'some [text] with simple example',
+    });
+
+    console.log(result);
+    // ['some ', '<[text]>', ' with simple example']
+```
+
+#### with index keys
+
+```js
+    const result = regexifyString({
+        pattern: /\[.*?\]/gim,
+        decorator: (match, index) => {
+            switch (index) {
+                case 0: return `<FIRST ${match}>`;
+                case 1: return `<SECOND ${match}>`;
+                case 2: return `<THIRD ${match}>`;
+                default: return match;
+            }
+        },
+        input: 'Important text with [first link] and [second link] and much more [links]',
+    });
+
+    console.log(result);
+    /*
+        [
+            'Important text with ',
+            '<FIRST [first link]>',
+            ' and ',
+            '<SECOND [second link]>',
+            ' and much more ',
+            '<THIRD [links]>',
+        ]
+    */
+```
+
+#### with html
+
+```js
+    const result = regexifyString({
+        pattern: /\[.*?\]/gim,
+        decorator: (match, index) => {
+            return <span>{match}</span>;
+        },
+        input: 'some [text] with simple example',
+    });
+
+    console.log(result);
+    // ['some ', <span>[text]</span>, ' with simple example']
+```
+
+#### with React / React Native components
+
+```js
+    regexifyString({
+        pattern: /\[.*?\]/gim,
+        decorator: (match, index) => {
+            return (
+                <Link
+                    to={SOME_ROUTE}
+                    onClick={onClick}
+                >
+                    {match}
+                </Link>
+            );
+        },
+        input: DisclaimerData.body,
+    });
+```
+
+```js
+    regexifyString({
+        pattern: /\[.*?\]/gim,
+        decorator: (match, index) => {
+            return <React.Fragment>{match}</React.Fragment>;
+        },
+        input: 'some [text] with simple example',
+    });
+```
+
+## License
+
+MIT © [Artem Solovev](http://www.artemsolovev.com/)

index.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export interface IDecorateStringWithReactProps {
+    decorator: (match: string, index: number) => string | JSX.Element;
+    pattern: RegExp;
+    input: string;
+}
+export default function regexifyString(props: IDecorateStringWithReactProps): Array<(string | JSX.Element)>;

index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function regexifyString(props) {
+    var pattern = props.pattern, decorator = props.decorator, input = props.input;
+    var output = [];
+    var matchIndex = 0;
+    var processedInput = input;
+    var result = pattern.exec(processedInput);
+    while (result !== null) {
+        var matchStartAt = result.index;
+        var match = result[0];
+        var contentBeforeMatch = processedInput.substring(0, matchStartAt);
+        var decoratedMatch = decorator(match, matchIndex);
+        output.push(contentBeforeMatch);
+        output.push(decoratedMatch);
+        processedInput = processedInput.substring(matchStartAt + match.length, processedInput.length + 1);
+        pattern.lastIndex = 0;
+        result = pattern.exec(processedInput);
+        ++matchIndex;
+    }
+    if (processedInput) {
+        output.push(processedInput);
+    }
+    return output;
+}
+exports.default = regexifyString;

jest.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+  roots: [
+    '<rootDir>/src'
+  ],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  testRegex: '(/__tests__/.*|(\\.|/)(test))\\.tsx?$',
+  clearMocks: true,
+  moduleFileExtensions: [
+    'ts',
+    'tsx',
+    'js',
+    'jsx',
+    'json',
+    'node'
+  ],
+  moduleNameMapper: {
+    '\~(.*)$': '<rootDir>/src/$1'
+  },
+};

out/regexifyString.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function regexifyString(props) {
+    var pattern = props.pattern, decorator = props.decorator, input = props.input;
+    var output = [];
+    var matchIndex = 0;
+    var processedInput = input;
+    var result = pattern.exec(processedInput);
+    while (result !== null) {
+        var matchStartAt = result.index;
+        var match = result[0];
+        var contentBeforeMatch = processedInput.substring(0, matchStartAt);
+        var decoratedMatch = decorator(match, matchIndex);
+        output.push(contentBeforeMatch);
+        output.push(decoratedMatch);
+        processedInput = processedInput.substring(matchStartAt + match.length, processedInput.length + 1);
+        pattern.lastIndex = 0;
+        result = pattern.exec(processedInput);
+        ++matchIndex;
+    }
+    if (processedInput) {
+        output.push(processedInput);
+    }
+    return output;
+}
+exports.default = regexifyString;