refactor: migrate library to TypeScript (#40)

* Initial work

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Better match pattern

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Starting to figure things out

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Update docs

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Create prepublish script

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Better import/export

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

* Fix tests

Signed-off-by: Josh-Cena <sidachen2003@gmail.com>

.eslintignore

@@ -0,0 +1 @@
+dist

.eslintrc

@@ -1,6 +1,26 @@
 {
-  "extends": "ngryman",
+  "root": true,
+  "extends": [
+    "ngryman",
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
   "rules": {
-    "valid-jsdoc": "off"
-  }
+    "prefer-const": "warn",
+    "no-var": "error"
+  },
+  "overrides": [
+    {
+      "files": ["test/*"],
+      "globals": {
+        "describe": true,
+        "it": true
+      },
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off"
+      }
+    }
+  ]
 }

.github/workflows/test.yml

@@ -23,5 +23,7 @@ jobs:
           node-version: ${{ matrix.node }}
       - name: Install dependencies
         run: npm install
+      - name: Build package
+        run: npm run build
       - name: Test
         run: npm test

.gitignore

@@ -14,4 +14,7 @@ Desktop.ini
 ._*
 Thumbs.db
 .Spotlight-V100
-.Trashes
+.Trashes
+
+dist/
+.eslintcache

README.md

@@ -39,10 +39,11 @@ const stats = readingTime(text);
 ### Stream
 
 ```javascript
-const {readingTimeStream} = require('reading-time');
+const {ReadingTimeStream} = require('reading-time');
 
+const analyzer = new ReadingTimeStream();
 fs.createReadStream('foo')
-  .pipe(readingTimeStream)
+  .pipe(analyzer)
   .on('data', stats => {
     // ...
   });