refactor(max)!: migrate to TypeScript and ESM

packages/array-max/.prettierignore

@@ -0,0 +1,3 @@
+CHANGELOG.md
+coverage
+lib

packages/array-max/README.md

@@ -1,7 +1,7 @@
 # array-max
 
-  [![NPM version][npm-image]][npm-url]
-  [![npm download][download-image]][download-url]
+[![NPM version][npm-image]][npm-url]
+[![npm download][download-image]][download-url]
 
 Get the maximum value in an array.
 
@@ -20,7 +20,7 @@ const result = max([1, 5, 3, 2, 4]);
 
 ## License
 
-  [MIT](./LICENSE)
+[MIT](./LICENSE)
 
 [npm-image]: https://img.shields.io/npm/v/ml-array-max.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/ml-array-max

packages/array-max/eslint.config.js

@@ -0,0 +1,4 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+import ts from 'eslint-config-cheminfo-typescript/base';
+
+export default defineConfig(globalIgnores(['coverage', 'lib']), ts);

packages/array-max/package.json

@@ -2,12 +2,13 @@
   "name": "ml-array-max",
   "version": "1.2.4",
   "description": "Get the maximum value in an array",
-  "main": "lib/index.js",
-  "module": "lib-es6/index.js",
-  "types": "types.d.ts",
+  "type": "module",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "types": "./types.d.ts",
   "files": [
     "lib",
-    "lib-es6",
     "src",
     "types.d.ts"
   ],
@@ -22,7 +23,27 @@
     "url": "https://github.com/mljs/array/issues"
   },
   "homepage": "https://github.com/mljs/array/tree/master/packages/array-max#readme",
+  "scripts": {
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf coverage lib",
+    "eslint": "eslint . --cache",
+    "eslint-fix": "npm run eslint -- --fix",
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check .",
+    "prettier-write": "prettier --write .",
+    "test": "npm run test-only && npm run check-types && npm run eslint && npm run prettier",
+    "test-only": "vitest run --coverage",
+    "tsc": "npm run clean && npm run tsc-build",
+    "tsc-build": "tsc --project tsconfig.build.json"
+  },
   "dependencies": {
-    "is-any-array": "^2.0.0"
+    "is-any-array": "^3.0.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.1.4",
+    "@zakodium/tsconfig": "^1.0.5",
+    "eslint-config-cheminfo-typescript": "^21.2.0",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.4"
   }
 }

packages/array-max/src/__tests__/max.test.js → packages/array-max/src/__tests__/max.test.ts

@@ -1,11 +1,8 @@
-import max from '..';
+import { describe, expect, it } from 'vitest';
 
-describe('array-max', () => {
-  let typedArray = new Uint16Array(3);
-  typedArray[0] = 1;
-  typedArray[1] = 2;
-  typedArray[2] = 3;
+import max from '../index.ts';
 
+describe('array-max', () => {
   it('should return the max', () => {
     expect(max([0])).toBe(0);
     expect(max([1])).toBe(1);
@@ -17,11 +14,15 @@ describe('array-max', () => {
     expect(max([3, 2, 1], { fromIndex: 1, toIndex: 3 })).toBe(2);
     expect(max([3, 2, 1], { fromIndex: 0, toIndex: 2 })).toBe(3);
     expect(max([3, 2, 1], { fromIndex: 2, toIndex: 3 })).toBe(1);
+
+    const typedArray = Uint16Array.of(1, 2, 3);
+
     expect(max(typedArray)).toBe(3);
     expect(max(typedArray, { fromIndex: 0, toIndex: 2 })).toBe(2);
     expect(max(typedArray, { fromIndex: 0, toIndex: 3 })).toBe(3);
   });
   it('should throw on invalid value', () => {
+    // @ts-expect-error ensure implementation catch missing input
     expect(() => max()).toThrow(/input must be an array/);
     expect(() => max([])).toThrow(/input must not be empty/);
     expect(() => max([1, 2, 3], { fromIndex: -1, toIndex: 2 })).toThrow(

packages/array-max/src/index.js → packages/array-max/src/index.ts

@@ -1,6 +1,29 @@
 import { isAnyArray } from 'is-any-array';
 
-export default function max(input, options = {}) {
+export interface MlArrayMaxOptions {
+  /**
+   * Start index (inclusive) for the slice within which we look for the maximum.
+   * @default 0
+   */
+  fromIndex?: number;
+
+  /**
+   * End index (exclusive) for the slice within which we look for the maximum.
+   * @default input.length
+   */
+  toIndex?: number;
+}
+
+/**
+ * Computes the maximum of the given values.
+ *
+ * @param input
+ * @param options
+ */
+export default function mlArrayMax(
+  input: ArrayLike<number>,
+  options: MlArrayMaxOptions = {},
+): number {
   if (!isAnyArray(input)) {
     throw new TypeError('input must be an array');
   }

packages/array-max/tsconfig.build.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": { "rootDir": "src" },
+  "include": ["src"],
+  "exclude": ["**/__tests__", "**/*.test.*"]
+}

packages/array-max/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@zakodium/tsconfig",
+  "compilerOptions": {
+    "rootDir": ".",
+    "noUncheckedIndexedAccess": false,
+    "outDir": "lib",
+    "types": ["node"]
+  },
+  "include": ["src", "vite*.ts"]
+}

packages/array-max/vitest.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    coverage: {
+      include: ['src/**/*.ts'],
+    },
+  },
+});