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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: publish eslint rules to help promote better Fbt API usage practices #329

Open
kayhadrin opened this issue Jan 20, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@kayhadrin
Copy link
Collaborator

馃殌 Feature Proposal: publish fbt eslint rules

Following #327 (from @alexandernanberg), we should expose a bunch of our internal eslint rules to help developers use the Fbt API properly.

Motivation

Across a large UI app, it's important to ensure that all strings are localized.
Having some eslint rules to help spot easy issues would help drive adoption, quality & consistency in a project's codebase.

Here are some of the eslint rules we have implemented internally:

  • enforce-fbt-project.js
    Force users to specify an fbt project name at the callsite or file header level
  • fbt-common-strings.js
    Recommend users to use fbt.c() / <fbt common={true}> whenever they are redefining an existing common word. E.g. Facebook
  • fbt-empty-string.js
    Prevent users from writing empty strings. E.g. fbt(''), <fbt></fbt>
  • fbt-no-unwrapped-strings.js
    Prevent users from assigning plain strings to HTML element children/attributes (in a React app context).
    NOTE: this is similar to what you just implemented.
  • fbt-unhelpful-desc.js
    Prevent writing descriptions that are a duplicate of the text, or just too short.
  • fbt-unregistered-project.js
    Prevent defining fbt project names are have not been created in our backend yet.
  • no-capital-fbt.js
    Recommends using <fbt> instead of <Fbt>

They've not yet been exported to the OSS community yet, but we'd welcome a motivated contributor to port them to the OSS community.

The fbt eslint rules could be defined in this repo as more yarn workspaces, and published as new npm packages.

@kayhadrin kayhadrin added the enhancement New feature or request label Jan 20, 2022
@alexandernanberg
Copy link
Contributor

I'd be happy to give away the eslint-plugin-fbt name on npm when/if this happens!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants