mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-16 21:24:59 +08:00
456 lines
16 KiB
Markdown
456 lines
16 KiB
Markdown
# Element Web/Desktop code style guide
|
|
|
|
This code style applies to projects which the element-web team directly maintains or is reasonably
|
|
adjacent to. As of writing, these are:
|
|
|
|
* element-desktop
|
|
* element-web
|
|
* matrix-react-sdk
|
|
* matrix-js-sdk
|
|
|
|
Other projects might extend this code style for increased strictness. For example, matrix-events-sdk
|
|
has stricter code organization to reduce the maintenance burden. These projects will declare their code
|
|
style within their own repos.
|
|
|
|
Note that some requirements will be layer-specific. Where the requirements don't make sense for the
|
|
project, they are used to the best of their ability, used in spirit, or ignored if not applicable,
|
|
in that order.
|
|
|
|
## Guiding principles
|
|
|
|
1. We want the lint rules to feel natural for most team members. No one should have to think too much
|
|
about the linter.
|
|
2. We want to stay relatively close to [industry standards](https://google.github.io/styleguide/tsguide.html)
|
|
to make onboarding easier.
|
|
3. We describe what good code looks like rather than point out bad examples. We do this to avoid
|
|
excessively punishing people for writing code which fails the linter.
|
|
4. When something isn't covered by the style guide, we come up with a reasonable rule rather than
|
|
claim that it "passes the linter". We update the style guide and linter accordingly.
|
|
5. While we aim to improve readability, understanding, and other aspects of the code, we deliberately
|
|
do not let solely our personal preferences drive decisions.
|
|
6. We aim to have an understandable guide.
|
|
|
|
## Coding practices
|
|
|
|
1. Lint rules enforce decisions made by this guide. The lint rules and this guide are kept in
|
|
perfect sync.
|
|
2. Commit messages are descriptive for the changes. When the project supports squash merging,
|
|
only the squashed commit needs to have a descriptive message.
|
|
3. When there is disagreement with a code style approved by the linter, a PR is opened against
|
|
the lint rules rather than making exceptions on the responsible code PR.
|
|
4. Rules which are intentionally broken (via eslint-ignore, @ts-ignore, etc) have a comment
|
|
included in the immediate vicinity for why. Determination of whether this is valid applies at
|
|
code review time.
|
|
5. When editing a file, nearby code is updated to meet the modern standards. "Nearby" is subjective,
|
|
but should be whatever is reasonable at review time. Such an example might be to update the
|
|
class's code style, but not the file's.
|
|
1. These changes should be minor enough to include in the same commit without affecting a code
|
|
reviewer's job.
|
|
|
|
## All code
|
|
|
|
Unless otherwise specified, the following applies to all code:
|
|
|
|
1. 120 character limit per line. Match existing code in the file if it is using a lower guide.
|
|
2. A tab/indentation is 4 spaces.
|
|
3. Newlines are Unix.
|
|
4. A file has a single empty line at the end.
|
|
5. Lines are trimmed of all excess whitespace, including blank lines.
|
|
6. Long lines are broken up for readability.
|
|
|
|
## TypeScript / JavaScript {#typescript-javascript}
|
|
|
|
1. Write TypeScript. Turn JavaScript into TypeScript when working in the area.
|
|
2. Use named exports.
|
|
3. Break long lines to appear as follows:
|
|
|
|
```typescript
|
|
// Function arguments
|
|
function doThing(
|
|
arg1: string,
|
|
arg2: string,
|
|
arg3: string,
|
|
): boolean {
|
|
return !!arg1
|
|
&& !!arg2
|
|
&& !!arg3;
|
|
}
|
|
|
|
// Calling a function
|
|
doThing(
|
|
"String 1",
|
|
"String 2",
|
|
"String 3",
|
|
);
|
|
|
|
// Reduce line verbosity when possible/reasonable
|
|
doThing(
|
|
"String1", "String 2",
|
|
"A much longer string 3",
|
|
);
|
|
|
|
// Chaining function calls
|
|
something.doThing()
|
|
.doOtherThing()
|
|
.doMore()
|
|
.somethingElse(it =>
|
|
useIt(it)
|
|
);
|
|
```
|
|
4. Use semicolons for block/line termination.
|
|
1. Except when defining interfaces, classes, and non-arrow functions specifically.
|
|
5. When a statement's body is a single line, it may be written without curly braces, so long as the body is placed on
|
|
the same line as the statement.
|
|
|
|
```typescript
|
|
if (x) doThing();
|
|
```
|
|
6. Blocks for `if`, `for`, `switch` and so on must have a space surrounding the condition, but not
|
|
within the condition.
|
|
|
|
```typescript
|
|
if (x) {
|
|
doThing();
|
|
}
|
|
```
|
|
7. Mixing of logical operands requires brackets to explicitly define boolean logic.
|
|
|
|
```typescript
|
|
if ((a > b && b > c) || (d < e)) return true;
|
|
```
|
|
8. Ternaries use the same rules as `if` statements, plus the following:
|
|
|
|
```typescript
|
|
// Single line is acceptable
|
|
const val = a > b ? doThing() : doOtherThing();
|
|
|
|
// Multiline is also okay
|
|
const val = a > b
|
|
? doThing()
|
|
: doOtherThing();
|
|
|
|
// Use brackets when using multiple conditions.
|
|
// Maximum 3 conditions, prefer 2 or less.
|
|
const val = (a > b && b > c) ? doThing() : doOtherThing();
|
|
```
|
|
9. lowerCamelCase is used for function and variable naming.
|
|
10. UpperCamelCase is used for general naming.
|
|
11. Interface names should not be marked with an uppercase `I`.
|
|
12. One variable declaration per line.
|
|
13. If a variable is not receiving a value on declaration, its type must be defined.
|
|
|
|
```typescript
|
|
let errorMessage: Optional<string>;
|
|
```
|
|
14. Objects, arrays, enums and so on must have each line terminated with a comma:
|
|
|
|
```typescript
|
|
const obj = {
|
|
prop: 1,
|
|
else: 2,
|
|
};
|
|
|
|
const arr = [
|
|
"one",
|
|
"two",
|
|
];
|
|
|
|
enum Thing {
|
|
Foo,
|
|
Bar,
|
|
}
|
|
|
|
doThing(
|
|
"arg1",
|
|
"arg2",
|
|
);
|
|
```
|
|
15. Objects can use shorthand declarations, including mixing of types.
|
|
|
|
```typescript
|
|
{
|
|
room,
|
|
prop: this.prop,
|
|
}
|
|
// ... or ...
|
|
{ room, prop: this.prop }
|
|
```
|
|
16. Object keys should always be non-strings when possible.
|
|
|
|
```typescript
|
|
{
|
|
property: "value",
|
|
"m.unavoidable": true,
|
|
[EventType.RoomMessage]: true,
|
|
}
|
|
```
|
|
17. Explicitly cast to a boolean.
|
|
|
|
```typescript
|
|
!!stringVar || Boolean(stringVar)
|
|
```
|
|
18. Use `switch` statements when checking against more than a few enum-like values.
|
|
19. Use `const` for constants, `let` for mutability.
|
|
20. Describe types exhaustively (ensure noImplictAny would pass).
|
|
1. Notable exceptions are arrow functions used as parameters, when a void return type is
|
|
obvious, and when declaring and assigning a variable in the same line.
|
|
21. Declare member visibility (public/private/protected).
|
|
22. Private members are private and not prefixed unless required for naming conflicts.
|
|
1. Convention is to use an underscore or the word "internal" to denote conflicted member names.
|
|
2. "Conflicted" typically refers to a getter which wants the same name as the underlying variable.
|
|
23. Prefer readonly members over getters backed by a variable, unless an internal setter is required.
|
|
24. Prefer Interfaces for object definitions, and types for parameter-value-only declarations.
|
|
1. Note that an explicit type is optional if not expected to be used outside of the function call,
|
|
unlike in this example:
|
|
|
|
```typescript
|
|
interface MyObject {
|
|
hasString: boolean;
|
|
}
|
|
|
|
type Options = MyObject | string;
|
|
|
|
function doThing(arg: Options) {
|
|
// ...
|
|
}
|
|
```
|
|
25. Variables/properties which are `public static` should also be `readonly` when possible.
|
|
26. Interface and type properties are terminated with semicolons, not commas.
|
|
27. Prefer arrow formatting when declaring functions for interfaces/types:
|
|
|
|
```typescript
|
|
interface Test {
|
|
myCallback: (arg: string) => Promise<void>;
|
|
}
|
|
```
|
|
28. Prefer a type definition over an inline type. For example, define an interface.
|
|
29. Always prefer to add types or declare a type over the use of `any`. Prefer inferred types
|
|
when they are not `any`.
|
|
1. When using `any`, a comment explaining why must be present.
|
|
30. `import` should be used instead of `require`, as `require` does not have types.
|
|
31. Export only what can be reused.
|
|
32. Prefer a type like `Optional<X>` (`type Optional<T> = T | null | undefined`) instead
|
|
of truly optional parameters.
|
|
1. A notable exception is when the likelihood of a bug is minimal, such as when a function
|
|
takes an argument that is more often not required than required. An example where the
|
|
`?` operator is inappropriate is when taking a room ID: typically the caller should
|
|
supply the room ID if it knows it, otherwise deliberately acknowledge that it doesn't
|
|
have one with `null`.
|
|
|
|
```typescript
|
|
function doThingWithRoom(
|
|
thing: string,
|
|
room: Optional<string>, // require the caller to specify
|
|
) {
|
|
// ...
|
|
}
|
|
```
|
|
33. There should be approximately one interface, class, or enum per file unless the file is named
|
|
"types.ts", "global.d.ts", or ends with "-types.ts".
|
|
1. The file name should match the interface, class, or enum name.
|
|
34. Bulk functions can be declared in a single file, though named as "foo-utils.ts" or "utils/foo.ts".
|
|
35. Imports are grouped by external module imports first, then by internal imports.
|
|
36. File ordering is not strict, but should generally follow this sequence:
|
|
1. Licence header
|
|
2. Imports
|
|
3. Constants
|
|
4. Enums
|
|
5. Interfaces
|
|
6. Functions
|
|
7. Classes
|
|
1. Public/protected/private static properties
|
|
2. Public/protected/private properties
|
|
3. Constructors
|
|
4. Public/protected/private getters & setters
|
|
5. Protected and abstract functions
|
|
6. Public/private functions
|
|
7. Public/protected/private static functions
|
|
37. Variable names should be noticeably unique from their types. For example, "str: string" instead
|
|
of "string: string".
|
|
38. Use double quotes to enclose strings. You may use single quotes if the string contains double quotes.
|
|
|
|
```typescript
|
|
const example1 = "simple string";
|
|
const example2 = 'string containing "double quotes"';
|
|
```
|
|
39. Prefer async-await to promise-chaining
|
|
|
|
```typescript
|
|
async function () {
|
|
const result = await anotherAsyncFunction();
|
|
// ...
|
|
}
|
|
```
|
|
|
|
## React
|
|
|
|
Inheriting all the rules of TypeScript, the following additionally apply:
|
|
|
|
1. Types for lifecycle functions are not required (render, componentDidMount, and so on).
|
|
2. Class components must always have a `Props` interface declared immediately above them. It can be
|
|
empty if the component accepts no props.
|
|
3. Class components should have an `State` interface declared immediately above them, but after `Props`.
|
|
4. Props and State should not be exported. Use `React.ComponentProps<typeof ComponentNameHere>`
|
|
instead.
|
|
5. One component per file, except when a component is a utility component specifically for the "primary"
|
|
component. The utility component should not be exported.
|
|
6. Exported constants, enums, interfaces, functions, etc must be separate from files containing components
|
|
or stores.
|
|
7. Stores should use a singleton pattern with a static instance property:
|
|
|
|
```typescript
|
|
class FooStore {
|
|
public static readonly instance = new FooStore();
|
|
|
|
// or if the instance can't be created eagerly:
|
|
private static _instance: FooStore;
|
|
public static get instance(): FooStore {
|
|
if (!FooStore._instance) {
|
|
FooStore._instance = new FooStore();
|
|
}
|
|
return FooStore._instance;
|
|
}
|
|
}
|
|
```
|
|
8. Stores must support using an alternative MatrixClient and dispatcher instance.
|
|
9. Utilities which require JSX must be split out from utilities which do not. This is to prevent import
|
|
cycles during runtime where components accidentally include more of the app than they intended.
|
|
10. Interdependence between stores should be kept to a minimum. Break functions and constants out to utilities
|
|
if at all possible.
|
|
11. A component should only use CSS class names in line with the component name.
|
|
1. When knowingly using a class name from another component, document it.
|
|
12. Break components over multiple lines like so:
|
|
|
|
```typescript
|
|
function render() {
|
|
return <Component
|
|
prop1="test"
|
|
prop2={this.state.variable}
|
|
/>;
|
|
|
|
// or
|
|
|
|
return (
|
|
<Component
|
|
prop1="test"
|
|
prop2={this.state.variable}
|
|
/>
|
|
);
|
|
|
|
// or if children are needed (infer parens usage)
|
|
|
|
return <Component
|
|
prop1="test"
|
|
prop2={this.state.variable}
|
|
>{ _t("Short string here") }</Component>;
|
|
|
|
|
|
|
|
return <Component
|
|
prop1="test"
|
|
prop2={this.state.variable}
|
|
>
|
|
{ _t("Longer string here") }
|
|
</Component>;
|
|
}
|
|
```
|
|
13. Curly braces within JSX should be padded with a space, however properties on those components should not.
|
|
See above code example.
|
|
14. Functions used as properties should either be defined on the class or stored in a variable. They should not
|
|
be inline unless mocking/short-circuiting the value.
|
|
15. Prefer hooks (functional components) over class components. Be consistent with the existing area if unsure
|
|
which should be used.
|
|
1. Unless the component is considered a "structure", in which case use classes.
|
|
16. Write more views than structures. Structures are chunks of functionality like MatrixChat while views are
|
|
isolated components.
|
|
17. Components should serve a single, or near-single, purpose.
|
|
18. Prefer to derive information from component properties rather than establish state.
|
|
19. Do not use `React.Component::forceUpdate`.
|
|
|
|
## Stylesheets (\*.pcss = PostCSS + Plugins)
|
|
|
|
Note: We use PostCSS + some plugins to process our styles. It looks like SCSS, but actually it is not.
|
|
|
|
1. Class names must be prefixed with "mx_".
|
|
2. Class names should denote the component which defines them, followed by any context:
|
|
1. mx_MyFoo
|
|
2. mx_MyFoo_avatar
|
|
3. mx_MyFoo_avatar--user
|
|
3. Use the `$font` and `$spacing` variables instead of manual values.
|
|
4. Keep indentation/nesting to a minimum. Maximum suggested nesting is 5 layers.
|
|
5. Use the whole class name instead of shortcuts:
|
|
|
|
```scss
|
|
.mx_MyFoo {
|
|
& .mx_MyFoo_avatar { // instead of &_avatar
|
|
// ...
|
|
}
|
|
}
|
|
```
|
|
6. Break multiple selectors over multiple lines this way:
|
|
|
|
```scss
|
|
.mx_MyFoo,
|
|
.mx_MyBar,
|
|
.mx_MyFooBar {
|
|
// ...
|
|
}
|
|
```
|
|
7. Non-shared variables should use $lowerCamelCase. Shared variables use $dashed-naming.
|
|
8. Overrides to Z indexes, adjustments of dimensions/padding with pixels, and so on should all be
|
|
documented for what the values mean:
|
|
|
|
```scss
|
|
.mx_MyFoo {
|
|
width: calc(100% - 12px); // 12px for read receipts
|
|
top: -2px; // visually centred vertically
|
|
z-index: 10; // above user avatar, but below dialogs
|
|
}
|
|
```
|
|
9. Avoid the use of `!important`. If necessary, add a comment.
|
|
|
|
## Tests
|
|
|
|
1. Tests must be written in TypeScript.
|
|
2. Jest mocks are declared below imports, but above everything else.
|
|
3. Use the following convention template:
|
|
|
|
```typescript
|
|
// Describe the class, component, or file name.
|
|
describe("FooComponent", () => {
|
|
// all test inspecific variables go here
|
|
|
|
beforeEach(() => {
|
|
// exclude if not used.
|
|
});
|
|
|
|
afterEach(() => {
|
|
// exclude if not used.
|
|
});
|
|
|
|
// Use "it should..." terminology
|
|
it("should call the correct API", async () => {
|
|
// test-specific variables go here
|
|
|
|
// function calls/state changes go here
|
|
|
|
// expectations go here
|
|
});
|
|
});
|
|
|
|
// If the file being tested is a utility class:
|
|
describe("foo-utils", () => {
|
|
describe("firstUtilFunction", () => {
|
|
it("should...", async () => {
|
|
// ...
|
|
});
|
|
});
|
|
|
|
describe("secondUtilFunction", () => {
|
|
it("should...", async () => {
|
|
// ...
|
|
});
|
|
});
|
|
});
|
|
```
|