refactor: Migrate to typescript (#106)

* refactor: migrate codebase to TypeScript * refactor: migrate codebase to TypeScript * chore: update version for release
yobacca · Nov 13, 2022 · 838a982 · 838a982
1 parent 6aaaf2e
commit 838a982
Show file tree

Hide file tree

Showing 145 changed files with 6,350 additions and 15,036 deletions.
diff --git a/.browserlistrc b/.browserlistrc
@@ -1,4 +1,3 @@
-ie >= 11
 last 1 Edge version
 last 1 Firefox version
 last 1 Chrome version

diff --git a/.changeset/README.md b/.changeset/README.md
@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.2.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}
diff --git a/.editorconfig b/.editorconfig
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,2 @@
-flow-typed/**/*.js
 dist/
-lib/
 docs/
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,43 +1,75 @@
 {
-  "parser": "babel-eslint",
-  "extends": ["airbnb-base", "prettier"],
-  "plugins": ["flowtype"],
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/typescript"
+  ],
+  "plugins": ["import"],
+  "settings": {
+    "node": {
+      "tryExtensions": [".json", ".node", ".ts"]
+    }
+  },
   "rules": {
-    "no-plusplus": ["error", { "allowForLoopAfterthoughts": true }],
-    "arrow-parens": 0,
-    "flowtype/boolean-style": [2, "boolean"],
-    "flowtype/define-flow-type": 1,
-    "flowtype/no-dupe-keys": 2,
-    "flowtype/object-type-delimiter": 2,
-    "flowtype/require-valid-file-annotation": [
-      2,
-      "always",
-      { "annotationStyle": "line" }
+    "import/order": [
+      1,
+      {
+        "groups": [
+          ["builtin", "external"],
+          "internal",
+          ["sibling", "parent", "index"]
+        ],
+        "newlines-between": "always",
+        "alphabetize": {
+          "order": "asc",
+          "caseInsensitive": true
+        }
+      }
     ],
-    "flowtype/space-before-type-colon": [2, "never"],
-    "flowtype/space-after-type-colon": [2, "always"],
-    "flowtype/union-intersection-spacing": [2, "always"],
-    "import/no-extraneous-dependencies": 0,
-    "no-control-regex": 0,
-    "no-confusing-arrow": 0,
-    "no-duplicate-imports": 0,
-    "no-else-return": 0,
-    "no-param-reassign": ["error", { "props": false }],
-    "no-prototype-builtins": 0,
-    "no-restricted-syntax": 0,
-    "no-unused-vars": [2, { "varsIgnorePattern": "^_+$" }],
-    "symbol-description": 0
-  },
-  "env": {
-    "browser": true,
-    "jest": true,
-    "node": true
+    "@typescript-eslint/consistent-type-assertions": [
+      "warn",
+      {
+        "assertionStyle": "never"
+      }
+    ],
+    "@typescript-eslint/explicit-function-return-type": [
+      "error",
+      {
+        "allowExpressions": true,
+        "allowTypedFunctionExpressions": true,
+        "allowHigherOrderFunctions": true
+      }
+    ],
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        "args": "after-used",
+        "ignoreRestSiblings": true,
+        "argsIgnorePattern": "^_"
+      }
+    ],
+    "@typescript-eslint/consistent-type-imports": [
+      "warn",
+      { "prefer": "type-imports" }
+    ],
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      {
+        "ignores": ["dynamicImport", "modules"]
+      }
+    ],
+    "node/no-missing-import": ["off"],
+    "no-unused-vars": "off"
   },
-  "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module",
-    "ecmaFeatures": {
-      "impliedStrict": true
+  "overrides": [
+    {
+      "files": ["**/__tests__/**"],
+      "plugins": ["jest"],
+      "extends": ["plugin:jest/recommended"]
     }
-  }
+  ]
 }
diff --git a/.flowconfig b/.flowconfig
diff --git a/.gitignore b/.gitignore
@@ -12,9 +12,7 @@ coverage/
 .DS_Store
 
 # generated files
-iife/
-cjs/
-esm/
+dist/
 
 # logs
 npm-debug.log*

diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn lint-staged
diff --git a/.prettierrc b/.prettierrc
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,7 @@
+# natural-orderby
+
+## 3.0.0
+
+### Major Changes
+
+- Migrate codebase to TypeScript
diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ In addition to the efficient and fast `orderBy()` method `natural-orderby` also
 - [Getting Started](#getting-started)
 - [Usage](#usage)
 - [API Reference](#api-reference)
-- [Flow Type Definitions](#flow-type-definitions)
+- [TypeScript Declarations](#typescript-declarations)
 - [Credits](#credits)
 - [License](#license)
 
@@ -137,18 +137,18 @@ It also avoids the high overhead caused by [`Array.prototype.sort()`](https://de
 #### Syntax
 
 <!-- prettier-ignore -->
-```javascript
+```typescript
 orderBy<T>(
-  collection: Array<T>,
-  identifiers?: ?Array<Identifier<T>> | ?Identifier<T>,
-  orders?: ?Array<Order> | ?Order
+  collection: ReadonlyArray<T>,
+  identifiers?: ReadonlyArray<Identifier<T>> | Identifier<T> | null,
+  orders?: ReadonlyArray<Order> | Order | null
 ): Array<T>
 ```
 
-| Type            | Value                                                                            |
-| :-------------- | :------------------------------------------------------------------------------- |
-| `Identifier<T>` | <code>string &#124; (value: T) => mixed)</code>                                  |
-| `Order`         | <code>'asc' &#124; 'desc' &#124; (valueA: mixed, valueB: mixed) => number</code> |
+| Type            | Value                                                                                |
+| :-------------- | :----------------------------------------------------------------------------------- |
+| `Identifier<T>` | <code>string &#124; number &#124; (value: T) => unknown</code>                       |
+| `Order`         | <code>'asc' &#124; 'desc' &#124; (valueA: unknown, valueB: unknown) => number</code> |
 
 #### Description
 
@@ -337,10 +337,10 @@ Creates a compare function that defines the natural sort order and which may be
 compare(options?: CompareOptions): CompareFn
 ```
 
-| Type             | Value                                                 |
-| :--------------- | :---------------------------------------------------- |
-| `CompareOptions` | <code>{ order?: 'asc' &#124; 'desc' }</code>          |
-| `CompareFn`      | <code>(valueA: mixed, valueB: mixed) => number</code> |
+| Type             | Value                                                     |
+| :--------------- | :-------------------------------------------------------- |
+| `CompareOptions` | <code>{ order?: 'asc' &#124; 'desc' }</code>              |
+| `CompareFn`      | <code>(valueA: unknown, valueB: unknown) => number</code> |
 
 #### Description
 
@@ -517,13 +517,9 @@ users.sort((a, b) => compare()(a.lastLogin.ip, b.lastLogin.ip));
 //    ]
 ```
 
-## Flow Type Definitions
-
-`natural-orderby` has first-class [Flow](https://flow.org/) support with zero configuration to assist you in finding type errors while using our modules.
-
 ## TypeScript Declarations
 
-`natural-orderby` has also [TypeScript](https://www.typescriptlang.org/) support and provides TypeScript declarations.
+`natural-orderby` is completely written in [TypeScript](https://www.typescriptlang.org/) and provides TypeScript declarations.
 
 ## Credits
 
@@ -533,4 +529,4 @@ Inspired by [The Alphanum Algorithm](http://www.davekoelle.com/alphanum.html) fr
 
 Licensed under the MIT License, Copyright © 2018 - present Olaf Ennen.
 
-See [LICENSE](./LICENSE) for more information.
+See [LICENSE](./LICENSE.md) for more information.
diff --git a/babel.config.js b/babel.config.js
diff --git a/.commitlintrc.js → commitlint.config.js b/.commitlintrc.js → commitlint.config.js
@@ -1,4 +1,4 @@
-module.exports = {
+const configuration = {
   extends: ['@commitlint/config-conventional'],
   rules: {
     'type-enum': [
@@ -8,3 +8,5 @@ module.exports = {
     ],
   },
 };
+
+module.exports = configuration;
diff --git a/docs/LICENSE.md b/docs/LICENSE.md
@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 - present Olaf Ennen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/docs/README.md b/docs/README.md
@@ -11,6 +11,15 @@ People sort strings containing numbers differently than most sorting algorithms,
 
 In addition to the efficient and fast `orderBy()` method `natural-orderby` also provides the method `compare()`, which may be passed to [`Array.prototype.sort()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort).
 
+## Contents
+
+- [Getting Started](#getting-started)
+- [Usage](#usage)
+- [API Reference](#api-reference)
+- [TypeScript Declarations](#typescript-declarations)
+- [Credits](#credits)
+- [License](#license)
+
 ---
 
 ## Getting Started
@@ -74,7 +83,7 @@ const users = [
   },
 ];
 
-orderBy(
+const sortedUsers = orderBy(
   users,
   [v => v.datetime, v => v.ip],
   ['desc', 'asc']
@@ -128,18 +137,18 @@ It also avoids the high overhead caused by [`Array.prototype.sort()`](https://de
 #### Syntax
 
 <!-- prettier-ignore -->
-```javascript
+```typescript
 orderBy<T>(
-  collection: Array<T>,
-  identifiers?: ?Array<Identifier<T>> | ?Identifier<T>,
-  orders?: ?Array<Order> | ?Order
+  collection: ReadonlyArray<T>,
+  identifiers?: ReadonlyArray<Identifier<T>> | Identifier<T> | null,
+  orders?: ReadonlyArray<Order> | Order | null
 ): Array<T>
 ```
 
-| Type            | Value                                                                            |
-| :-------------- | :------------------------------------------------------------------------------- |
-| `Identifier<T>` | <code>string &#124; (value: T) => mixed)</code>                                  |
-| `Order`         | <code>'asc' &#124; 'desc' &#124; (valueA: mixed, valueB: mixed) => number</code> |
+| Type            | Value                                                                                |
+| :-------------- | :----------------------------------------------------------------------------------- |
+| `Identifier<T>` | <code>string &#124; number &#124; (value: T) => unknown</code>                       |
+| `Order`         | <code>'asc' &#124; 'desc' &#124; (valueA: unknown, valueB: unknown) => number</code> |
 
 #### Description
 
@@ -328,10 +337,10 @@ Creates a compare function that defines the natural sort order and which may be
 compare(options?: CompareOptions): CompareFn
 ```
 
-| Type             | Value                                                 |
-| :--------------- | :---------------------------------------------------- |
-| `CompareOptions` | <code>{ order?: 'asc' &#124; 'desc' }</code>          |
-| `CompareFn`      | <code>(valueA: mixed, valueB: mixed) => number</code> |
+| Type             | Value                                                     |
+| :--------------- | :-------------------------------------------------------- |
+| `CompareOptions` | <code>{ order?: 'asc' &#124; 'desc' }</code>              |
+| `CompareFn`      | <code>(valueA: unknown, valueB: unknown) => number</code> |
 
 #### Description
 
@@ -507,3 +516,17 @@ users.sort((a, b) => compare()(a.lastLogin.ip, b.lastLogin.ip));
 //      },
 //    ]
 ```
+
+## TypeScript Declarations
+
+`natural-orderby` is completely written in [TypeScript](https://www.typescriptlang.org/) and provides TypeScript declarations.
+
+## Credits
+
+Inspired by [The Alphanum Algorithm](http://www.davekoelle.com/alphanum.html) from Dave Koelle.
+
+## License
+
+Licensed under the MIT License, Copyright © 2018 - present Olaf Ennen.
+
+See [LICENSE](./LICENSE.md) for more information.