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.

Sign up for GitHub

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

Jump to bottom

Remove require-post-message-target-origin rule from recommended config #1581

Merged
merged 2 commits into from Nov 8, 2021
Merged

Remove require-post-message-target-origin rule from recommended config #1581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87da5ae
Turn of `require-post-message-target-origin` rule in recommended configs
fisker Nov 8, 2021
27729a4
Update require-post-message-target-origin.md
sindresorhus Nov 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 3 additions & 9 deletions configs/recommended.js
View file
Open in desktop
Expand Up @@ -96,18 +96,12 @@ module.exports = {
'unicorn/prevent-abbreviations': 'error',
'unicorn/require-array-join-separator': 'error',
'unicorn/require-number-to-fixed-digits-argument': 'error',
'unicorn/require-post-message-target-origin': 'error',
// Turned off because we can't distinguish `widow.postMessage` and `{Worker,MessagePort,Client,BroadcastChannel}#postMessage()`
// See #1396
'unicorn/require-post-message-target-origin': 'off',
'unicorn/string-content': 'off',
'unicorn/template-indent': 'warn',
'unicorn/throw-new-error': 'error',
...require('./conflicting-rules.js').rules,
},
overrides: [
{
files: ['*.ts', '*.tsx'],
rules: {
'unicorn/require-post-message-target-origin': 'off',
},
},
],
};
2 changes: 2 additions & 0 deletions docs/rules/require-post-message-target-origin.md
View file
Open in desktop
Expand Up @@ -2,6 +2,8 @@

When calling [`window.postMessage()`](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) without the `targetOrigin` argument, the message cannot be received by any window.

This rule cannot distinguish between `window.postMessage()` and other calls like [`Worker#postMessage()`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage), [` MessagePort#postMessage()`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage), [`Client#postMessage()`](https://developer.mozilla.org/en-US/docs/Web/API/Client/postMessage), and [`BroadcastChannel#postMessage()`](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel/postMessage). Use on your own risk.

## Fail

```js
Expand Down
17 changes: 3 additions & 14 deletions readme.md
View file
Open in desktop
Expand Up @@ -125,22 +125,11 @@ Configure it in `package.json`.
"unicorn/prevent-abbreviations": "error",
"unicorn/require-array-join-separator": "error",
"unicorn/require-number-to-fixed-digits-argument": "error",
"unicorn/require-post-message-target-origin": "error",
"unicorn/require-post-message-target-origin": "off",
"unicorn/string-content": "off",
"unicorn/template-indent": "warn",
"unicorn/throw-new-error": "error"
},
"overrides": [
{
"files": [
"*.ts",
"*.tsx"
],
"rules": {
"unicorn/require-post-message-target-origin": "off"
}
}
]
}
}
}
```
Expand Down Expand Up @@ -248,7 +237,7 @@ Each rule has emojis denoting:
| [prevent-abbreviations](docs/rules/prevent-abbreviations.md) | Prevent abbreviations. | ✅ | 🔧 | |
| [require-array-join-separator](docs/rules/require-array-join-separator.md) | Enforce using the separator argument with `Array#join()`. | ✅ | 🔧 | |
| [require-number-to-fixed-digits-argument](docs/rules/require-number-to-fixed-digits-argument.md) | Enforce using the digits argument with `Number#toFixed()`. | ✅ | 🔧 | |
| [require-post-message-target-origin](docs/rules/require-post-message-target-origin.md) | Enforce using the `targetOrigin` argument with `window.postMessage()`. | ✅ | | 💡 |
| [require-post-message-target-origin](docs/rules/require-post-message-target-origin.md) | Enforce using the `targetOrigin` argument with `window.postMessage()`. | | | 💡 |
| [string-content](docs/rules/string-content.md) | Enforce better string content. | | 🔧 | 💡 |
| [template-indent](docs/rules/template-indent.md) | Fix whitespace-insensitive template indentation. | | 🔧 | |
| [throw-new-error](docs/rules/throw-new-error.md) | Require `new` when throwing an error. | ✅ | 🔧 | |
Expand Down