Merge pull request #3 from zacharyarney/v0.1.0

V0.1.0 tests and GitHub actions

.eslintrc.cjs

@@ -5,6 +5,7 @@ module.exports = {
     'eslint:recommended',
     'plugin:@typescript-eslint/strict-type-checked',
     'plugin:@typescript-eslint/stylistic-type-checked',
+    'plugin:import/recommended',
   ],
   ignorePatterns: ['dist', '.eslintrc.cjs', '*.config.ts', '*.config.js'],
   parser: '@typescript-eslint/parser',
@@ -15,4 +16,25 @@ module.exports = {
     tsconfigRootDir: __dirname,
   },
   plugins: ['prettier'],
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.ts', '.js'],
+      },
+    },
+  },
+  overrides: [
+    {
+      files: ['*.test.ts', '*.spec.ts'],
+      plugins: ['jest'],
+      rules: {
+        // you should turn the original rule off *only* for test files
+        '@typescript-eslint/unbound-method': 'off',
+        'jest/unbound-method': 'error',
+      },
+    },
+  ],
+  rules: {
+    '@typescript-eslint/unbound-method': 'error',
+  },
 };

.github/workflows/main.yml

@@ -0,0 +1,39 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install Dependencies
+      run: npm ci
+
+    - name: Run Build
+      run: npm run build
+
+    - name: Lint Check
+      run: npm run lint --if-present
+
+    - name: Validate tests
+      run: npm run test --if-present

.prettierrc

@@ -10,5 +10,5 @@
   "singleQuote": true,
   "tabWidth": 2,
   "trailingComma": "es5",
-  "useTabs": false,
+  "useTabs": false
 }

README.md

@@ -28,7 +28,7 @@ The histogram algorithm sorts the pixels in an image into sectors in a 3D grid b
 the average RGB value for each sector in order of sector density.
 
 Some reasonable default parameters are provided for the histogram generation process. The number of sectors can be
-increased using the `dimensionscs` parameter for greater color accuracy and the size of the color palette can be
+increased using the `dimensions` parameter for greater color accuracy and the size of the color palette can be
 adjusted with the `paletteSize` parameter.
 
 ## Todo
@@ -42,6 +42,7 @@ adjusted with the `paletteSize` parameter.
 
 - Currently requires Node.js runtime. Browser support is on the todo list.
 - Doesn't yet support transparency and will ignore alpha channels when generating color palette, meaning that the color
-  palette will include RGB values for transparent pixels.
+  palette will include RGB values for transparent pixels which could lead to unexpected results when generating palettes
+  for images with transparency.
 - The palette is stored as an array of objects with `r`, `g`, and `b` properties. This may be subject to change in the
   future.

jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  testEnvironment: 'node',
+  transform: {
+    '^.+.tsx?$': ['ts-jest', {}],
+  },
+};