mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-16 05:04:57 +08:00
222 lines
9.0 KiB
JavaScript
222 lines
9.0 KiB
JavaScript
module.exports = {
|
|
plugins: ["matrix-org"],
|
|
extends: ["plugin:matrix-org/babel", "plugin:matrix-org/react", "plugin:matrix-org/a11y"],
|
|
parserOptions: {
|
|
project: ["./tsconfig.json"],
|
|
},
|
|
env: {
|
|
browser: true,
|
|
node: true,
|
|
},
|
|
globals: {
|
|
LANGUAGES_FILE: "readonly",
|
|
},
|
|
rules: {
|
|
// Things we do that break the ideal style
|
|
"no-constant-condition": "off",
|
|
"prefer-promise-reject-errors": "off",
|
|
"no-async-promise-executor": "off",
|
|
"no-extra-boolean-cast": "off",
|
|
|
|
// 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"],
|
|
|
|
"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.",
|
|
),
|
|
],
|
|
|
|
// 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",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
|
|
// 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",
|
|
"jsx-a11y/tabindex-no-positive": "off",
|
|
|
|
"matrix-org/require-copyright-header": "error",
|
|
},
|
|
overrides: [
|
|
{
|
|
files: ["src/**/*.{ts,tsx}", "test/**/*.{ts,tsx}", "cypress/**/*.ts"],
|
|
extends: ["plugin:matrix-org/typescript", "plugin:matrix-org/react"],
|
|
rules: {
|
|
"@typescript-eslint/explicit-function-return-type": [
|
|
"error",
|
|
{
|
|
allowExpressions: true,
|
|
},
|
|
],
|
|
|
|
// Things we do that break the ideal style
|
|
"prefer-promise-reject-errors": "off",
|
|
"no-extra-boolean-cast": "off",
|
|
|
|
// Remove Babel things manually due to override limitations
|
|
"@babel/no-invalid-this": ["off"],
|
|
|
|
// 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",
|
|
// We're okay with assertion errors when we ask for them
|
|
"@typescript-eslint/no-non-null-assertion": "off",
|
|
},
|
|
},
|
|
// 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",
|
|
},
|
|
},
|
|
{
|
|
files: ["test/**/*.{ts,tsx}", "cypress/**/*.ts"],
|
|
extends: ["plugin:matrix-org/jest"],
|
|
rules: {
|
|
// We don't need super strict typing in test utilities
|
|
"@typescript-eslint/explicit-function-return-type": "off",
|
|
"@typescript-eslint/explicit-member-accessibility": "off",
|
|
|
|
// Jest/Cypress specific
|
|
|
|
// 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",
|
|
// TODO: There are many tests with invalid expects that should be fixed,
|
|
// https://github.com/vector-im/element-web/issues/24709
|
|
"jest/valid-expect": "off",
|
|
// Also treat "oldBackendOnly" as a test function.
|
|
// Used in some crypto tests.
|
|
"jest/no-standalone-expect": [
|
|
"error",
|
|
{
|
|
additionalTestBlockFunctions: ["beforeAll", "beforeEach", "oldBackendOnly"],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
files: ["cypress/**/*.ts"],
|
|
parserOptions: {
|
|
project: ["./cypress/tsconfig.json"],
|
|
},
|
|
rules: {
|
|
// Cypress "promises" work differently - disable some related rules
|
|
"jest/valid-expect-in-promise": "off",
|
|
"jest/no-done-callback": "off",
|
|
},
|
|
},
|
|
],
|
|
settings: {
|
|
react: {
|
|
version: "detect",
|
|
},
|
|
},
|
|
};
|
|
|
|
function buildRestrictedPropertiesOptions(properties, message) {
|
|
return properties.map((prop) => {
|
|
let [object, property] = prop.split(".");
|
|
if (object === "*") {
|
|
object = undefined;
|
|
}
|
|
return {
|
|
object,
|
|
property,
|
|
message,
|
|
};
|
|
});
|
|
}
|