feat: add no-disallowed-lwc-imports rule #85
Conversation
|
|
||
| ```js | ||
| export * from 'lwc'; | ||
| ``` |
There was a problem hiding this comment.
Incidentally, our current Babel validator allows export * from 'lwc' and export * as foo from 'lwc'. This rule fixes that.
|
|
||
| // From "@lwc/engine-server" | ||
| 'renderComponent', | ||
| ]); |
There was a problem hiding this comment.
This is based on our current list.
| import { LightningElement, wire, api } from 'lwc'; | ||
| ``` | ||
|
|
||
| If you disable this rule, then you may import unstable or otherwise undesirable APIs from `lwc`. |
There was a problem hiding this comment.
Shall we make this rule configurable to allow importing unstable API? Maybe it's something we can include in the future if needed.
{
rules: {
'no-disallowed-lwc-imports': ["error", { allowUnstable: true }]
}
}or:
{
rules: {
'no-disallowed-lwc-imports': ["error", { allow: ['swapComponent'] }]
}
}There was a problem hiding this comment.
This seems unnecessary to me. People who want to use unstable imports can disable the rule entirely.
The value-add of the other things that the rule checks is low IMO. Everything else that it checks for (e.g. import nonexistentDefault from 'lwc') will also throw an error either by Rollup or at runtime.
Co-authored-by: Pierre-Marie Dartus <[email protected]>
Co-authored-by: Pierre-Marie Dartus <[email protected]>
| import { LightningElement, wire, api } from 'lwc'; | ||
| ``` | ||
|
|
||
| If you disable this rule, then you may import unstable or otherwise undesirable APIs from `lwc`. |
|
Delaying until CLCO |
Co-authored-by: Pierre-Marie Dartus <[email protected]>
Co-authored-by: Pierre-Marie Dartus <[email protected]>
| { | ||
| code: `export {} from "some-other-package"`, | ||
| }, | ||
| ]; |
There was a problem hiding this comment.
Add a testcase for export { LightningElement as default } from "lwc";
|
@jodarove Are we good to merge this PR and salesforce/lwc#1284 to master? |
|
yes @nolanlawson |
Fixes: salesforce/lwc#1284 and W-10151021
Adds a rule to disallow restricted APIs from the
lwcpackage.