Үлкен жобада TypeScript қатаң: дамуды тоқтатпай қадамдық көшіру
Неліктен қатаң режимді қосуға болмайды?
Бірнеше жүздеген файлдары бар жобада "strict": true мыңдаған қателерді шығарады. Оларды бір бұтақпен түзету апта бойы барлығына қайшы келетін PR жүргізуді білдіреді, оны ешкім дұрыс тексере алмайды. Сондай-ақ осы уақыт ішінде дамуды тоқтату мүмкін емес. Бізге жаңа код бірден қатаң түрде жазылатын, ал ескі код бөліктерге аударылатын схема қажет.
Қатаңға не кіреді
strict жалаушасы - әрқайсысын дербес қосуға болатын жеке тексерулер жинағы:
noImplicitAny- шығаруға болмайтын түрі жоқ параметрлер мен айнымалыларanyемес, қатеге айналады.strictNullChecks-nullжәнеundefinedенді ешбір түрдегі жарамды мәндер емес. Әдетте ең көп қателер және ең көп пайда әкеледі.strictFunctionTypes,strictBindCallApply,strictPropertyInitialization,noImplicitThis,alwaysStrict,useUnknownInCatchVariables.
strict ішіне қосылмаған басқа пайдалы жалауша noUncheckedIndexedAccess болып табылады: arr[i] және record[key] қатынасу T | undefined мәнін қайтарады. Оны соңында бөлек қадам ретінде қосу керек.
1-стратегия: бір-бірден жалаушалар
Орташа жобалар үшін ең қарапайым схема:
- 1.Аз қателер беретін жалаушаларды қосыңыз (
alwaysStrict,strictBindCallApply,noImplicitThis) - әдетте бұл ондаған өңдеулерді білдіреді. - 2.
noImplicitAny: механикалық қателер, жылдам, ішінара автоматты түрде түзетіледі. - 3.
strictNullChecks- негізгі кезең. Оны екінші стратегияны пайдаланып жасаған ыңғайлы. - 4.
strict: trueқосыңыз және жеке жалаушаларды алып тастаңыз.
Әрбір қадам құюға оңай жеке шағын PR болып табылады.
2-стратегия: аударылған файлдар үшін қатаң конфигурация
Негізгі tsconfig.json қатаң емес болып қалады, бірақ оның жанында тек аударылған бөлікті тексеретін қатаң нұсқа пайда болады:
// tsconfig.strict.json
{
"extends": "./tsconfig.json",
"compilerOptions": { "strict": true, "noEmit": true },
"include": [
"src/shared/lib/**/*",
"src/entities/user/**/*",
"next-env.d.ts"
]
}Мұнда маңызды тұзақ бар. tsc тек include файлдарын ғана емес, сонымен бірге олар импорттағанның барлығын тексереді. Аударылған модуль аударылмаған модульді импорттаса, аударылмаған модульдің қателері де шығыста пайда болады. Сондықтан олар төменнен жоғарыға аударылады (бірінші утилиталар мен модельдер, содан кейін оларды не пайдаланады) және шығыс аударылған жолдар тізіміне сәйкес сүзіледі:
// scripts/check-strict.mjs
import { execSync } from "node:child_process";
import { readFileSync } from "node:fs";
const cfg = JSON.parse(readFileSync("tsconfig.strict.json", "utf8"));
const prefixes = cfg.include.map((p) => p.replace(/\*\*.*$/, ""));
let out = "";
try {
execSync("npx tsc -p tsconfig.strict.json --pretty false", { encoding: "utf8" });
} catch (e) {
out = e.stdout ?? "";
}
const errors = out.split("\n").filter((l) => /error TS\d+/.test(l) && prefixes.some((p) => l.startsWith(p)));
for (const e of errors) console.error(e);
process.exit(errors.length ? 1 : 0);Сценарий міндетті растау арқылы CI-ге жіберіледі. Мен қалтаны include ішіне қостым - ол мәңгілікке регрессиядан қорғалған.
Кері логикасы бар дәл осындай тәсілге арналған дайын құрал бар: typescript-strict-plugin аударылмаған файлдарды түсініктемемен // @ts-strict-ignore белгілеу арқылы бүкіл жоба үшін strict қосуға және оны tsc-strict пәрменімен CI жүйесінде тексеруге мүмкіндік береді. Аударылған файлдардың жартысынан көбі болған кезде бұл ыңғайлы.
3-стратегия: Қателер саны бойынша ратчет
Егер бәрін тез түзегеннен гөрі, жағдайдың нашарлауына жол бермеу маңызды болса, толық қатаң жұмыстың қателерін санап, олардың санының өсуіне жол бермеу жеткілікті:
COUNT=$(npx tsc -p tsconfig.strict-all.json --noEmit --pretty false | grep -c "error TS" || true) BASELINE=$(cat .strict-baseline) if [ "$COUNT" -gt "$BASELINE" ]; then echo "strict errors: $COUNT > baseline $BASELINE"; exit 1 fi echo "$COUNT" > .strict-baseline # закоммитьте уменьшение в том же PR
Әрбір PR санды өзгертпейді немесе азайтады. betterer құралы дәл осылай жасайды: ол қателерді жалпы санды ғана емес, файл бойынша қадағалайды, сондықтан бір жерде түзету басқа жерде жаңа қатені жасырмайды.
Жағдайы нашарламас үшін оны қалай түзетуге болады
Мақсат қызыл астын сызуды жою емес, түрлерін шыншыл ету.
- `!` (нөлдік емес бекіту) компиляция қатесін орындау уақытының қатесіне айналдырады. Бұл шынымен кепілдік болған кезде ғана қабылданады және оны түсіндіруге болады. Әйтпесе - ерте шығумен нақты тексеру.
- `any` → `unknown` сыртқы деректер үшін (JSON, API жауаптары,
catch (e)), содан кейін тексерулер немесе тексеру схемасы арқылы тарылту. @ts-ignoreорнына `@ts-expect-error`. Біріншісі қате жойылған кезде түседі және уақытша басудың мәңгі өмір сүруіне жол бермейді. Неліктен әрқашан түсініктемемен.- Үлгілердегі қосымша өрістер. Егер дерекқордағы өріс
NOT NULLболса, сынақта нысанды инициализациялау оңай болғандықтан, ол?түрінде болмауы керек.
Аударылған каталогтарға арналған қате режиміндегі ESLint ережелері @typescript-eslint/no-explicit-any және @typescript-eslint/no-non-null-assertion ескі әдеттердің қайтарылуына жол бермейді.
Жұмысты ұйымдастыру
- Функционалдық өзгерістермен араласпай, бір қалтадағы шағын PR-лар - оларды қарап шығу және кері айналдыру оңай.
- Жаңа файлдар бірден қатаң аймаққа жіберіледі. Әйтпесе, аударылмаған бөлік азайғаннан гөрі тезірек өседі.
- Қателер ең қымбат болатын кодтан бастаңыз: ақшамен жұмыс, қол жеткізу құқығы, сыртқы деректерді талдау.
Қашан асырмау керек
Тасымалдау сценарийлерін, бір реттік утилиталарды және жақын арада жойылатын прототиптерді аударудың қажеті жоқ - оларды қатаң аймақтан шығарыңыз. Ал егер жоба белсенді дамусыз қолдау режимінде болса, ратчет жеткілікті: ол бөлек көші-қон жобасын қажет етпей, оның нашарлауына жол бермейді.