เครื่องมือสร้างไฟล์ tsconfig.json

ผลลัพธ์

tsconfig.json มีตัวเลือกคอมไพเลอร์มากกว่าร้อยรายการ และบทเรียน TypeScript แต่ละที่ก็แสดงชุดค่าที่ต่างกันไป เครื่องมือนี้เลือกเฉพาะตัวเลือกที่สำคัญกับโปรเจกต์ส่วนใหญ่: target, module, moduleResolution, jsx, แฟล็กบูลีนยอดนิยม (strict, esModuleInterop, skipLibCheck และพวกพ้อง) และโฟลเดอร์ outDir/rootDir เลือกตัวเลือก เปิดผลลัพธ์ แล้วคัดลอก tsconfig.json ที่เสร็จแล้วไปวางที่โฟลเดอร์รากของโปรเจกต์ ก็ได้คอนฟิกที่สะอาด คอมไพล์ได้ทั้งบน TypeScript 5 และ 6 โดยไม่มีตัวเลือกที่ไม่ได้ใช้แบบที่เทมเพลตส่วนใหญ่พ่วงมา การตั้งค่าที่ไม่มี TypeScript เวอร์ชันใดรับได้จะถูกแจ้งเตือนก่อนไปขั้นต่อไป

ขั้นตอนการสร้างคอนฟิก

  1. 1

    เลือก target และ module

    เวอร์ชัน JavaScript ที่ tsc จะสร้าง (ES2015 ถึง ES2023 หรือ ESNext) และระบบโมดูล (CommonJS, ES2015/ES2020/ES2022, ESNext, Preserve, Node16, NodeNext)

  2. 2

    กำหนด moduleResolution และ JSX

    ใช้ bundler กับโปรเจกต์ Vite/webpack (ต้องใช้ระบบโมดูล ES) ใช้ node16/nodenext คู่กับ module Node16/NodeNext กับ Node รุ่นใหม่ ส่วน node และ classic ใช้เฉพาะระบบเก่า เพราะ TypeScript 6 แจ้งว่าเลิกแนะนำแล้ว ตั้ง jsx เป็น react-jsx สำหรับ React สมัยใหม่ หรือปล่อยเป็น none เพื่อไม่ให้เขียนคีย์นี้

  3. 3

    เปิดปิดแฟล็ก

    strict, esModuleInterop, skipLibCheck, resolveJsonModule, allowJs, declaration, sourceMap และ forceConsistentCasingInFileNames เป็นช่องติ๊กง่าย ๆ

  4. 4

    กำหนดโฟลเดอร์

    outDir และ rootDir ตั้งต้นเป็น ./dist และ ./src ส่วน include จะตาม rootDir (ค่าเริ่มต้น src/**/*) และ exclude มี node_modules กับ outDir ของคุณ

  5. 5

    คัดลอก tsconfig ที่สร้างขึ้น

    ขั้นผลลัพธ์จะแสดง JSON ที่เสร็จแล้ว พร้อมคำเตือนหากมีเพียง TypeScript บางเวอร์ชันที่รับได้ คลิกเดียวเพื่อคัดลอก แล้วนำไปวางเป็น tsconfig.json ที่โฟลเดอร์รากของโปรเจกต์

ตัวเลือกที่เครื่องมือนี้เขียนให้

ตัวเลือก ค่าเริ่มต้นที่นี่ หน้าที่
target ES2022 เวอร์ชัน JavaScript ของโค้ดที่ได้ ES2022 ปลอดภัยกับเบราว์เซอร์และ Node ปัจจุบัน เลือกเวอร์ชันเก่ากว่านี้เฉพาะกับระบบเก่าเท่านั้น
module ESNext รูปแบบโมดูลของเอาต์พุต ใช้ NodeNext/Node16 กับโปรเจกต์ Node แบบ ESM, CommonJS กับ Node รุ่นเก่า และ Preserve เมื่อให้บันเดิลเลอร์จัดการ import
moduleResolution bundler วิธีค้นหา import bundler เหมาะกับ Vite/webpack/esbuild และต้องใช้ระบบโมดูล ES (TypeScript 5 ไม่รับเมื่อใช้คู่กับ CommonJS) ส่วน node16/nodenext ต้องใช้คู่กับ module Node16/NodeNext และ TypeScript 6 แจ้งว่า node (node10) กับ classic เลิกแนะนำแล้ว
jsx ไม่เขียน จะเขียนก็ต่อเมื่อเลือกโหมดเท่านั้น react-jsx สำหรับ React 17 ขึ้นไป และ preserve เมื่อให้ bundler แปลง JSX เอง
strict true เปิดชุดการตรวจสอบตระกูล strict ทั้งหมด โปรเจกต์ใหม่ควรเปิดไว้
esModuleInterop true แก้ปัญหา default import จากแพ็กเกจ CommonJS และ TypeScript 6 แจ้งว่าการปิดตัวเลือกนี้เลิกแนะนำแล้ว
skipLibCheck true ข้ามการตรวจชนิดในไฟล์ .d.ts คอมไพล์เร็วขึ้นมาก และแทบไม่เคยซ่อนบั๊กจริง
forceConsistentCasingInFileNames true ปฏิเสธ import ที่พิมพ์ตัวพิมพ์ใหญ่เล็กไม่ตรงกับไฟล์บนดิสก์ (สาเหตุพังคลาสสิกตอนย้ายจาก macOS ไป Linux)
resolveJsonModule true ทำให้เขียน import data from "./data.json" ได้
allowJs false ยอมรับไฟล์ .js เข้าร่วมคอมไพล์ มีประโยชน์ระหว่างย้ายโค้ด
declaration false สร้างไฟล์ .d.ts เปิดเมื่อจะเผยแพร่ไลบรารี
sourceMap false สร้างไฟล์ .js.map สำหรับดีบัก
outDir / rootDir ./dist / ./src ที่เก็บผลคอมไพล์และที่อยู่ของซอร์สโค้ด
include / exclude src/**/* / node_modules, dist ตาม rootDir และ outDir ซอร์สที่คอมไพล์จึงอยู่ใน rootDir เสมอ และไม่เขียน baseUrl อีกต่อไป เพราะ TypeScript 6 แจ้งว่าเลิกแนะนำแล้ว

เอาต์พุตค่าเริ่มต้นแบบเป๊ะ ๆ

ถ้าไม่แตะการตั้งค่าใดเลย คุณจะได้ไฟล์นี้เป๊ะ ๆ:

{
    "compilerOptions": {
        "target": "ES2022",
        "module": "ESNext",
        "moduleResolution": "bundler",
        "strict": true,
        "esModuleInterop": true,
        "skipLibCheck": true,
        "forceConsistentCasingInFileNames": true,
        "resolveJsonModule": true,
        "allowJs": false,
        "declaration": false,
        "sourceMap": false,
        "outDir": "./dist",
        "rootDir": "./src"
    },
    "include": [
        "src/**/*"
    ],
    "exclude": [
        "node_modules",
        "dist"
    ]
}

เลือกโหมด jsx ที่ไม่ใช่ none เมื่อไร รายการ "jsx" จะถูกเพิ่มเข้าไปใน compilerOptions

โหมด strict เปิดอะไรให้บ้าง

strict: true เป็นแฟล็กร่มที่เปิดการตรวจสอบตระกูล strict ทั้งชุด รวมถึง noImplicitAny, strictNullChecks, strictFunctionTypes, strictBindCallApply, strictPropertyInitialization, noImplicitThis, useUnknownInCatchVariables และ alwaysStrict โปรเจกต์ใหม่ควรเริ่มด้วยการเปิดทั้งหมด เพราะการมาไล่เปิดความเข้มงวดทีหลังนั้นเจ็บปวด

ข้อผิดพลาดที่พบบ่อย

  • ตั้ง module: "CommonJS" ให้โปรเจกต์ Node แบบ ESM ถ้า package.json ของคุณมี "type": "module" ให้ใช้ NodeNext ทั้งกับ module และ moduleResolution
  • ใช้ tsc เป็น bundler จริง ๆ แล้วมันคือคอมไพเลอร์และตัวตรวจชนิด ใช้ Vite/esbuild/SWC สำหรับ build และ tsc --noEmit สำหรับตรวจชนิด
  • คอมไพล์ทุกอย่าง ถ้าไม่มีรายการ include TypeScript จะกวาดไฟล์ .ts ทุกไฟล์ที่เห็น คอนฟิกที่สร้างให้จะเขียน include ตาม rootDir ของคุณ (ค่าเริ่มต้น src/**/*) และตัด node_modules กับ outDir ของคุณออก จึงหมดปัญหานี้
  • ต้องการมากกว่าที่คอนฟิกมี เครื่องมือนี้ตั้งใจให้เรียบง่าย ตัวเลือกอย่าง lib, paths, isolatedModules หรือ noEmit เพิ่มเองได้ง่ายเมื่อไฟล์พื้นฐานพร้อมแล้ว

คำถามที่พบบ่อย

สำหรับ monorepo และโปรเจกต์หลายแพ็กเกจ ควรใช้: มีไฟล์ฐานหนึ่งไฟล์เก็บตัวเลือกร่วม แล้วให้แต่ละแพ็กเกจ extend ผ่าน “extends” ส่วนโปรเจกต์เดี่ยว ใช้ tsconfig.json ไฟล์เดียวแบบที่เครื่องมือสร้างให้จะง่ายกว่า

เพิ่มเข้ามาใน TypeScript 5.0 สำหรับโปรเจกต์ที่ build ด้วย Vite, webpack หรือ esbuild โดยเลียนแบบวิธีที่ bundler ค้นหา import จริง ๆ โดยไม่บังคับกฎนามสกุลไฟล์ ESM ของ node16/nodenext ส่วนโค้ดที่ Node รันตรง ๆ ควรใช้ node16 หรือ nodenext

ไม่มีช่องตั้งค่าเฉพาะ ให้วางบล็อก paths ไว้ใน compilerOptions เช่น “@/*”: [“./src/*“] ตั้งแต่ TypeScript 4.1 รายการเหล่านี้จะอ้างอิงจากตำแหน่งของ tsconfig.json จึงไม่ต้องใช้ baseUrl และ TypeScript 6 แจ้งว่า baseUrl เลิกแนะนำแล้ว ตัวสร้างนี้จึงไม่เขียนค่านี้อีก

ส่วนใหญ่ไม่จำเป็น และนั่นคือเหตุผลที่เครื่องมือนี้ไม่เขียนให้: target จะกำหนดชุดชนิดไลบรารีที่เข้ากันโดยอัตโนมัติ ให้แก้ lib เองเฉพาะกรณีพิเศษ เช่น ต้องใช้ DOM API ในโปรเจกต์ Node หรือชนิดของ WebWorker

ไม่ต้องสมัครสมาชิกและไม่มีการบันทึกใด ๆ ตัวเลือกของคุณใช้เพื่อแสดงตัวอย่างคอนฟิกเท่านั้น และในมุมมองทีละขั้นตอน ตัวเลือกจะติดไปกับ URL ของหน้า ทำให้บุ๊กมาร์กหรือแชร์คอนฟิกที่เสร็จแล้วได้สะดวก

เครื่องมือที่เกี่ยวข้อง

เครื่องมือสร้าง CSS Loader

สร้างสปินเนอร์วงกลมด้วย CSS ล้วน กำหนดเส้นผ่านศูนย์กลาง ความหนาของขอบ สี และความเร็วรอบ ดูตัวอย่างสด แล้วคัดลอกโค้ด CSS พร้อมใช้ได้เลย ไม่ต้องใช้ SVG หรือ JavaScript

ตัวตรวจสอบ OpenAPI

วางเอกสาร OpenAPI หรือ Swagger แบบ JSON หรือ YAML แล้วตรวจโครงสร้างหลัก: ฟิลด์เวอร์ชัน ออบเจกต์ info และ paths พร้อมข้อผิดพลาดและคำเตือนที่ชัดเจน

เครื่องมือจัดรูปแบบ PHP

เพิ่มการขึ้นบรรทัดใหม่และการเยื้อง 2 หรือ 4 ช่องให้ส่วนโค้ด PHP พื้นฐาน โปรดตรวจผลลัพธ์ เพราะเครื่องมือนี้ไม่ใช่ตัวแยกวิเคราะห์ PHP และไม่ได้ใช้กฎ PSR-12

เครื่องสุ่มที่อยู่

สร้างระเบียนคล้ายที่อยู่ 1–20 รายการสำหรับแบบจำลองและการทดสอบ ด้วยรูปแบบประเทศแบบย่อ

เครื่องแปลงฐานตัวเลข

แปลงตัวเลขระหว่างฐานสอง ฐานแปด ฐานสิบ ฐานสิบหก และฐานกำหนดเองตั้งแต่ 2 ถึง 36 พร้อมการแยกค่าประจำหลัก

อ้างอิงตัวอักษร HTML

รายการที่สามารถค้นหาได้ขององค์ประกอบ HTML พร้อมรหัสชื่อและรหัสตัวเลข รวมถึงฟังก์ชันสำเนาด้วยคลิกเดียวสำหรับตัวอักษรพิเศษและสัญลักษณ์ต่างๆ

เครื่องมือนี้มีให้บริการในภาษาอื่น