refactor!: introduce typescript and tooling (#1)

Author: Xstoudi

.eslintrc.yml

@@ -0,0 +1 @@
+extends: cheminfo-typescript

.github/workflows/nodejs.yml

@@ -0,0 +1,14 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  nodejs:
+    # Documentation: https://github.com/zakodium/workflows#nodejs-ci
+    uses: zakodium/workflows/.github/workflows/nodejs.yml@nodejs-v1
+    with:
+      lint-check-types: true

.github/workflows/release.yml

@@ -0,0 +1,16 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    # Documentation: https://github.com/zakodium/workflows#release
+    uses: zakodium/workflows/.github/workflows/release.yml@release-v1
+    with:
+      npm: true
+    secrets:
+      github-token: ${{ secrets.BOT_TOKEN }}
+      npm-token: ${{ secrets.NPM_BOT_TOKEN }}

.gitignore

@@ -35,3 +35,5 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
+
+lib*

.npmrc

@@ -0,0 +1 @@
+package-lock=false

README.md

@@ -1,4 +1,4 @@
-# jpeg-js
+# fast-jpeg
 
   [![NPM version][npm-image]][npm-url]
   [![npm download][download-image]][download-url]

package.json

@@ -2,12 +2,27 @@
   "name": "fast-jpeg",
   "version": "1.0.1",
   "description": "JPEG image decoder written entirely in JavaScript",
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "module": "lib-esm/index.js",
+  "types": "lib/index.d.ts",
   "files": [
-    "src"
+    "src",
+    "lib-esm",
+    "lib"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib lib-esm",
+    "eslint": "eslint src",
+    "eslint-fix": "npm run eslint -- --fix",
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check src",
+    "prettier-write": "prettier --write src",
+    "test": "npm run test-only && npm run eslint && npm run prettier && npm run check-types",
+    "test-only": "jest --coverage",
+    "tsc": "npm run clean && npm run tsc-cjs && npm run tsc-esm",
+    "tsc-cjs": "tsc --project tsconfig.cjs.json",
+    "tsc-esm": "tsc --project tsconfig.esm.json"
   },
   "repository": {
     "type": "git",
@@ -17,11 +32,32 @@
   "author": "Michaël Zasso",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/image-js/jpeg-js/issues"
+    "url": "https://github.com/image-js/fast-jpeg/issues"
   },
-  "homepage": "https://github.com/image-js/jpeg-js#readme",
+  "homepage": "https://github.com/image-js/fast-jpeg#readme",
   "dependencies": {
-    "iobuffer": "^2.1.0",
-    "tiff": "^2.0.0"
+    "iobuffer": "^5.3.2",
+    "tiff": "^5.0.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.1",
+    "eslint": "^8.41.0",
+    "eslint-config-cheminfo-typescript": "^11.3.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.1",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
+  },
+  "prettier": {
+    "arrowParens": "always",
+    "semi": true,
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "all"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
   }
 }

src/.npmignore

@@ -0,0 +1,2 @@
+__tests__
+.npmignore

src/__tests__/decode.test.ts

@@ -0,0 +1,19 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+import { decode } from '../decode';
+
+function readImage(file: string): Buffer {
+  return readFileSync(join(__dirname, './img', file));
+}
+
+test('should extract exif', () => {
+  const result = decode(readImage('sample.jpg'));
+  expect(result.exif).toBeDefined();
+
+  const { exif } = result;
+  expect(exif?.[0].fields.size).toBe(12);
+  expect(exif?.[0].fields.get(271)).toBe('SONY');
+  expect(exif?.[0].fields.get(272).trimEnd()).toBe('DSC-HX9V');
+  expect(exif?.[0].fields.get(274)).toBe(1);
+});