Matrix/element-web-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2024-11-16 21:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
2cae2be909
element-web-Github/.eslintrc.js

179 lines
7.1 KiB
JavaScript
Raw Normal View History

Use eslint config from the js sdk Extend the js sdk's eslint config to give as consistent a code style as possible. Add react/jsx/flow stuff that we use here.
2017-01-20 22:08:14 +08:00
module.exports = {
Add jsx-a11y eslint plugin (#7434) * add matrix-org a11y eslint plgin Signed-off-by: Kerry Archibald <kerrya@element.io> * add eslint a11y, enable and fix anchor-has-content rule Signed-off-by: Kerry Archibald <kerrya@element.io> * enable and fix jsx-a11y/no-redundant-roles Signed-off-by: Kerry Archibald <kerrya@element.io> * remove debug Signed-off-by: Kerry Archibald <kerrya@element.io> * i18n Signed-off-by: Kerry Archibald <kerrya@element.io> * use jsx-a11y via matrix-org-eslint Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-04 01:51:58 +08:00
plugins: [
"matrix-org",
],
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08:00
extends: [
Switch to newer Babel specific config
2021-06-29 20:18:58 +08:00
"plugin:matrix-org/babel",
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08:00
"plugin:matrix-org/react",
Add jsx-a11y eslint plugin (#7434) * add matrix-org a11y eslint plgin Signed-off-by: Kerry Archibald <kerrya@element.io> * add eslint a11y, enable and fix anchor-has-content rule Signed-off-by: Kerry Archibald <kerrya@element.io> * enable and fix jsx-a11y/no-redundant-roles Signed-off-by: Kerry Archibald <kerrya@element.io> * remove debug Signed-off-by: Kerry Archibald <kerrya@element.io> * i18n Signed-off-by: Kerry Archibald <kerrya@element.io> * use jsx-a11y via matrix-org-eslint Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-04 01:51:58 +08:00
"plugin:matrix-org/a11y",
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08:00
],
Use eslint config from the js sdk Extend the js sdk's eslint config to give as consistent a code style as possible. Add react/jsx/flow stuff that we use here.
2017-01-20 22:08:14 +08:00
env: {
Use new eslint package- fix lint issues in ts and js
2020-06-23 23:41:36 +08:00
browser: true,
node: true,
Use eslint config from the js sdk Extend the js sdk's eslint config to give as consistent a code style as possible. Add react/jsx/flow stuff that we use here.
2017-01-20 22:08:14 +08:00
},
Use new eslint package- fix lint issues in ts and js
2020-06-23 23:41:36 +08:00
globals: {
LANGUAGES_FILE: "readonly",
Use eslint config from the js sdk Extend the js sdk's eslint config to give as consistent a code style as possible. Add react/jsx/flow stuff that we use here.
2017-01-20 22:08:14 +08:00
},
rules: {
Use new eslint package- fix lint issues in ts and js
2020-06-23 23:41:36 +08: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",
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08:00
"no-extra-boolean-cast": "off",
Use eslint config from the js sdk Extend the js sdk's eslint config to give as consistent a code style as possible. Add react/jsx/flow stuff that we use here.
2017-01-20 22:08:14 +08:00
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08: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"],
Apply restricted property rules to all files
2021-06-30 21:27:03 +08: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.",
),
],
Add jsx-a11y eslint plugin (#7434) * add matrix-org a11y eslint plgin Signed-off-by: Kerry Archibald <kerrya@element.io> * add eslint a11y, enable and fix anchor-has-content rule Signed-off-by: Kerry Archibald <kerrya@element.io> * enable and fix jsx-a11y/no-redundant-roles Signed-off-by: Kerry Archibald <kerrya@element.io> * remove debug Signed-off-by: Kerry Archibald <kerrya@element.io> * i18n Signed-off-by: Kerry Archibald <kerrya@element.io> * use jsx-a11y via matrix-org-eslint Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-04 01:51:58 +08:00
Mandate use of js-sdk/src/matrix import over js-sdk/src (#7933)
2022-03-02 04:42:05 +08: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",
}],
}],
Add jsx-a11y eslint plugin (#7434) * add matrix-org a11y eslint plgin Signed-off-by: Kerry Archibald <kerrya@element.io> * add eslint a11y, enable and fix anchor-has-content rule Signed-off-by: Kerry Archibald <kerrya@element.io> * enable and fix jsx-a11y/no-redundant-roles Signed-off-by: Kerry Archibald <kerrya@element.io> * remove debug Signed-off-by: Kerry Archibald <kerrya@element.io> * i18n Signed-off-by: Kerry Archibald <kerrya@element.io> * use jsx-a11y via matrix-org-eslint Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-01-04 01:51:58 +08: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",
Eslint - require copyright header rule (#8514) * bump eslint plugin to 0.5.2 Signed-off-by: Kerry Archibald <kerrya@element.io> * add rule Signed-off-by: Kerry Archibald <kerrya@element.io> * add missing copyright headers Signed-off-by: Kerry Archibald <kerrya@element.io> * fix comment order Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-05-06 17:09:28 +08:00
"matrix-org/require-copyright-header": "error",
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08:00
},
Revert "replace all require(.svg) with esm import" (#7969) * Revert "replace all require(svgs) with esm import (#7948)" This reverts commit 61cd463a3b57917d9206c98e6e75fc5b57033102. * add .default to svg icon inline requires Signed-off-by: Kerry Archibald <kerrya@element.io> * add shameful eslint ignore Signed-off-by: Kerry Archibald <kerrya@element.io> * format eslintrc Signed-off-by: Kerry Archibald <kerrya@element.io> * add missed MFileBody change Signed-off-by: Kerry Archibald <kerrya@element.io> * one more broken svg Signed-off-by: Kerry Archibald <kerrya@element.io> * and ignore it Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-04 01:51:38 +08:00
overrides: [
{
files: [
"src/**/*.{ts,tsx}",
"test/**/*.{ts,tsx}",
Add a Cypress Test 🌲 (#8295) * A first, maybe working cypress test Plus cypress plugins to manage synapses in docker containers * Fix yaml * This file is important * try & find where it's put the artifact * Download artifact to a directory * pics or it didn't happen * Add conditional, otherwise no artifacts on failure... * Try increasing timeout also actually give the test a name * Try in chrome * Get docker logs to see why it's failing also document the chrome setting * Try changing mode on homeserver.yaml * debug * More debugging * more file permissions debugging * ARGH * more debug * sigh * Eugh, that's not how arguments work * Add the option to really allow open registration and remove debug logging / comment fixes * failure to yaml * Upload docker logs as artifacts and temporarily remove contional to test * Put the conditional back * Upgrade types in end to end tests to be compatible with fs-extra types * Try reducing timeout a bit also make password more... sensible * Hex is not octal * Remove file mode Seems to be unnecessary since the signing key is perfectly fine * Give the log files extensions * Rename workflow file now it also does tests * Add cypress scripts * copyright headers * Use ? operator Co-authored-by: Travis Ralston <travisr@matrix.org> * Use develop synapse image * Tidy up any remaining synapses after each spec run Also: * Move the synapseStart / synapseStop functions out to the top level so they can be reused * Add a tsconfig file * Give the containers names * Don't upload video on test pass We don't upload it anyway so tell cypress not to so it can not bother encoding them * Enable linting on cypress files and fix existing lint errors * Type check cypress files and make it pass the type checks, specifically: * Upgrade sinon fake timers to a version that has the right types * Set module resolution * Type check cypress files separately * Rename workflow file again Probably better to just call it an element web build * Don't plus + characters in container name * Fix yaml * Stream logs to file * Add note to end to end tester to sya what's been ported * Put docker rm in finally block Co-authored-by: Travis Ralston <travisr@matrix.org>
2022-04-14 17:41:58 +08:00
"cypress/**/*.ts",
Revert "replace all require(.svg) with esm import" (#7969) * Revert "replace all require(svgs) with esm import (#7948)" This reverts commit 61cd463a3b57917d9206c98e6e75fc5b57033102. * add .default to svg icon inline requires Signed-off-by: Kerry Archibald <kerrya@element.io> * add shameful eslint ignore Signed-off-by: Kerry Archibald <kerrya@element.io> * format eslintrc Signed-off-by: Kerry Archibald <kerrya@element.io> * add missed MFileBody change Signed-off-by: Kerry Archibald <kerrya@element.io> * one more broken svg Signed-off-by: Kerry Archibald <kerrya@element.io> * and ignore it Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-04 01:51:38 +08: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",
Migrate to `eslint-plugin-matrix-org` This migrates to the new plugin form of our custom ESLint configs. As part of this, some packages are de-duplicated, configs streamlined, etc.
2021-04-01 20:17:09 +08:00
Revert "replace all require(.svg) with esm import" (#7969) * Revert "replace all require(svgs) with esm import (#7948)" This reverts commit 61cd463a3b57917d9206c98e6e75fc5b57033102. * add .default to svg icon inline requires Signed-off-by: Kerry Archibald <kerrya@element.io> * add shameful eslint ignore Signed-off-by: Kerry Archibald <kerrya@element.io> * format eslintrc Signed-off-by: Kerry Archibald <kerrya@element.io> * add missed MFileBody change Signed-off-by: Kerry Archibald <kerrya@element.io> * one more broken svg Signed-off-by: Kerry Archibald <kerrya@element.io> * and ignore it Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-04 01:51:38 +08:00
// Remove Babel things manually due to override limitations
"@babel/no-invalid-this": ["off"],
Rework lint comments
2021-06-29 20:35:43 +08:00
Revert "replace all require(.svg) with esm import" (#7969) * Revert "replace all require(svgs) with esm import (#7948)" This reverts commit 61cd463a3b57917d9206c98e6e75fc5b57033102. * add .default to svg icon inline requires Signed-off-by: Kerry Archibald <kerrya@element.io> * add shameful eslint ignore Signed-off-by: Kerry Archibald <kerrya@element.io> * format eslintrc Signed-off-by: Kerry Archibald <kerrya@element.io> * add missed MFileBody change Signed-off-by: Kerry Archibald <kerrya@element.io> * one more broken svg Signed-off-by: Kerry Archibald <kerrya@element.io> * and ignore it Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-04 01:51:38 +08: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",
Disable no-non-null assertions lint rule (#8699) This *allows* us to use `variable!.prop` to ensure `variable` is not null/undefined.
2022-05-30 14:21:55 +08:00
// We're okay with assertion errors when we ask for them
"@typescript-eslint/no-non-null-assertion": "off",
Revert "replace all require(.svg) with esm import" (#7969) * Revert "replace all require(svgs) with esm import (#7948)" This reverts commit 61cd463a3b57917d9206c98e6e75fc5b57033102. * add .default to svg icon inline requires Signed-off-by: Kerry Archibald <kerrya@element.io> * add shameful eslint ignore Signed-off-by: Kerry Archibald <kerrya@element.io> * format eslintrc Signed-off-by: Kerry Archibald <kerrya@element.io> * add missed MFileBody change Signed-off-by: Kerry Archibald <kerrya@element.io> * one more broken svg Signed-off-by: Kerry Archibald <kerrya@element.io> * and ignore it Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-04 01:51:38 +08:00
},
Remove redundant lint dependencies These are no longer needed with the new standard lint repo.
2020-07-29 19:00:42 +08:00
},
Revert "replace all require(.svg) with esm import" (#7969) * Revert "replace all require(svgs) with esm import (#7948)" This reverts commit 61cd463a3b57917d9206c98e6e75fc5b57033102. * add .default to svg icon inline requires Signed-off-by: Kerry Archibald <kerrya@element.io> * add shameful eslint ignore Signed-off-by: Kerry Archibald <kerrya@element.io> * format eslintrc Signed-off-by: Kerry Archibald <kerrya@element.io> * add missed MFileBody change Signed-off-by: Kerry Archibald <kerrya@element.io> * one more broken svg Signed-off-by: Kerry Archibald <kerrya@element.io> * and ignore it Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-04 01:51:38 +08: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",
},
}
],
Add ESLint shared settings to detect React version
2021-08-25 16:36:35 +08:00
settings: {
react: {
version: "detect",
Add rule to group imports by external and internal Signed-off-by: Aaron Raimist <aaron@raim.ist>
2021-10-23 06:21:46 +08:00
},
},
Use eslint config from the js sdk Extend the js sdk's eslint config to give as consistent a code style as possible. Add react/jsx/flow stuff that we use here.
2017-01-20 22:08:14 +08:00
};
prevent reflow in app when accessing window dimensions
2021-05-25 17:25:36 +08:00
function buildRestrictedPropertiesOptions(properties, message) {
return properties.map(prop => {
Lint MXC APIs to centralise access This adds linting rules to ensure that MXC APIs are only accessed via the `Media` helper so they can be customised easily when desired. Fixes https://github.com/vector-im/element-web/issues/16933
2021-06-30 21:19:39 +08:00
let [object, property] = prop.split(".");
if (object === "*") {
object = undefined;
}
prevent reflow in app when accessing window dimensions
2021-05-25 17:25:36 +08:00
return {
object,
property,
message,
};
});
}
Reference in New Issue Copy Permalink