fix: build files and workflows

.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 14.17
+          node-version: 12.20
       - run: npm ci
       - run: npm run lint
       - run: npm run build

.github/workflows/validate.yml

@@ -18,9 +18,9 @@ jobs:
       fail-fast: false
       matrix:
         node-version:
-          - 18
           - 16
-          - 14
+          - 14.14
+          - 12.20
         os:
           - ubuntu-latest
           - windows-latest

.swcrc

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "test": ".*.ts$",
+  "jsc": {
+    "parser": {
+      "syntax": "typescript"
+    },
+    "target": "es2019",
+    "externalHelpers": true
+  },
+  "module": {
+    "type": "es6"
+  }
+}

package.json

@@ -27,10 +27,10 @@
     "matching"
   ],
   "engines": {
-    "node": ">=v12.22.12"
+    "node": "^12.20 || ^14.14 || >=16"
   },
   "type": "module",
-  "main": "dist/index.js",
+  "exports": "./dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
@@ -41,15 +41,15 @@
     "start": "npm run build && npm run watch",
     "watch": "chokidar \"src/*.ts\" -c \"npm run build\"",
     "lint": "tsc --noEmit && eslint \"./src\" --ext \".ts\" --cache --cache-location \"node_modules/.cache/.eslintcache\"",
-    "build": "swc \"./src\" -d \"dist\" && tsc \"src/index.ts\" -d --emitDeclarationOnly --outDir \"dist\"",
+    "build": "swc \"./src\" -d \"dist\" && tsc -d --emitDeclarationOnly",
     "test": "ava --verbose",
     "coverage": "c8 -r lcov -r text npm test"
   },
   "dependencies": {
     "leven": "^4.0.0"
   },
   "devDependencies": {
-    "doogu": "^2.1.2"
+    "doogu": "^2.1.5"
   },
   "config": {
     "commitizen": {

readme.md

@@ -34,11 +34,11 @@ Finds similar word(s) in a list of words.
 
 #### Parameters
 
-| Name         | Type     | Description                           |
-| :----------- | :------- | :------------------------------------ |
-| `word`       | string   | The word to find similar words for.   |
-| `candidates` | string[] | An array of words to compare against. |
-| `options`    | Options  | Options for the function.             |
+| Name         | Type                          | Description                           |
+| :----------- | :---------------------------- | :------------------------------------ |
+| `word`       | string                        | The word to find similar words for.   |
+| `candidates` | string[]                      | An array of words to compare against. |
+| `options`    | [Options](#interface-options) | Options for the function.             |
 
 #### Returns
 
@@ -54,33 +54,49 @@ An array of similar words.
 
 Suggests similar words in a list of words.
 
+```js
+const suggetion = didYouMean('foos', ['bar', 'baz', 'foo'], {
+  prefix: '--'
+})
+console.log(suggetion)
+// => 'Did you mean "--foo"?'
+```
+
 #### Parameters
 
-| Name         | Type     | Description                           |
-| :----------- | :------- | :------------------------------------ |
-| `word`       | string   | The word to find similar words for.   |
-| `candidates` | string[] | An array of words to compare against. |
-| `options`    | Options  | Options for the function.             |
+| Name         | Type                          | Description                           |
+| :----------- | :---------------------------- | :------------------------------------ |
+| `word`       | string                        | The word to find similar words for.   |
+| `candidates` | string[]                      | An array of words to compare against. |
+| `options`    | [Options](#interface-options) | Options for the function.             |
 
 #### Returns
 
 string
 
 A string of suggested words.
 
-## Type aliases
+---
+
+### Interface: Options
+
+#### maxScore
+
+• `Optional` **maxScore**: `number`
+
+Maximum levenshtein distance threshold. **`default`** 3
+
+#### criteria
+
+• `Optional` **criteria**: `number`
 
-### Options
+The similarity threshold, a number between 0 and 1. **`default`** 0.5
 
-Ƭ **Options**: `Object`
+#### prefix
 
-#### Type declaration
+• `Optional` **prefix**: `string`
 
-| Name        | Type   | Description                                                           |
-| :---------- | :----- | :-------------------------------------------------------------------- |
-| `maxScore?` | number | Maximum levenshtein distance threshold. **`default`** 3               |
-| `criteria?` | number | The similarity threshold, a number between 0 and 1. **`default`** 0.5 |
-| `prefix?`   | string | A string to prepend to the suggested word. **`default`** ''           |
+A string to prepend to the suggested word. **`default`** ''
 
 ## Contributing
 

test/index.test.ts

@@ -1,5 +1,5 @@
 import test from 'ava'
-import { findSimilar, didYouMean } from '../src/index.js'
+import { findSimilar, didYouMean } from '../dist/index.js'
 
 test('singgle suggestions', t => {
   const suggestions = didYouMean('foos', ['bar', 'baz', 'foo'])

tsconfig.json

@@ -1,5 +1,9 @@
 {
   "extends": "doogu/config/tsconfig.json",
 
-  "include": ["src", "test"]
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+
+  "include": ["src"]
 }