JamieMason/expect-more

import { isSameLengthAs } from 'expect-more';
import { printExpected } from 'jest-matcher-utils';
import { getIn } from './lib/get-in';

declare global {
  namespace jasmine {
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    interface Matchers<T> {
      /**
       * Asserts that a value is a `String` or `Array` whose length is the same as that of the other provided.
       * @example
       * expect({ child: { grandchild: ['i also have', '2 items'] } }).toHaveSameLengthAs('child.grandchild', ['i have', '2 items']);
       */
      toHaveSameLengthAs(propPath: string, other: string | any[]): boolean;
    }
  }
}

export const toHaveSameLengthAsMatcher: jasmine.CustomMatcherFactory = () => {
  return {
    compare(value: unknown, propPath: string, other: string | any[]) {
      const pass = isSameLengthAs(other, getIn(propPath.split('.'), value));
      const message = pass
        ? `expected value at '${printExpected(
            propPath,
          )}' not to be a string or array whose length is the same as that of ${printExpected(
            other,
          )}`
        : `expected value at '${printExpected(
            propPath,
          )}' to be a string or array whose length is the same as that of ${printExpected(other)}`;
      return { message, pass };
    },
  };
};

beforeAll(() => {
  jasmine.addMatchers({
    toHaveSameLengthAs: toHaveSameLengthAsMatcher,
  });
});