2017-01-20 15:08:14 +01:00
|
|
|
module.exports = {
|
2022-12-12 12:24:14 +01:00
|
|
|
plugins: ["matrix-org"],
|
|
|
|
|
extends: ["plugin:matrix-org/babel", "plugin:matrix-org/react", "plugin:matrix-org/a11y"],
|
2023-02-07 11:08:10 +01:00
|
|
|
parserOptions: {
|
|
|
|
|
project: ["./tsconfig.json"],
|
|
|
|
|
},
|
2017-01-20 15:08:14 +01:00
|
|
|
env: {
|
2020-06-23 17:41:36 +02:00
|
|
|
browser: true,
|
|
|
|
|
node: true,
|
2017-01-20 15:08:14 +01:00
|
|
|
},
|
2020-06-23 17:41:36 +02:00
|
|
|
globals: {
|
|
|
|
|
LANGUAGES_FILE: "readonly",
|
2017-01-20 15:08:14 +01:00
|
|
|
},
|
|
|
|
|
rules: {
|
2020-06-23 17:41:36 +02:00
|
|
|
// Things we do that break the ideal style
|
|
|
|
|
"no-constant-condition": "off",
|
|
|
|
|
"prefer-promise-reject-errors": "off",
|
|
|
|
|
"no-async-promise-executor": "off",
|
2021-04-01 14:17:09 +02:00
|
|
|
"no-extra-boolean-cast": "off",
|
2017-01-20 15:08:14 +01:00
|
|
|
|
2021-04-01 14:17:09 +02: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 15:27:03 +02: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.",
|
|
|
|
|
),
|
2024-06-13 16:15:59 +02:00
|
|
|
...buildRestrictedPropertiesOptions(["window.setImmediate"], "Use setTimeout instead."),
|
|
|
|
|
],
|
|
|
|
|
"no-restricted-globals": [
|
|
|
|
|
"error",
|
|
|
|
|
{
|
|
|
|
|
name: "setImmediate",
|
|
|
|
|
message: "Use setTimeout instead.",
|
|
|
|
|
},
|
2021-06-30 15:27:03 +02:00
|
|
|
],
|
2022-01-03 18:51:58 +01:00
|
|
|
|
2023-08-04 09:36:16 +02:00
|
|
|
"import/no-duplicates": ["error"],
|
2022-03-01 21:42:05 +01:00
|
|
|
// Ban matrix-js-sdk/src imports in favour of matrix-js-sdk/src/matrix imports to prevent unleashing hell.
|
2022-12-12 12:24:14 +01:00
|
|
|
"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",
|
|
|
|
|
},
|
2024-07-04 19:48:07 +02:00
|
|
|
{
|
|
|
|
|
name: "emojibase-regex",
|
|
|
|
|
message:
|
|
|
|
|
"This regex doesn't actually test for emoji. See the docs at https://emojibase.dev/docs/regex/ and prefer our own EMOJI_REGEX from HtmlUtils.",
|
|
|
|
|
},
|
2022-12-12 12:24:14 +01:00
|
|
|
],
|
|
|
|
|
patterns: [
|
|
|
|
|
{
|
2023-08-15 17:00:17 +02:00
|
|
|
group: [
|
|
|
|
|
"matrix-js-sdk/src/**",
|
|
|
|
|
"!matrix-js-sdk/src/matrix",
|
2024-03-22 13:28:13 +01:00
|
|
|
"!matrix-js-sdk/src/crypto-api",
|
2024-03-11 10:30:00 +01:00
|
|
|
"!matrix-js-sdk/src/types",
|
2024-03-22 16:48:29 +01:00
|
|
|
"!matrix-js-sdk/src/testing",
|
2024-10-01 16:12:46 +02:00
|
|
|
"!matrix-js-sdk/src/utils/**",
|
|
|
|
|
"matrix-js-sdk/src/utils/internal/**",
|
2023-08-15 17:00:17 +02:00
|
|
|
"matrix-js-sdk/lib",
|
|
|
|
|
"matrix-js-sdk/lib/",
|
|
|
|
|
"matrix-js-sdk/lib/**",
|
|
|
|
|
// XXX: Temporarily allow these as they are not available via the main export
|
|
|
|
|
"!matrix-js-sdk/src/logger",
|
|
|
|
|
"!matrix-js-sdk/src/errors",
|
|
|
|
|
"!matrix-js-sdk/src/utils",
|
|
|
|
|
"!matrix-js-sdk/src/version-support",
|
|
|
|
|
"!matrix-js-sdk/src/randomstring",
|
|
|
|
|
"!matrix-js-sdk/src/sliding-sync",
|
|
|
|
|
"!matrix-js-sdk/src/browser-index",
|
|
|
|
|
"!matrix-js-sdk/src/feature",
|
|
|
|
|
"!matrix-js-sdk/src/NamespacedValue",
|
|
|
|
|
"!matrix-js-sdk/src/ReEmitter",
|
|
|
|
|
"!matrix-js-sdk/src/event-mapper",
|
|
|
|
|
"!matrix-js-sdk/src/interactive-auth",
|
|
|
|
|
"!matrix-js-sdk/src/secret-storage",
|
|
|
|
|
"!matrix-js-sdk/src/room-hierarchy",
|
|
|
|
|
"!matrix-js-sdk/src/rendezvous",
|
|
|
|
|
"!matrix-js-sdk/src/indexeddb-worker",
|
|
|
|
|
"!matrix-js-sdk/src/pushprocessor",
|
|
|
|
|
"!matrix-js-sdk/src/extensible_events_v1",
|
|
|
|
|
"!matrix-js-sdk/src/extensible_events_v1/PollStartEvent",
|
|
|
|
|
"!matrix-js-sdk/src/extensible_events_v1/PollResponseEvent",
|
|
|
|
|
"!matrix-js-sdk/src/extensible_events_v1/PollEndEvent",
|
|
|
|
|
"!matrix-js-sdk/src/extensible_events_v1/InvalidEventError",
|
|
|
|
|
"!matrix-js-sdk/src/crypto",
|
|
|
|
|
"!matrix-js-sdk/src/crypto/keybackup",
|
|
|
|
|
"!matrix-js-sdk/src/crypto/deviceinfo",
|
|
|
|
|
"!matrix-js-sdk/src/crypto/dehydration",
|
|
|
|
|
"!matrix-js-sdk/src/oidc",
|
|
|
|
|
"!matrix-js-sdk/src/oidc/discovery",
|
|
|
|
|
"!matrix-js-sdk/src/oidc/authorize",
|
|
|
|
|
"!matrix-js-sdk/src/oidc/validate",
|
|
|
|
|
"!matrix-js-sdk/src/oidc/error",
|
|
|
|
|
"!matrix-js-sdk/src/oidc/register",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc/call",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc/callFeed",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc/mediaHandler",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc/callEventTypes",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc/callEventHandler",
|
|
|
|
|
"!matrix-js-sdk/src/webrtc/groupCallEventHandler",
|
|
|
|
|
"!matrix-js-sdk/src/models",
|
|
|
|
|
"!matrix-js-sdk/src/models/read-receipt",
|
|
|
|
|
"!matrix-js-sdk/src/models/relations-container",
|
|
|
|
|
"!matrix-js-sdk/src/models/related-relations",
|
2024-07-25 14:49:41 +02:00
|
|
|
"!matrix-js-sdk/src/matrixrtc",
|
2023-08-15 17:00:17 +02:00
|
|
|
],
|
|
|
|
|
message: "Please use matrix-js-sdk/src/matrix instead",
|
2022-12-12 12:24:14 +01:00
|
|
|
},
|
2024-07-04 19:48:07 +02:00
|
|
|
{
|
|
|
|
|
group: ["emojibase-regex/emoji*"],
|
|
|
|
|
message:
|
|
|
|
|
"This regex doesn't actually test for emoji. See the docs at https://emojibase.dev/docs/regex/ and prefer our own EMOJI_REGEX from HtmlUtils.",
|
|
|
|
|
},
|
2022-12-12 12:24:14 +01:00
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
],
|
2022-03-01 21:42:05 +01:00
|
|
|
|
2022-01-03 18:51:58 +01:00
|
|
|
// There are too many a11y violations to fix at once
|
|
|
|
|
// Turn violated rules off until they are fixed
|
|
|
|
|
"jsx-a11y/aria-activedescendant-has-tabindex": "off",
|
|
|
|
|
"jsx-a11y/click-events-have-key-events": "off",
|
|
|
|
|
"jsx-a11y/interactive-supports-focus": "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",
|
2022-05-06 11:09:28 +02:00
|
|
|
|
|
|
|
|
"matrix-org/require-copyright-header": "error",
|
2021-04-01 14:17:09 +02:00
|
|
|
},
|
2022-03-03 18:51:38 +01:00
|
|
|
overrides: [
|
|
|
|
|
{
|
2024-01-16 10:48:49 +01:00
|
|
|
files: ["src/**/*.{ts,tsx}", "test/**/*.{ts,tsx}", "playwright/**/*.ts"],
|
2022-12-12 12:24:14 +01:00
|
|
|
extends: ["plugin:matrix-org/typescript", "plugin:matrix-org/react"],
|
2022-03-03 18:51:38 +01:00
|
|
|
rules: {
|
2023-01-12 14:25:14 +01:00
|
|
|
"@typescript-eslint/explicit-function-return-type": [
|
|
|
|
|
"error",
|
|
|
|
|
{
|
|
|
|
|
allowExpressions: true,
|
|
|
|
|
},
|
|
|
|
|
],
|
2022-12-09 14:31:56 +01:00
|
|
|
|
2022-03-03 18:51:38 +01:00
|
|
|
// Things we do that break the ideal style
|
|
|
|
|
"prefer-promise-reject-errors": "off",
|
|
|
|
|
"no-extra-boolean-cast": "off",
|
2021-04-01 14:17:09 +02:00
|
|
|
|
2022-03-03 18:51:38 +01:00
|
|
|
// Remove Babel things manually due to override limitations
|
|
|
|
|
"@babel/no-invalid-this": ["off"],
|
2021-06-29 14:35:43 +02:00
|
|
|
|
2022-03-03 18:51:38 +01: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 08:21:55 +02:00
|
|
|
// We're okay with assertion errors when we ask for them
|
|
|
|
|
"@typescript-eslint/no-non-null-assertion": "off",
|
2022-03-03 18:51:38 +01:00
|
|
|
},
|
2020-07-29 13:00:42 +02:00
|
|
|
},
|
2022-03-03 18:51:38 +01: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",
|
2022-12-12 12:24:14 +01:00
|
|
|
"src/components/views/settings/tabs/user/GeneralUserSettingsTab.tsx",
|
2022-03-03 18:51:38 +01:00
|
|
|
],
|
|
|
|
|
rules: {
|
|
|
|
|
"@typescript-eslint/no-var-requires": "off",
|
|
|
|
|
},
|
2022-12-12 12:24:14 +01:00
|
|
|
},
|
2022-12-16 13:29:59 +01:00
|
|
|
{
|
2024-01-16 10:48:49 +01:00
|
|
|
files: ["test/**/*.{ts,tsx}", "playwright/**/*.ts"],
|
2023-03-01 16:23:35 +01:00
|
|
|
extends: ["plugin:matrix-org/jest"],
|
2022-12-16 13:29:59 +01:00
|
|
|
rules: {
|
|
|
|
|
// We don't need super strict typing in test utilities
|
|
|
|
|
"@typescript-eslint/explicit-function-return-type": "off",
|
|
|
|
|
"@typescript-eslint/explicit-member-accessibility": "off",
|
2023-03-01 16:23:35 +01:00
|
|
|
|
2024-01-16 10:48:49 +01:00
|
|
|
// Jest/Playwright specific
|
2023-03-01 16:23:35 +01:00
|
|
|
|
|
|
|
|
// Disabled tests are a reality for now but as soon as all of the xits are
|
|
|
|
|
// eliminated, we should enforce this.
|
|
|
|
|
"jest/no-disabled-tests": "off",
|
|
|
|
|
// Also treat "oldBackendOnly" as a test function.
|
|
|
|
|
// Used in some crypto tests.
|
|
|
|
|
"jest/no-standalone-expect": [
|
|
|
|
|
"error",
|
|
|
|
|
{
|
|
|
|
|
additionalTestBlockFunctions: ["beforeAll", "beforeEach", "oldBackendOnly"],
|
|
|
|
|
},
|
|
|
|
|
],
|
2022-12-16 13:29:59 +01:00
|
|
|
},
|
|
|
|
|
},
|
2023-11-21 18:33:32 +01:00
|
|
|
{
|
|
|
|
|
files: ["playwright/**/*.ts"],
|
|
|
|
|
parserOptions: {
|
|
|
|
|
project: ["./playwright/tsconfig.json"],
|
|
|
|
|
},
|
|
|
|
|
},
|
2022-03-03 18:51:38 +01:00
|
|
|
],
|
2021-08-25 10:36:35 +02:00
|
|
|
settings: {
|
|
|
|
|
react: {
|
|
|
|
|
version: "detect",
|
2021-10-23 00:21:46 +02:00
|
|
|
},
|
|
|
|
|
},
|
2017-01-20 15:08:14 +01:00
|
|
|
};
|
2021-05-25 11:25:36 +02:00
|
|
|
|
|
|
|
|
function buildRestrictedPropertiesOptions(properties, message) {
|
2022-12-12 12:24:14 +01:00
|
|
|
return properties.map((prop) => {
|
2021-06-30 15:19:39 +02:00
|
|
|
let [object, property] = prop.split(".");
|
|
|
|
|
if (object === "*") {
|
|
|
|
|
object = undefined;
|
|
|
|
|
}
|
2021-05-25 11:25:36 +02:00
|
|
|
return {
|
|
|
|
|
object,
|
|
|
|
|
property,
|
|
|
|
|
message,
|
|
|
|
|
};
|
|
|
|
|
});
|
|
|
|
|
}
|
