Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: hooks returned by factory functions not linted #25066

Closed
wants to merge 5 commits into from

Conversation

KATT
Copy link

@KATT KATT commented Aug 8, 2022

🚧 🚧

Summary

Showcase #25065

// Factory function for creating hooks
function createHooks() {
  return {
    foo: {
      useQuery: () => {
        data: 'foo.useQuery'
      },
    }
  };
}
const hooks = createHooks();

export const MyComponent = () => {
  if (Math.random() < 0.5) {
    return null;
  }
  // ❌ This should fail the linter, but doesn't currently
  const query = hooks.foo.useQuery();

  return <>{query.data}</>;
}

How did you test this change?

Adding some tests to the lint test suite.

@facebook-github-bot
Copy link

Hi @KATT!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@sizebot
Copy link

sizebot commented Aug 8, 2022

Comparing: 17e2a15...a4a90f5

Critical size changes

Includes critical production bundles, as well as any change greater than 2%:

Name +/- Base Current +/- gzip Base gzip Current gzip
oss-stable/react-dom/cjs/react-dom.production.min.js = 134.02 kB 134.02 kB = 42.92 kB 42.92 kB
oss-experimental/react-dom/cjs/react-dom.production.min.js = 139.58 kB 139.58 kB = 44.54 kB 44.54 kB
facebook-www/ReactDOM-prod.classic.js = 474.91 kB 474.91 kB = 84.86 kB 84.86 kB
facebook-www/ReactDOM-prod.modern.js = 460.15 kB 460.15 kB = 82.62 kB 82.62 kB
facebook-www/ReactDOMForked-prod.classic.js = 474.91 kB 474.91 kB = 84.86 kB 84.86 kB

Significant size changes

Includes any change greater than 0.2%:

Expand to show
Name +/- Base Current +/- gzip Base gzip Current gzip
oss-experimental/eslint-plugin-react-hooks/cjs/eslint-plugin-react-hooks.production.min.js +0.30% 25.67 kB 25.74 kB +0.47% 8.79 kB 8.84 kB
oss-stable-semver/eslint-plugin-react-hooks/cjs/eslint-plugin-react-hooks.production.min.js +0.30% 25.67 kB 25.74 kB +0.47% 8.79 kB 8.84 kB
oss-stable/eslint-plugin-react-hooks/cjs/eslint-plugin-react-hooks.production.min.js +0.30% 25.67 kB 25.74 kB +0.47% 8.79 kB 8.84 kB

Generated by 🚫 dangerJS against a4a90f5

Comment on lines +981 to +1002
{
code: `
function createHooks() {
return {
useFoo: () => {
data: 'foo.useQuery'
},
};
}
const hooks = createHooks();

const MyComponent = () => {
if (a) {
return;
}
const query = hooks.useFoo();

return <>{query.data}</>;
}
`,
errors: [conditionalError('hooks.useFoo', true)],
},
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gotten this part to pass

@@ -33,8 +43,7 @@ function isHook(node) {
isHook(node.property)
) {
const obj = node.object;
const isPascalCaseNameSpace = /^[A-Z].*/;
return obj.type === 'Identifier' && isPascalCaseNameSpace.test(obj.name);
return obj.type === 'Identifier' && !nonHookNamespaces.includes(obj.name);
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • I don't think the eslint rule should care if an object is PascalCased or not to decide whether the member is a hook or not.
  • I don't know if having a list of allow-listed namespaces is acceptable, nor if such an alternative then should be configurable.

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

1 similar comment
@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link

This pull request has been automatically marked as stale. If this pull request is still relevant, please leave any comment (for example, "bump"), and we'll keep it open. We are sorry that we haven't been able to prioritize reviewing it yet. Your contribution is very much appreciated.

@github-actions github-actions bot added the Resolution: Stale Automatically closed due to inactivity label Apr 10, 2024
Copy link

Closing this pull request after a prolonged period of inactivity. If this issue is still present in the latest release, please ask for this pull request to be reopened. Thank you!

@github-actions github-actions bot closed this Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Resolution: Stale Automatically closed due to inactivity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants