Merge pull request #612 from ClarityCafe/sr229/cjs

Fix CJS support

.github/workflows/test.yml

@@ -31,6 +31,7 @@ jobs:
           deno install -D
           deno task build
           deno task coverage:deno
+
   test-bun:
     runs-on: ubuntu-latest
 
@@ -52,3 +53,30 @@ jobs:
         run: |
           echo 'SAUCENAO_TOKEN=${{ secrets.SAUCENAO_TOKEN }}' > ./.env.test.local
           bun run coverage
+
+  test-node:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 22.x]
+
+    steps:
+      - uses: actions/checkout@v4.1.7
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Get Dependencies and Build
+        run: pnpm install && pnpm build
+
+      - name: Run Coverage and Lint
+        run: |
+          echo 'SAUCENAO_TOKEN=${{ secrets.SAUCENAO_TOKEN }}' > ./.env.test.local
+          pnpm coverage:nodejs

.gitignore

@@ -33,3 +33,6 @@ docsbuild/
 # Lock files
 package-lock.json
 yarn.lock
+
+# nyc test coverage
+.nyc_output/

jsr.json

@@ -1,5 +1,12 @@
 {
   "name": "@clarity/sagiri",
   "version": "4.1.0",
-  "exports": "./lib/sagiri.ts"
+  "exports": "./src/sagiri.ts",
+  "publish": {
+    "include": [
+      "LICENSE",
+      "README.md",
+      "src/**/*.ts"
+    ]
+  }
 }

package.json

@@ -3,8 +3,15 @@
   "version": "4.1.0",
   "description": "A simple, lightweight and actually good JS wrapper for the SauceNAO API.",
   "license": "MIT",
-  "main": "dist/sagiri.cjs",
-  "type": "module",
+  "main": "./dist/sagiri.cjs",
+  "module": "./dist/sagiri.mjs",
+  "types": "./dist/sagiri.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/sagiri.cjs",
+      "import": "./dist/sagiri.mjs"
+    }
+  },
   "homepage": "https://github.com/ClarityCafe/Sagiri#readme",
   "repository": {
     "type": "git",
@@ -36,39 +43,42 @@
     "source"
   ],
   "engines": {
-    "node": ">=20"
+    "node": "20.x"
   },
   "files": [
     "dist",
     "README.md",
     "LICENSE"
   ],
-  "exports": {
-    "import": "./dist/sagiri.cjs",
-    "require": "./dist/index.cjs"
-  },
   "scripts": {
     "test": "bun --env-file='./.env.test.local' test bun",
     "test:deno": "deno test --unstable-sloppy-imports --allow-net --allow-read test/deno/sagiri.test.ts",
     "coverage:deno": "deno test --unstable-sloppy-imports --allow-net --allow-read --coverage test/deno/sagiri.test.ts",
-    "test:nodejs": "jest node",
-    "coverage:nodejs": "jest node --coverage",
+    "test:nodejs": "mocha ./test/node/",
+    "coverage:nodejs": "nyc mocha ./test/node/",
     "coverage": "bun --env-file='./.env.test.local' test bun --coverage",
     "lint": "eslint --fix",
-    "build": "tsup",
-    "prepublishOnly": "bun run build"
+    "build": "unbuild",
+    "prepublishOnly": "bun run build",
+    "postinstall": "node scripts/postinstall.js"
   },
   "devDependencies": {
     "@types/bun": "latest",
+    "@types/mocha": "^10.0.9",
+    "@types/node-fetch": "^2.6.11",
     "bun": "^1.1.26",
     "eslint": "^9.9.1",
-    "jest": "^29.7.0",
-    "tsup": "^8.2.4",
+    "mocha": "^10.7.3",
+    "nyc": "^17.1.0",
     "typescript": "^5.6.2",
-    "typescript-eslint": "^8.3.0"
+    "typescript-eslint": "^8.3.0",
+    "unbuild": "^2.0.0"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
-  "dependencies": { "form-data": "^4.0.0", "node-fetch": "^3.3.2" }
+  "dependencies": {
+    "form-data": "^4.0.0",
+    "node-fetch": "2.6.6"
+  }
 }

scripts/postinstall.js

@@ -0,0 +1,14 @@
+console.log(`
+**************************************************
+*                                                *
+*         Thank you for using Sagiri <3!         *
+*                                                *
+*  If you find this library useful, please       *
+*  consider supporting its maintenance by        *
+*  contributing or donating.                     *
+*                                                *
+**************************************************
+
+Support this project financially at: https://ko-fi.com/capuccino
+Contribute to this project at: https://github.com/ClarityCafe/Sagiri
+`);

test/bun/index.spec.ts

@@ -1,5 +1,5 @@
 import { expect, test } from "bun:test";
-import sagiri from "../../lib/sagiri";
+import sagiri from "../../src/sagiri";
 import { env } from "node:process";
 
 test("Should fail on invalid characters", () => {

test/deno/sagiri.test.ts

@@ -1,5 +1,5 @@
 import { assertThrows, assertExists } from "@std/assert";
-import sagiri from "../../lib/sagiri.ts";
+import sagiri from "../../src/sagiri.ts";
 
 Deno.test("should fail on invalid characters", () => {
   assertThrows(() => { sagiri("!!!!!*&#@(!)") });

test/node/commonjs.test.cjs

@@ -1,12 +1,16 @@
 /* eslint-disable @typescript-eslint/no-require-imports */
-const process = require("process");
-// this is so arbitrary holy shit
-const sagiriOnCjs = require("../../dist/sagiri.cjs");
+/* eslint-disable no-undef */
+const assert = require('assert');
+const sagiri = require('../../dist/sagiri.cjs');
+const describe = require('mocha').describe;
+const it = require('mocha').it;
 
-test("Resolve using Commonjs", async() => {
-  const result = await sagiriOnCjs(process.env.SAUCENAO_TOKEN, { results: 5 })("https://i.imgur.com/F9QSgPx.jpeg");
-  console.log(result);
+describe('Sagiri#client', function() {
+  it('should be a function', function() {
+    assert.strictEqual(typeof sagiri, 'function');
+  });
 
-  expect(sagiriOnCjs).toBeDefined();
-  expect(result).toBeDefined();
+  it('should throw on invalid characters', function () {
+    assert.throws(() => sagiri("!!!!!*&#@(!)"));
+  })
 })