v3 changes

.changeset/busy-otters-grow.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': minor
+---
+
+Export `assertValidImageData` for validating `ImageDataLike` input at runtime.

.changeset/config.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "$schema": "https://unpkg.com/@changesets/config@3.1.4/schema.json",
   "changelog": ["changesets-changelog-clean", { "repo": "duniul/pixel-scale" }],
   "commit": false,
   "fixed": [],

.changeset/early-forks-walk.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': patch
+---
+
+Speed up `scalePixels` by preallocating the output `Uint8ClampedArray` (up to 8x faster).

.changeset/free-lions-film.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': major
+---
+
+**BREAKING** Validate all inputs and throw `TypeError`/`RangeError` early on invalid arguments.

.changeset/funny-pigs-lose.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': patch
+---
+
+Speed up `getPixelScale` by iterating data as a `Uint32Array`.

.changeset/odd-radios-join.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': patch
+---
+
+Fix early exit in `getPixelScale` when only one scale is possible.

.changeset/olive-carrots-burn.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': minor
+---
+
+Add JSDoc/TSDoc comments to exported functions and types.

.changeset/small-camels-divide.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': patch
+---
+
+Add early exit in `scalePixels` when `to` equals the current scale.

.changeset/stale-moles-enter.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': major
+---
+
+**BREAKING** Drop CommonJS build; ship ESM only.

.changeset/tender-experts-yell.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': patch
+---
+
+Fix `multiplyPixelScale` and `dividePixelScale` ignoring `options.from`.

.changeset/unlucky-sheep-grin.md

@@ -0,0 +1,5 @@
+---
+'pixel-scale': patch
+---
+
+Mark the package as side-effect free for better tree-shaking.

.gitattributes

@@ -0,0 +1,4 @@
+* text eol=lf
+*.jpg binary
+*.png binary
+*.gif binary

.github/workflows/changesets.yml

@@ -7,30 +7,33 @@ on:
       - main
     paths-ignore:
       - '.vscode/**'
-      - 'demo/**'
+      - '.gitattributes'
+      - '.gitignore'
       - '*.md'
+      - 'LICENSE'
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 permissions:
   contents: write
   pull-requests: write
+  id-token: write
 
 jobs:
   main:
     name: Publish changed packages
     runs-on: ubuntu-latest
     steps:
       - name: 🏗 Setup repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: 🏗 Setup pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v6
 
       - name: 🏗 Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: 18.x
+          node-version: 22.x
           cache: pnpm
 
       - name: 📦 Install dependencies
@@ -46,4 +49,3 @@ jobs:
           publish: pnpm run release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/checks.yml

@@ -5,61 +5,44 @@ on:
   push:
     paths-ignore:
       - '.vscode/**'
-      - 'demo/**'
+      - '.gitattributes'
+      - '.gitignore'
       - '*.md'
+      - 'LICENSE'
 
 permissions:
   contents: read
 
 jobs:
   build:
-    name: 🧱 Build
+    name: 🧱 Checks, tests and builds
     runs-on: ubuntu-latest
     permissions:
       contents: read
     steps:
       - name: 🏗 Setup repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: 🏗 Setup pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v6
 
       - name: 🏗 Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: 18.x
+          node-version: 22.x
           cache: pnpm
 
       - name: 📦 Install dependencies
         run: pnpm install
 
-      - name: 🧱 Build project
-        run: pnpm build
-
-  test:
-    name: 🧪 Test
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node-version: [18.x, 20.x]
-
-    runs-on: ${{ matrix.os }}
-
-    steps:
-      - name: 🏗 Setup repo
-        uses: actions/checkout@v4
-
-      - name: 🏗 Setup pnpm
-        uses: pnpm/action-setup@v4
+      - name: 🧹 Stylecheck project
+        run: pnpm stylecheck
 
-      - name: 🏗 Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 18.x
-          cache: pnpm
+      - name: 🧹 Typecheck project
+        run: pnpm typecheck
 
-      - name: 📦 Install dependencies
-        run: pnpm install
+      - name: 🧱 Build project
+        run: pnpm build
 
       - name: 🧪 Run tests
         run: pnpm test

.gitignore

@@ -18,6 +18,7 @@ lib
 .env.development.local
 .env.test.local
 .env.production.local
+.history
 
 npm-debug.log*
 yarn-debug.log*
@@ -26,3 +27,6 @@ lerna-debug.log*
 
 # Parcel cache
 **/.cache
+
+# TypeScript
+.tsbuildinfo

.oxfmtrc.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "ignorePatterns": ["**/node_modules", "**/dist", "**/.history", "**/.tsbuildinfo", "**/bench.*.json"],
+  "printWidth": 110,
+  "trailingComma": "es5",
+  "jsxSingleQuote": true,
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "quoteProps": "consistent",
+  "sortPackageJson": {
+    "enabled": true,
+    "sortScripts": false
+  },
+  "sortImports": {
+    "enabled": true,
+    "newlinesBetween": false
+  }
+}

.oxlintrc.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "ignorePatterns": ["**/node_modules", "**/dist", "**/.history", "**/.tsbuildinfo", "**/bench.*.json"],
+  "plugins": ["eslint", "import", "jsdoc", "node", "oxc", "promise", "typescript", "unicorn"],
+  "env": {
+    "builtin": true,
+    "browser": true,
+    "shared-node-browser": true
+  },
+  "categories": {
+    "correctness": "error",
+    "nursery": "error",
+    "pedantic": "error",
+    "perf": "error",
+    "restriction": "error",
+    "style": "error",
+    "suspicious": "error"
+  },
+  "rules": {
+    "capitalized-comments": "off",
+    "consistent-type-definitions": ["error", "type"],
+    "explicit-length-check": "off",
+    "exports-last": "off",
+    "filename-case": ["error", { "case": "camelCase" }],
+    "func-style": "off",
+    "id-length": "off",
+    "curly": ["error", "multi-line"],
+    "import/consistent-type-specifier-style": "off",
+    "import/group-exports": "off",
+    "import/no-named-export": "off",
+    "import/no-namespace": "off",
+    "import/no-nodejs-modules": "off",
+    "import/no-relative-parent-imports": "off",
+    "import/prefer-default-export": "off",
+    "init-declarations": "off",
+    "jsdoc/require-param-type": "off",
+    "jsdoc/require-param": "off",
+    "jsdoc/require-returns-type": "off",
+    "jsdoc/require-returns": "off",
+    "max-lines-per-function": "off",
+    "max-lines": "off",
+    "max-params": "off",
+    "max-statements": "off",
+    "number-literal-case": "off",
+    "no-array-callback-reference": "off",
+    "no-async-await": "off",
+    "no-continue": "off",
+    "no-duplicate-imports": ["error", { "allowSeparateTypeImports": true }],
+    "no-implicit-coercion": "off",
+    "no-inline-comments": "off",
+    "no-magic-numbers": "off",
+    "no-nested-ternary": "off",
+    "no-null": "off",
+    "no-optional-chaining": "off",
+    "no-plusplus": "off",
+    "no-rest-spread-properties": "off",
+    "no-ternary": "off",
+    "no-undefined": "off",
+    "operator-assignment": "off",
+    "prefer-await-to-then": "off",
+    "prefer-destructuring": "off",
+    "prefer-template": "off",
+    "prefer-ternary": "off",
+    "promise/avoid-new": "off",
+    "require-unicode-regexp": "off",
+    "sort-imports": "off",
+    "sort-keys": "off",
+    "typescript/explicit-member-accessibility": ["error", { "accessibility": "no-public" }],
+    "unicorn/no-nested-ternary": "off"
+  },
+  "overrides": [
+    {
+      "files": ["*.config.ts", "*.config.*.ts"],
+      "rules": {
+        "import/no-default-export": "off"
+      }
+    },
+    {
+      "files": ["src/cli/**/*.ts"],
+      "rules": {
+        "new-cap": "off",
+        "no-console": "off"
+      }
+    },
+    {
+      "files": ["__mocks__/fs/**/*"],
+      "rules": {
+        "unicorn/prefer-module": "off",
+        "import/no-commonjs": "off"
+      }
+    },
+    {
+      "files": ["bin/**/*"],
+      "rules": {
+        "import/no-unassigned-import": "off"
+      }
+    },
+    {
+      "files": ["*.test.ts", "__test__/**"],
+      "plugins": ["vitest"],
+      "env": {
+        "vitest": true,
+        "node": true
+      },
+      "rules": {
+        "vitest/no-hooks": "off",
+        "vitest/require-top-level-describe": "off",
+        "vitest/no-importing-vitest-globals": "off",
+        "vitest/consistent-test-it": "off",
+        "vitest/prefer-to-be-truthy": "off",
+        "vitest/prefer-to-be-falsy": "off",
+        "vitest/max-expects": "off",
+        "vitest/prefer-expect-assertions": [
+          "error",
+          {
+            "onlyFunctionsWithAsyncKeyword": true,
+            "onlyFunctionsWithExpectInCallback": true,
+            "onlyFunctionsWithExpectInLoop": true
+          }
+        ],
+        "vitest/valid-title": "off",
+        "vitest/prefer-called-once": "off",
+        "no-magic-numbers": "off"
+      }
+    }
+  ]
+}