Update dependencies (#15)

* Update dependencies * Improve DX * Install Prettier and update files formatting * Remove unnecessary ESLint plugins * Remove unnecessary comments from `tsconfig.json` * Change `master` branch to `main` in documentation * Update library version
vasilii-kovalev · Dec 5, 2020 · baf6fd1 · baf6fd1
1 parent e0bcce0
commit baf6fd1
Show file tree

Hide file tree

Showing 14 changed files with 1,967 additions and 5,253 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,9 +1,9 @@
-# version: 1.0.0
-
 root = true
 
 [*]
+end_of_line = lf
 insert_final_newline = true
-charset = utf-8
 indent_style = space
 indent_size = 2
+max_line_length = 80
+trim_trailing_whitespace = true
diff --git a/.eslintrc b/.eslintrc
@@ -1,26 +1,5 @@
 {
-  // "version": "1.1.0",
-  "plugins": [
-    "@typescript-eslint"
-  ],
-  "extends": [
-    "eslint-config-airbnb-base"
-  ],
   "rules": {
-    "arrow-parens": [
-      "error",
-      "as-needed"
-    ],
-    "indent": "off",
-    "linebreak-style": "off",
-    "max-len": [
-      "error",
-      {
-        "code": 80,
-        "ignoreComments": true
-      }
-    ],
-    "no-unused-vars": "off",
     "sort-imports": [
       "error",
       {
@@ -29,55 +8,6 @@
         "ignoreMemberSort": false
       }
     ],
-    "@typescript-eslint/indent": [
-      "error",
-      2
-    ],
-    "@typescript-eslint/no-unused-vars": [
-      "error"
-    ],
-    "import/order": [
-      "error",
-      {
-        "groups": [
-          "builtin",
-          "external",
-          "internal",
-          "parent",
-          "sibling",
-          "index"
-        ],
-        "pathGroups": [
-          {
-            "pattern": "src/**",
-            "group": "internal",
-            "position": "after"
-          }
-        ],
-        "pathGroupsExcludedImportTypes": [
-          "builtin"
-        ],
-        "newlines-between": "always",
-        "alphabetize": {
-          "order": "asc",
-          "caseInsensitive": false
-        }
-      }
-    ],
-    "import/extensions": [
-      "error",
-      {
-        "ts": "never"
-      }
-    ],
-    "import/no-extraneous-dependencies": [
-      "error",
-      {
-        "devDependencies": [
-          "webpack.config.ts"
-        ]
-      }
-    ],
     "import/prefer-default-export": "off"
   },
   "parser": "@typescript-eslint/parser",
@@ -90,9 +20,7 @@
   "settings": {
     "import/resolver": {
       "node": {
-        "extensions": [
-          ".ts"
-        ]
+        "extensions": [".ts"]
       }
     }
   }

diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,8 @@
+# Artifacts:
+.next
+build
+dist
+coverage
+
+# GitHub Workflow
+.github
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,14 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": false,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "avoid",
+  "endOfLine": "lf"
+}
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # hydrate-text
+
 Tiny library for dynamic text hydrating with variables
 
 [![Version][version-badge]][package-link]
@@ -23,47 +24,36 @@ Tiny library for dynamic text hydrating with variables
 
 [version-badge]: https://flat.badgen.net/npm/v/hydrate-text
 [package-link]: https://www.npmjs.com/package/hydrate-text
-
 [downloads-badge]: https://flat.badgen.net/npm/dt/hydrate-text?color=blue
 [downloads-link]: https://npmcharts.com/compare/hydrate-text?interval=30
-
 [depend-badge]: https://flat.badgen.net/npm/dependents/hydrate-text
 [depend-link]: https://www.npmjs.com/browse/depended/hydrate-text
-
 [license-badge]: https://flat.badgen.net/github/license/vasilii-kovalev/hydrate-text
-[license-link]: https://github.com/vasilii-kovalev/hydrate-text/blob/master/LICENSE
-
+[license-link]: https://github.com/vasilii-kovalev/hydrate-text/blob/main/LICENSE
 [release-badge]: https://flat.badgen.net/github/release/vasilii-kovalev/hydrate-text
 [releases-link]: https://github.com/vasilii-kovalev/hydrate-text/releases
-
 [build-badge]: https://flat.badgen.net/github/status/vasilii-kovalev/hydrate-text
-[builds-link]: https://github.com/vasilii-kovalev/hydrate-text/actions?query=workflow%3Abuild-test+branch%3Amaster
-
-[min-size-badge]: https://flat.badgen.net/bundlephobia/min/hydrate-text@1.2.6
-[minzip-size-badge]: https://flat.badgen.net/bundlephobia/minzip/hydrate-text@1.2.6
-[size-link]: https://bundlephobia.com/result?p=hydrate-text@1.2.6
-
+[builds-link]: https://github.com/vasilii-kovalev/hydrate-text/actions?query=workflow%3Abuild-test+branch%3Amain
+[min-size-badge]: https://flat.badgen.net/bundlephobia/min/hydrate-text@1.2.7
+[minzip-size-badge]: https://flat.badgen.net/bundlephobia/minzip/hydrate-text@1.2.7
+[size-link]: https://bundlephobia.com/result?p=hydrate-text@1.2.7
 [dependencies-badge]: https://flat.badgen.net/david/dep/vasilii-kovalev/hydrate-text
 [dependencies-link]: https://david-dm.org/vasilii-kovalev/hydrate-text
 [dev-dependencies-badge]: https://flat.badgen.net/david/dev/vasilii-kovalev/hydrate-text
 [dev-dependencies-link]: https://david-dm.org/vasilii-kovalev/hydrate-text?type=dev
-
 [types-badge]: https://flat.badgen.net/npm/types/hydrate-text
-[types-link]: https://github.com/vasilii-kovalev/hydrate-text/blob/master/src/index.ts#L3-L24
-
+[types-link]: https://github.com/vasilii-kovalev/hydrate-text/blob/main/src/index.ts#L3-L24
 [maintainability-badge]: https://flat.badgen.net/codeclimate/maintainability/vasilii-kovalev/hydrate-text
 [maintainability-link]: https://codeclimate.com/github/vasilii-kovalev/hydrate-text/maintainability
-
 [coverage-badge]: https://flat.badgen.net/coveralls/c/github/vasilii-kovalev/hydrate-text
 [coverage-link]: https://coveralls.io/github/vasilii-kovalev/hydrate-text
-
 [vulnerabilities-badge]: https://flat.badgen.net/snyk/vasilii-kovalev/hydrate-text
 [vulnerabilities-link]: https://snyk.io/test/github/vasilii-kovalev/hydrate-text
-
 [jsdelivr-hits-per-month-badge]: https://data.jsdelivr.com/v1/package/npm/hydrate-text/badge
-[jsdelivr-hits-per-month-link]: https://www.jsdelivr.com/package/npm/hydrate-text?version=1.2.6
+[jsdelivr-hits-per-month-link]: https://www.jsdelivr.com/package/npm/hydrate-text?version=1.2.7
 
 ## Example
+
 ```typescript
 import { hydrateText } from 'hydrate-text';
 
@@ -83,6 +73,7 @@ console.log(hydrateText(route, { userId: 1 }, { start: ':' }));
 
 Initial variables syntax can be configured via `configureHydrateText`, that
 returns `hydrateText` function as a result.
+
 ```typescript
 import { configureHydrateText } from 'hydrate-text';
 
@@ -106,26 +97,31 @@ replaceRouteVariables(
 ```
 
 ## Features
-* Light-weight
-* Dependency-free
-* Tree-shakable
-* Works with variables as an object and an array
-* Flexible variable syntax change
-* ES Module, CommonJS and UMD options are available
-* Strongly typed with TypeScript
+
+- Light-weight
+- Dependency-free
+- Tree-shakable
+- Works with variables as an object and an array
+- Flexible variable syntax change
+- ES Module, CommonJS and UMD options are available
+- Strongly typed with TypeScript
 
 ## Installation
+
 ### npm
+
 ```shell
 npm install hydrate-text
 ```
 
 ### Yarn
+
 ```shell
 yarn add hydrate-text
 ```
 
 ### CDN
+
 <table>
   <thead>
     <tr>
@@ -137,12 +133,12 @@ yarn add hydrate-text
     <tr>
       <td rowspan=2>
         <img
-          src="https://flat.badgen.net/badgesize/normal/https/unpkg.com/hydrate-text@1.2.6/dist/umd/index.js?label=Uncompressed"
+          src="https://flat.badgen.net/badgesize/normal/https/unpkg.com/hydrate-text@1.2.7/dist/umd/index.js?label=Uncompressed"
           alt="Uncompressed package bundle size"
         >
       </td>
       <td>
-        <a href="https://unpkg.com/hydrate-text@1.2.6/dist/umd/index.js">
+        <a href="https://unpkg.com/hydrate-text@1.2.7/dist/umd/index.js">
           <img
             src="https://flat.badgen.net/badge/%20%20%20/UNPKG/green"
             alt="Link to uncompressed UMD package on UNPKG"
@@ -152,7 +148,7 @@ yarn add hydrate-text
     </tr>
     <tr>
       <td>
-        <a href="https://cdn.jsdelivr.net/npm/hydrate-text@1.2.6/dist/umd/index.js">
+        <a href="https://cdn.jsdelivr.net/npm/hydrate-text@1.2.7/dist/umd/index.js">
           <img
             src="https://flat.badgen.net/badge/icon/jsdelivr?icon=jsdelivr&label&color=green"
             alt="Link to uncompressed UMD package on jsDelivr"
@@ -163,12 +159,12 @@ yarn add hydrate-text
     <tr>
       <td rowspan=2>
         <img
-          src="https://flat.badgen.net/badgesize/normal/https/unpkg.com/hydrate-text@1.2.6/dist/umd/index.min.js?label=Minified"
+          src="https://flat.badgen.net/badgesize/normal/https/unpkg.com/hydrate-text@1.2.7/dist/umd/index.min.js?label=Minified"
           alt="Minified package bundle size"
         >
       </td>
       <td>
-        <a href="https://unpkg.com/hydrate-text@1.2.6/dist/umd/index.min.js">
+        <a href="https://unpkg.com/hydrate-text@1.2.7/dist/umd/index.min.js">
           <img
             src="https://flat.badgen.net/badge/%20%20%20/UNPKG/green"
             alt="Link to minified UMD package on UNPKG"
@@ -178,7 +174,7 @@ yarn add hydrate-text
     </tr>
     <tr>
       <td>
-        <a href="https://cdn.jsdelivr.net/npm/hydrate-text@1.2.6/dist/umd/index.min.js">
+        <a href="https://cdn.jsdelivr.net/npm/hydrate-text@1.2.7/dist/umd/index.min.js">
           <img
             src="https://flat.badgen.net/badge/icon/jsdelivr?icon=jsdelivr&label&color=green"
             alt="Link to minified UMD package on jsDelivr"
@@ -189,7 +185,6 @@ yarn add hydrate-text
   </tbody>
 </table>
 
-
 ```html
 <script src="link-to-library.js"></script>
 <script>