Add warning in development when a result function is x => x.

[aryaemami59]

This PR:

• Adds identityFunctionCheck to warn to the user if the result function returns its input. It has the same configuration options as inputStabilityCheck.
• Adds unit tests for identityFunctionCheck.
• Adds JSDocs for identityFunctionCheck.
• Adds documentation for identityFunctionCheck to README.
• Adds DevModeChecks, a type representing the configuration for development mode checks.
• Replaces inputStabilityCheck and identityFunctionCheck inside CreateSelectorOptions with devModeChecks.
• Adds DevModeChecksExecutionInfo, a type representing execution information for development mode checks.
• Adds setGlobalDevModeChecks, a function allowing to override globalDevModeChecks.
• Creates devModeChecks folder.
• Moves each dev-mode-check to their own file.
• Removes shouldRunDevModeCheck in favor of getDevModeChecksExecutionInfo.
• Updates unit tests to comply with these changes.
• Adds documentation to Netlify docs once merged with Transition README Docs to Docusaurus-Netlify Setup #641.
• Updates README with new dev-mode-check API.

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit ae0a921:

Sandbox	Source
Vanilla Typescript	Configuration

[EskiMojo14]

haven't had a chance to look through this properly yet, but a few initial suggestions

[aryaemami59]

BTW I only called it noopCheck to stay consistent with react-redux, if you have a better suggestion I'm all ears :)

[EskiMojo14]

we couldn't come up with anything better for react-redux so i doubt we'll do so here :) noopCheck is fine imo

[aryaemami59]

we couldn't come up with anything better for react-redux so i doubt we'll do so here :) noopCheck is fine imo

How about identityFunctionWarning or maybe noTransformationWarning?

[markerikson]

I don't know how many more dev checks we'd add in the future, but I think we ought to consolidate this into a single combined setter function just in case we do add more, rather than adding a bunch of individual setters.

I'm thinking something like setDefaultDevCheckFrequency(checks: Partial<Record<DevCheckType, DevCheckFrequency>>).

Let me play with that a bit on this branch.

[aryaemami59]

I don't know how many more dev checks we'd add in the future, but I think we ought to consolidate this into a single combined setter function just in case we do add more, rather than adding a bunch of individual setters.

I'm thinking something like setDefaultDevCheckFrequency(checks: Partial<Record<DevCheckType, DevCheckFrequency>>).

Let me play with that a bit on this branch.

Yeah, I agree. If I put them in different files, would that be problematic?

[markerikson]

I'm picturing having a singleton object with the current global check values, and the setter would loop over the incoming options and assign. (Could even do Object.assign(globalOptions, incomingOptions) if we aren't worried about someone passing in {stability: undefined}, I guess.)

[EskiMojo14]

the "should run" check explicitly checks against "always" and "once" so any other values will just function the same as "never", which i think is okay

[aryaemami59]

@markerikson I think I get it, so it would look something like this:

export type DevModeChecks = Record<
  'inputStabilityCheck' | 'identityFunctionCheck',
  DevModeCheckFrequency
>

const globalDevModeChecks: DevModeChecks = {
  inputStabilityCheck: 'once',
  identityFunctionCheck: 'once'
}

export const setGlobalDevModeChecks = (
  devModeChecks: Partial<DevModeChecks>
) => {
  Object.assign(globalDevModeChecks, devModeChecks)
}

then inside createSelectorCreator:

      memoize,
      memoizeOptions = [],
      argsMemoize = defaultMemoize,
      argsMemoizeOptions = [],
      inputStabilityCheck = globalDevModeChecks.inputStabilityCheck,
      identityFunctionCheck = globalDevModeChecks.identityFunctionCheck
    } = combinedOptions

and to set the values globally:

it('disables check if global setting is changed', () => {
    setGlobalDevModeChecks({ inputStabilityCheck: 'never' })

    expect(addNums(1, 2)).toBe(3)

    expect(unstableInput).toHaveBeenCalledTimes(1)

    expect(consoleSpy).not.toHaveBeenCalled()

    setGlobalDevModeChecks({ inputStabilityCheck: 'once' })
  })

This could actually work I think. It passed the tests.

[aryaemami59]

@markerikson I'm not too sure about the warning message in the console, do you think we can improve on it, or leave it as is?