refactor: migrate to TypeScript

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x, 20.x]
+        node-version: [20.x]
       fail-fast: false
     steps:
       - name: Harden Runner
@@ -28,5 +28,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm install
+      - name: Build source
+        run: npm run build
       - name: Run tests
         run: npm run test

README.md

@@ -11,7 +11,7 @@ NodeSecure [SPDX licenses](https://spdx.org/licenses/) conformance. Project fork
 
 ## Requirements
 
-- [Node.js](https://nodejs.org/en/) v18 or higher
+- [Node.js](https://nodejs.org/en/) v20 or higher
 
 ## Getting Started
 
@@ -30,10 +30,9 @@ $ yarn add @nodesecure/licenses-conformance
 ```js
 import { licenseIdConformance } from "@nodesecure/licenses-conformance";
 
-const result = licenseIdConformance("MIT");
-if (result.ok) {
-  console.log(result.value);
-}
+const conformance = licenseIdConformance("MIT").unwrap();
+console.log(conformance);
+
 /*  
   {
     uniqueLicenseIds: ["MIT"],
@@ -51,10 +50,9 @@ if (result.ok) {
 ## API
 
 ```ts
-interface spdxLicenseConformance {
-  uniqueLicenseIds: string[];
-  spdxLicenseLinks: string[];
-  spdx?: {
+export interface SpdxLicenseConformance {
+  licenses: Record<string, string>
+  spdx: {
     osi: boolean;
     fsf: boolean;
     fsfAndOsi: boolean;
@@ -64,14 +62,14 @@ interface spdxLicenseConformance {
 
 function licenseIdConformance(
   licenseID: string
-): { ok: true, value: spdxLicenseConformance } | { ok: false, value: Error };
+): Result<SpdxLicenseConformance, Error>;
 
 function searchSpdxLicenseId(contentStr: string): string | null;
 ```
 
 ## Updating SPDX licenses
 
-To update the `src/spdx.js` file just run the following npm script:
+To update the `src/data/spdx.ts` file just run the following npm script:
 
 ```bash
 $ npm run spdx:refresh

package.json

@@ -2,49 +2,54 @@
   "name": "@nodesecure/licenses-conformance",
   "version": "2.1.0",
   "description": "Check spdx license expressions",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "start": "node index.js",
     "lint": "eslint index.js",
-    "test-only": "node --test",
-    "test": "npm run lint && npm run test-only",
-    "coverage": "c8 -r html npm test",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "npm run test-only",
+    "test-only": "glob -c \"tsx --test\" \"./test/**/*.test.ts\"",
+    "coverage": "c8 -r html npm run test-only",
     "spdx:refresh": "node ./scripts/fetchSpdxLicenses.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NodeSecure/licenses-conformance.git"
   },
   "files": [
-    "index.js",
-    "index.d.ts",
-    "src"
+    "dist"
   ],
   "keywords": [
     "spdx",
     "licenses"
   ],
   "author": "NodeSecure",
-  "type": "module",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/NodeSecure/licenses-conformance/issues"
   },
-  "types": "index.d.ts",
   "homepage": "https://github.com/NodeSecure/licenses-conformance#readme",
   "dependencies": {
+    "@openally/result": "^1.2.1",
     "fastest-levenshtein": "^1.0.16",
     "spdx-expression-parse": "^4.0.0"
   },
   "devDependencies": {
-    "@myunisoft/httpie": "^4.0.1",
-    "@nodesecure/eslint-config": "^1.8.0",
+    "@myunisoft/httpie": "^5.0.0",
+    "@nodesecure/eslint-config": "^1.9.0",
+    "@types/node": "^20.14.9",
+    "@types/spdx-expression-parse": "^3.0.5",
     "astring": "^1.8.6",
-    "c8": "^9.1.0",
-    "eslint": "^8.31.0",
-    "node-estree": "^4.0.0"
+    "c8": "^10.1.2",
+    "eslint": "^8.57.0",
+    "glob": "^10.4.2",
+    "node-estree": "^4.0.0",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }

scripts/fetchSpdxLicenses.js

@@ -7,7 +7,7 @@ import * as astring from "astring";
 import { ESTree, Helpers, VarDeclaration } from "node-estree";
 
 // CONSTANTS
-const kSrcDirectory = new URL("../src/", import.meta.url);
+const kSrcDirectory = new URL("../src/data/", import.meta.url);
 
 const { data } = await httpie.get(
   "https://raw.githubusercontent.com/spdx/license-list-data/main/json/licenses.json"
@@ -46,6 +46,6 @@ const prog = ESTree.Program("module", [
 ]);
 
 fs.writeFileSync(
-  new URL("spdx.js", kSrcDirectory),
+  new URL("spdx.ts", kSrcDirectory),
   `/* eslint-disable max-lines */\n\n` + astring.generate(prog)
 );