Руководство по стилю и соглашения по кодированию¶

Люди спрашивали меня, что я думаю по этому поводу. Лично я не навязываю их своим командам и проектам, но эти соглашения отлично выступают мировым судьёй и полезны для поддержания консистентности кодовой базы. Есть и другие более важные вещи и они описаны в главе с советами (например, утверждение типа это плохо, сеттеры свойств это плохо) 🌹.

Переменная и функция¶

• Используйте camelCase для имен переменных и функций

Плохо

1
2

var FooVar;
function BarFunc() {}

Хорошо

1
2

var fooVar;
function barFunc() {}

Класс¶

• Используйте PascalCase для имен классов.

Плохо

1

class foo {}

Хорошо

1

class Foo {}

• Используйте camelCase для членов класса и методов

Плохо

1
2
3
4

class Foo {
    Bar: number;
    Baz() {}
}

Хорошо

1
2
3
4

class Foo {
    bar: number;
    baz() {}
}

Интерфейс¶

• Используйте PascalCase для именования.

• Используйте camelCase для элементов.

• Не используйте префикс I

Плохо

1

interface IFoo {}

Хорошо

1

interface Foo {}

Тип¶

• Используйте PascalCase для именования.

• Используйте camelCase для элементов.

Пространства имен¶

• Используйте PascalCase для именования.

Плохо

1

namespace foo {}

Хорошо

1

namespace Foo {}

Перечисление¶

• Используйте PascalCase для именования.

Плохо

1

enum color {}

Хорошо

1

enum Color {}

• Используйте PascalCase для именования элементов перечисления.

Плохо

1
2
3

enum Color {
    red,
}

Хорошо

1
2
3

enum Color {
    Red,
}

Null vs. Undefined¶

• Предпочитаю не использовать ни то, ни другое из-за явной недоступности

Плохо

1

let foo = { x: 123, y: undefined };

Хорошо

1

let foo: { x: number; y?: number } = { x: 123 };

• Используйте undefined в общем случае (но рассмотрите возможность возврата такого объекта, как {valid:boolean, value?:Foo} вместо этого)

Плохо

1

return null;

Хорошо

1

return undefined;

• Используйте null, если он является частью API или является традиционным

Плохо

1

cb(undefined);

Хорошо

1

cb(null);

• Используйте проверку на истинность объектов, являющихся null или undefined

Плохо

1

if (error === null)

Хорошо

1

if (error)

• Используйте == null / != null (а не === / !==) для проверки наличия null / undefined в примитивах, но не для других ложных значений (например '', 0, false), например:

Плохо

1

if (error !== null) // не исключает undefined

Хорошо

1

if (error != null) // исключает и null и undefined

Форматирование¶

Компилятор TypeScript поставляется с очень хорошим сервисом форматирования. Какой бы результат он ни давал по умолчанию, он достаточно хорош, чтобы уменьшить когнитивную нагрузку в команде.

Используйте tsfmt для автоматического форматирования кода в командной строке. Кроме того, ваша IDE (atom/vscode/vs/sublime) уже имеет встроенную поддержку форматирования.

Примеры:

1
2

// Пробел перед типом, т.е. foo:<пробел>string
const foo: string = 'hello';

Кавычки¶

• Предпочитаю одинарные кавычки ('), если не экранирую.

• Если вы не можете использовать двойные кавычки, попробуйте использовать обратные галочки (`).

Пробелы¶

• Используйте 2 пробела. Не табы.

Причина: так делают другие команды JavaScript (например airbnb, idiomatic, standard, npm, node, google/angular, facebook/react). Команды TypeScript/VSCode используют 4 пробела, но определенно являются исключениями в экосистеме.

Точка с запятой¶

• Используйте точку с запятой.

Массив¶

• Описывайте массивы как foos: Foo[] вместо foos: Array<Foo>.

Имя файла¶

Именуйте файлы в camelCase. Например accordion.tsx, myControl.tsx, utils.ts, map.ts и т.д.

тип vs. интерфейс¶

• Используйте тип, когда вам может понадобиться объединение или пересечение:

1

type Foo = number | { someProperty: number }

• Используйте интерфейс, если вы хотите использовать extends или implements, например:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

interface Foo {
  foo: string;
}
interface FooBar extends Foo {
  bar: string;
}
class X implements FooBar {
  foo: string;
  bar: string;
}

• В иных случаях используйте то, что вам больше нравится.

Комментарии