2017-01-20 14:08:14 +00:00
|
|
|
module.exports = {
|
2022-01-03 17:51:58 +00:00
|
|
|
plugins: [
|
|
|
|
"matrix-org",
|
|
|
|
],
|
2021-04-01 12:17:09 +00:00
|
|
|
extends: [
|
2021-06-29 12:18:58 +00:00
|
|
|
"plugin:matrix-org/babel",
|
2021-04-01 12:17:09 +00:00
|
|
|
"plugin:matrix-org/react",
|
2022-01-03 17:51:58 +00:00
|
|
|
"plugin:matrix-org/a11y",
|
2021-04-01 12:17:09 +00:00
|
|
|
],
|
2017-01-20 14:08:14 +00:00
|
|
|
env: {
|
2020-06-23 15:41:36 +00:00
|
|
|
browser: true,
|
|
|
|
node: true,
|
2017-01-20 14:08:14 +00:00
|
|
|
},
|
2020-06-23 15:41:36 +00:00
|
|
|
globals: {
|
|
|
|
LANGUAGES_FILE: "readonly",
|
2017-01-20 14:08:14 +00:00
|
|
|
},
|
|
|
|
rules: {
|
2020-06-23 15:41:36 +00:00
|
|
|
// Things we do that break the ideal style
|
|
|
|
"no-constant-condition": "off",
|
|
|
|
"prefer-promise-reject-errors": "off",
|
|
|
|
"no-async-promise-executor": "off",
|
|
|
|
"quotes": "off",
|
2021-04-01 12:17:09 +00:00
|
|
|
"no-extra-boolean-cast": "off",
|
2017-01-20 14:08:14 +00:00
|
|
|
|
2021-04-01 12:17:09 +00:00
|
|
|
// Bind or arrow functions in props causes performance issues (but we
|
|
|
|
// currently use them in some places).
|
|
|
|
// It's disabled here, but we should using it sparingly.
|
|
|
|
"react/jsx-no-bind": "off",
|
|
|
|
"react/jsx-key": ["error"],
|
2021-06-30 13:27:03 +00:00
|
|
|
|
|
|
|
"no-restricted-properties": [
|
|
|
|
"error",
|
|
|
|
...buildRestrictedPropertiesOptions(
|
|
|
|
["window.innerHeight", "window.innerWidth", "window.visualViewport"],
|
|
|
|
"Use UIStore to access window dimensions instead.",
|
|
|
|
),
|
|
|
|
...buildRestrictedPropertiesOptions(
|
|
|
|
["*.mxcUrlToHttp", "*.getHttpUriForMxc"],
|
|
|
|
"Use Media helper instead to centralise access for customisation.",
|
|
|
|
),
|
|
|
|
],
|
2022-01-03 17:51:58 +00:00
|
|
|
|
2022-03-01 20:42:05 +00:00
|
|
|
// Ban matrix-js-sdk/src imports in favour of matrix-js-sdk/src/matrix imports to prevent unleashing hell.
|
|
|
|
"no-restricted-imports": ["error", {
|
|
|
|
"paths": [{
|
|
|
|
"name": "matrix-js-sdk",
|
|
|
|
"message": "Please use matrix-js-sdk/src/matrix instead",
|
|
|
|
}, {
|
|
|
|
"name": "matrix-js-sdk/",
|
|
|
|
"message": "Please use matrix-js-sdk/src/matrix instead",
|
|
|
|
}, {
|
|
|
|
"name": "matrix-js-sdk/src",
|
|
|
|
"message": "Please use matrix-js-sdk/src/matrix instead",
|
|
|
|
}, {
|
|
|
|
"name": "matrix-js-sdk/src/",
|
|
|
|
"message": "Please use matrix-js-sdk/src/matrix instead",
|
|
|
|
}, {
|
|
|
|
"name": "matrix-js-sdk/src/index",
|
|
|
|
"message": "Please use matrix-js-sdk/src/matrix instead",
|
|
|
|
}, {
|
|
|
|
"name": "matrix-react-sdk",
|
|
|
|
"message": "Please use matrix-react-sdk/src/index instead",
|
|
|
|
}, {
|
|
|
|
"name": "matrix-react-sdk/",
|
|
|
|
"message": "Please use matrix-react-sdk/src/index instead",
|
|
|
|
}],
|
|
|
|
"patterns": [{
|
|
|
|
"group": ["matrix-js-sdk/lib", "matrix-js-sdk/lib/", "matrix-js-sdk/lib/**"],
|
|
|
|
"message": "Please use matrix-js-sdk/src/* instead",
|
|
|
|
}],
|
|
|
|
}],
|
|
|
|
|
2022-01-03 17:51:58 +00:00
|
|
|
// There are too many a11y violations to fix at once
|
|
|
|
// Turn violated rules off until they are fixed
|
|
|
|
"jsx-a11y/alt-text": "off",
|
|
|
|
"jsx-a11y/aria-activedescendant-has-tabindex": "off",
|
|
|
|
"jsx-a11y/click-events-have-key-events": "off",
|
|
|
|
"jsx-a11y/interactive-supports-focus": "off",
|
|
|
|
"jsx-a11y/label-has-associated-control": "off",
|
|
|
|
"jsx-a11y/media-has-caption": "off",
|
|
|
|
"jsx-a11y/mouse-events-have-key-events": "off",
|
|
|
|
"jsx-a11y/no-autofocus": "off",
|
|
|
|
"jsx-a11y/no-noninteractive-element-interactions": "off",
|
|
|
|
"jsx-a11y/no-noninteractive-element-to-interactive-role": "off",
|
|
|
|
"jsx-a11y/no-noninteractive-tabindex": "off",
|
|
|
|
"jsx-a11y/no-static-element-interactions": "off",
|
|
|
|
"jsx-a11y/role-supports-aria-props": "off",
|
|
|
|
"jsx-a11y/tabindex-no-positive": "off",
|
2022-05-06 09:09:28 +00:00
|
|
|
|
|
|
|
"matrix-org/require-copyright-header": "error",
|
2021-04-01 12:17:09 +00:00
|
|
|
},
|
2022-03-03 17:51:38 +00:00
|
|
|
overrides: [
|
|
|
|
{
|
|
|
|
files: [
|
|
|
|
"src/**/*.{ts,tsx}",
|
|
|
|
"test/**/*.{ts,tsx}",
|
2022-04-14 09:41:58 +00:00
|
|
|
"cypress/**/*.ts",
|
2022-03-03 17:51:38 +00:00
|
|
|
],
|
|
|
|
extends: [
|
|
|
|
"plugin:matrix-org/typescript",
|
|
|
|
"plugin:matrix-org/react",
|
|
|
|
],
|
|
|
|
rules: {
|
|
|
|
// Things we do that break the ideal style
|
|
|
|
"prefer-promise-reject-errors": "off",
|
|
|
|
"quotes": "off",
|
|
|
|
"no-extra-boolean-cast": "off",
|
2021-04-01 12:17:09 +00:00
|
|
|
|
2022-03-03 17:51:38 +00:00
|
|
|
// Remove Babel things manually due to override limitations
|
|
|
|
"@babel/no-invalid-this": ["off"],
|
2021-06-29 12:35:43 +00:00
|
|
|
|
2022-03-03 17:51:38 +00:00
|
|
|
// We're okay being explicit at the moment
|
|
|
|
"@typescript-eslint/no-empty-interface": "off",
|
|
|
|
// We disable this while we're transitioning
|
|
|
|
"@typescript-eslint/no-explicit-any": "off",
|
|
|
|
// We'd rather not do this but we do
|
|
|
|
"@typescript-eslint/ban-ts-comment": "off",
|
2022-05-30 06:21:55 +00:00
|
|
|
// We're okay with assertion errors when we ask for them
|
|
|
|
"@typescript-eslint/no-non-null-assertion": "off",
|
2022-08-30 19:13:39 +00:00
|
|
|
|
|
|
|
// The non-TypeScript rule produces false positives
|
|
|
|
"func-call-spacing": "off",
|
|
|
|
"@typescript-eslint/func-call-spacing": ["error"],
|
2022-03-03 17:51:38 +00:00
|
|
|
},
|
2020-07-29 11:00:42 +00:00
|
|
|
},
|
2022-03-03 17:51:38 +00:00
|
|
|
// temporary override for offending icon require files
|
|
|
|
{
|
|
|
|
files: [
|
|
|
|
"src/SdkConfig.ts",
|
|
|
|
"src/components/structures/FileDropTarget.tsx",
|
|
|
|
"src/components/structures/RoomStatusBar.tsx",
|
|
|
|
"src/components/structures/UserMenu.tsx",
|
|
|
|
"src/components/views/avatars/WidgetAvatar.tsx",
|
|
|
|
"src/components/views/dialogs/AddExistingToSpaceDialog.tsx",
|
|
|
|
"src/components/views/dialogs/ForwardDialog.tsx",
|
|
|
|
"src/components/views/dialogs/InviteDialog.tsx",
|
|
|
|
"src/components/views/dialogs/ModalWidgetDialog.tsx",
|
|
|
|
"src/components/views/dialogs/UploadConfirmDialog.tsx",
|
|
|
|
"src/components/views/dialogs/security/SetupEncryptionDialog.tsx",
|
|
|
|
"src/components/views/elements/AddressTile.tsx",
|
|
|
|
"src/components/views/elements/AppWarning.tsx",
|
|
|
|
"src/components/views/elements/SSOButtons.tsx",
|
|
|
|
"src/components/views/messages/MAudioBody.tsx",
|
|
|
|
"src/components/views/messages/MImageBody.tsx",
|
|
|
|
"src/components/views/messages/MFileBody.tsx",
|
|
|
|
"src/components/views/messages/MStickerBody.tsx",
|
|
|
|
"src/components/views/messages/MVideoBody.tsx",
|
|
|
|
"src/components/views/messages/MVoiceMessageBody.tsx",
|
|
|
|
"src/components/views/right_panel/EncryptionPanel.tsx",
|
|
|
|
"src/components/views/rooms/EntityTile.tsx",
|
|
|
|
"src/components/views/rooms/LinkPreviewGroup.tsx",
|
|
|
|
"src/components/views/rooms/MemberList.tsx",
|
|
|
|
"src/components/views/rooms/MessageComposer.tsx",
|
|
|
|
"src/components/views/rooms/ReplyPreview.tsx",
|
|
|
|
"src/components/views/settings/tabs/room/SecurityRoomSettingsTab.tsx",
|
|
|
|
"src/components/views/settings/tabs/user/GeneralUserSettingsTab.tsx"
|
|
|
|
],
|
|
|
|
rules: {
|
|
|
|
"@typescript-eslint/no-var-requires": "off",
|
|
|
|
},
|
|
|
|
}
|
|
|
|
],
|
2021-08-25 08:36:35 +00:00
|
|
|
settings: {
|
|
|
|
react: {
|
|
|
|
version: "detect",
|
2021-10-22 22:21:46 +00:00
|
|
|
},
|
|
|
|
},
|
2017-01-20 14:08:14 +00:00
|
|
|
};
|
2021-05-25 09:25:36 +00:00
|
|
|
|
|
|
|
function buildRestrictedPropertiesOptions(properties, message) {
|
|
|
|
return properties.map(prop => {
|
2021-06-30 13:19:39 +00:00
|
|
|
let [object, property] = prop.split(".");
|
|
|
|
if (object === "*") {
|
|
|
|
object = undefined;
|
|
|
|
}
|
2021-05-25 09:25:36 +00:00
|
|
|
return {
|
|
|
|
object,
|
|
|
|
property,
|
|
|
|
message,
|
|
|
|
};
|
|
|
|
});
|
|
|
|
}
|