New rule 'no unsupported Node APIs in SSR-able components' #167
Conversation
docs/rules/no-unguarded-risky-node-api-in-ssrable-components.md
Outdated
Show resolved
Hide resolved
docs/rules/no-unguarded-risky-node-api-in-ssrable-components.md
Outdated
Show resolved
Hide resolved
| if (import.meta.env.SSR) { | ||
| // Risky Node API call within SSR context | ||
| fs.writeFileSync('file.txt', 'data'); | ||
| } |
There was a problem hiding this comment.
| if (import.meta.env.SSR) { | |
| // Risky Node API call within SSR context | |
| fs.writeFileSync('file.txt', 'data'); | |
| } | |
| // Unsupported Node API call | |
| fs.writeFileSync('file.txt', 'data'); |
| ```js | ||
| if (import.meta.env.SSR) { | ||
| try { | ||
| // Safe guarded call | ||
| require('something'); | ||
| } catch (e) { | ||
| // Handle error | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
| ```js | |
| if (import.meta.env.SSR) { | |
| try { | |
| // Safe guarded call | |
| require('something'); | |
| } catch (e) { | |
| // Handle error | |
| } | |
| } | |
| ``` | |
| ```js | |
| // Do not use Node APIs |
Shinoni
changed the title
Co-authored-by: Laura <49494194+lpomerleau@users.noreply.github.com>
README.md
Outdated
| | [lwc/no-template-children](./docs/rules/no-template-children.md) | prevent accessing the immediate children of this.template | | | ||
| | [lwc/no-leaky-event-listeners](./docs/rules/no-leaky-event-listeners.md) | prevent event listeners from leaking memory | | | ||
| | [lwc/prefer-custom-event](./docs/rules/prefer-custom-event.md) | suggest usage of `CustomEvent` over `Event` constructor | | | ||
| | [lwc/no-unsupported-node-api-in-ssrable-components](./docs/rules/no-unsupported-node-api-in-ssrable-components.md) | disallow unsupported Node API calls in SSR-able components | | |
There was a problem hiding this comment.
| | [lwc/no-unsupported-node-api-in-ssrable-components](./docs/rules/no-unsupported-node-api-in-ssrable-components.md) | disallow unsupported Node API calls in SSR-able components | | | |
| | [lwc/ssr/no-unsupported-node-api](./docs/rules/no-unsupported-node-api-in-ssrable-components.md) | disallow unsupported Node API calls in SSR-able components | | |
Feedback from @wjhsf
In the eslint plugin, there’s currently no consistency in the SSR rule names:
lwc/no-restricted-browser-globals-during-ssrlwc/no-unsupported-ssr-propertieslwc/no-node-env-in-ssrlwc/no-unsuppoted-node-api-in-ssrable-componentslwc/no-unguarded-async-event-in-ssrlwc/no-form-factor-in-ssrable-componentslwc/no-static-imports-of-user-specific-scoped-modules-in-ssrable-components
To have a more consistent naming convention (and terser names), please change all of them to the format lwc/ssr/*.
For rule and doc files names, Either "ssr/" or "ssr-" is probably fine. It depends on what eslint complains about, since it likes things to match the rule names.
For the few older ones that have already been published, we could either do a rename and release a major, or we could keep the old ones as aliases, but mark them as deprecated.
There was a problem hiding this comment.
Sure. I'll rename them.
There was a problem hiding this comment.
I renamed all references to the rule by prepending 'ssr-'.
| @@ -0,0 +1,28 @@ | |||
| # Disallow Node API Calls in SSR Context (`lwc/no-unsupported-node-api-in-ssrable-components`) | |||
There was a problem hiding this comment.
| # Disallow Node API Calls in SSR Context (`lwc/no-unsupported-node-api-in-ssrable-components`) | |
| # Disallow Node API Calls in SSR Context (`lwc/ssr/no-unsupported-node-api`) |
There was a problem hiding this comment.
@lpomerleau , we can't modify the path to a rule without altering the framework, but we can rename a rule by adding the prefix 'ssr-'.
No description provided.