Українська
Лінтинг, форматування й тести
Серверна частина має аналізатори, що зупиняють збирання, і dotnet format, який підтримує стиль коду (тема 2). Клієнт отримує ті самі три запобіжники: лінтер, форматувальник і виконавець тестів. Усі команди цього розділу виконуються в Source/Chatex.Web.
Крок 1. ESLint
Навіщо. Компілятор TypeScript перевіряє типи; ESLint перевіряє все інше, що допустиме, але підозріле, – невикористану змінну, порожню функцію, any там, де можна було вказати тип, – а через angular-eslint ще й правила, специфічні для Angular, що стосуються компонентів і шаблонів, зокрема доступності (кнопка без підпису, обробник кліку без клавіатурного відповідника).
Що зробити. ng add angular-eslint уже записав конфігурацію. Перевірте, що ваша збігається з цією:
js
// @ts-check
const eslint = require('@eslint/js');
const { defineConfig } = require('eslint/config');
const tseslint = require('typescript-eslint');
const angular = require('angular-eslint');
module.exports = defineConfig([
{
files: ['**/*.ts'],
extends: [
eslint.configs.recommended,
tseslint.configs.recommended,
tseslint.configs.stylistic,
angular.configs.tsRecommended,
],
processor: angular.processInlineTemplates,
rules: {
'@angular-eslint/directive-selector': [
'error',
{
type: 'attribute',
prefix: 'app',
style: 'camelCase',
},
],
'@angular-eslint/component-selector': [
'error',
{
type: 'element',
prefix: 'app',
style: 'kebab-case',
},
],
},
},
{
files: ['**/*.html'],
extends: [angular.configs.templateRecommended, angular.configs.templateAccessibility],
rules: {},
},
]);- Файл має формат плоскої конфігурації (flat config) ESLint 9 і новіших: масив об’єктів, кожен із яких застосовує правила до файлів, що збігаються з
files. - Файли TypeScript отримують рекомендовані правила ESLint, typescript-eslint (разом з його стилістичним набором) і angular-eslint.
processInlineTemplatesвитягує вбудовані шаблони компонентів, щоб правила для шаблонів перевіряли й їх. - Селектори компонентів мають бути елементами в стилі kebab-case з префіксом
app-(app-shell), селектори директив – атрибутами в стилі camelCase з префіксомapp. Префікс відділяє наші елементи від справжніх елементів HTML і від компонентів бібліотек. - Шаблони HTML отримують рекомендовані правила для шаблонів і правила доступності.
Перевірка
powershell
npm run lintLinting "chatex"...
All files pass linting.Крок 2. Prettier
Навіщо. Форматувальник припиняє всі суперечки про стиль: він переписує код в одне канонічне компонування. Prettier форматує TypeScript, HTML, CSS і JSON та розуміє шаблони Angular – зокрема й вбудовані всередині @Component. Плагін Tailwind додатково сортує утилітні класи кожного атрибута class у рекомендованому Tailwind порядку, тож однакові класи завжди йдуть в однаковому порядку, а різниці між версіями лишаються малими.
Що зробити. Додайте до .prettierrc плагін і шлях до таблиці стилів, що визначає наші власні утиліти (наступний розділ):
json
{
"printWidth": 100,
"singleQuote": true,
"plugins": ["prettier-plugin-tailwindcss"],
"tailwindStylesheet": "./src/styles.css",
"overrides": [
{
"files": "*.html",
"options": {
"parser": "angular"
}
}
]
}printWidth: 100– рядки до 100 символів, така сама межа, як у коді C#.singleQuote: true–'text'замість"text"у TypeScript.overrides– файли.htmlрозбираються як шаблони Angular, щоб блоки керування потоком, як-от@if, форматувалися правильно.
Тепер один раз відформатуйте створені файли. Це також перетворить їхні кінці рядків CRLF на LF:
powershell
npm run formatsrc/app/app.config.ts 77ms
src/app/app.css 1ms (unchanged)
src/app/app.html 66ms
src/app/app.routes.ts 2ms
src/app/app.spec.ts 8ms
src/app/app.ts 4ms
src/index.html 3ms
src/main.ts 2ms
src/styles.css 1msПеревірка
powershell
npm run format:checkChecking formatting...
All matched files use Prettier code style!Перед npm run format та сама команда перелічувала вісім файлів і завершувалася повідомленням Code style issues found in 8 files. Run Prettier with --write to fix. – його показує CI, якщо ви забули відформатувати код.
Крок 3. Vitest
Навіщо. Модульні тести клієнта запускаються за допомогою Vitest – швидкого виконавця тестів із API, сумісним із Jest. Angular CLI його інтегрує: ціль test в angular.json використовує збирач @angular/build:unit-test, який компілює застосунок і файли *.spec.ts тим самим компілятором, що й ng build, і запускає їх через Vitest у jsdom – імітації браузера в Node.js. Файлу vitest.config.ts, який довелося б підтримувати, немає.
Файли тестів компілюються за tsconfig.spec.json. Його єдине доповнення до спільних налаштувань – пакет типів vitest/globals: функції describe, it, expect, beforeEach і vi доступні в кожній специфікації без імпорту, так само як в xUnit ви не імпортуєте [Fact] у кожен файл.
Що зробити. Замініть створений файл тим самим вмістом із кінцями рядків LF:
json
/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
{
"extends": "./tsconfig.json",
"compilerOptions": {
"types": [
"vitest/globals"
]
},
"include": [
"src/**/*.d.ts",
"src/**/*.spec.ts"
]
}Так само вчиніть зі спільними налаштуваннями з таблиці 15.5:
json
/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
{
"compileOnSave": false,
"compilerOptions": {
"noImplicitOverride": true,
"noPropertyAccessFromIndexSignature": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"skipLibCheck": true,
"isolatedModules": true,
"experimentalDecorators": true,
"importHelpers": true,
"target": "ES2022",
"module": "preserve"
},
"angularCompilerOptions": {
"enableI18nLegacyMessageIdFormat": false,
"strictInjectionParameters": true,
"strictInputAccessModifiers": true
},
"files": [],
"references": [
{
"path": "./tsconfig.app.json"
},
{
"path": "./tsconfig.spec.json"
}
]
}Запустіть тести один раз, без стеження за змінами:
powershell
npm test -- --watch=false-- передає параметр через npm до ng test. Без нього Vitest лишається запущеним і повторює зачеплені тести після кожного збереження – це зручно під час написання коду.
Перевірка
Створений app.spec.ts має два тести, і обидва проходять:
Test Files 1 passed (1)
Tests 2 passed (2)Вони перевіряють сторінку привітання, яку наступні розділи замінять; app.spec.ts зникне разом із нею.
Vitest для користувача xUnit
Файл специфікації – це клас тестів: describe('ThemeService', () => { ... }) групує тести, it('does something', () => { ... }) – це [Fact], beforeEach – конструктор, який xUnit виконує перед кожним тестом, а expect(x).toBe(y) – це x.ShouldBe(y). vi.fn() створює функцію-імітацію (mock), що записує свої виклики, як підробка (fake) в темі 9. TestBed в Angular – невеликий контейнер DI для одного тесту: ви реєструєте провайдери, а TestBed.inject(T) розв’язує сервіс.
Крок 4. Редактор і README
Навіщо. VS Code з розширенням Angular Language Service перевіряє типи в шаблонах, поки ви друкуєте, і доповнює вхідні параметри компонентів. Створена папка .vscode рекомендує це розширення, запускає сервер розробки для налагодження й визначає завдання npm. Конфігурація налагодження для ng test відкриває сторінку Karma, якої у Vitest немає, тож її прибирають.
Що зробити. Замініть три файли (змінюється лише launch.json; два інші отримують кінці рядків LF):
json
{
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "ng serve",
"type": "chrome",
"request": "launch",
"preLaunchTask": "npm: start",
"url": "http://localhost:4200/"
}
]
}json
{
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=827846
"recommendations": ["angular.ng-template"]
}json
{
// For more information, visit: https://go.microsoft.com/fwlink/?LinkId=733558
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "start",
"isBackground": true,
"problemMatcher": {
"owner": "typescript",
"pattern": "$tsc",
"background": {
"activeOnStart": true,
"beginsPattern": {
"regexp": "Changes detected"
},
"endsPattern": {
"regexp": "bundle generation (complete|failed)"
}
}
}
},
{
"type": "npm",
"script": "test",
"isBackground": true,
"problemMatcher": {
"owner": "typescript",
"pattern": "$tsc",
"background": {
"activeOnStart": true,
"beginsPattern": {
"regexp": "Changes detected"
},
"endsPattern": {
"regexp": "bundle generation (complete|failed)"
}
}
}
}
]
}Кореневий .gitignore репозиторію ігнорує .vscode/*, але зберігає саме ці файли (!.vscode/launch.json тощо), тож вони спільні з командою.
Замініть створений README коротким, що вказує на документацію:
md
# Chatex web app
Angular 22 + Tailwind CSS v4 frontend for Chatex. See the [Frontend docs](../../Docs/Frontend.md) for the architecture and how it talks to the API.
```bash
npm install
```
```bash
npm start
```
The dev server runs at http://localhost:4200 and proxies `/api` and `/hubs` to the API at http://localhost:5214, so start the API first.
```bash
npm run lint
```
```bash
npm test -- --watch=false
```
```bash
npm run build
```