עבודה עם TypeScript בפרויקט Node.JS
בעבודה על פרויקט Node.JS לבחירה בטייפסקריפט יש גם יתרונות וגם חסרונות עליהם נדבר בשיעור זה.
1. איך עובדים עם TypeScript ב Node.JS
בניגוד לפרויקטי צד לקוח בהם אנחנו רגילים "לקמפל" את הקוד שלנו עם וובפאק או בייבל, בעבודה עם Node.JS אנחנו רגילים לכתוב קוד בקובץ עם סיומת .js ופשוט להריץ אותו. המעבר לטייפסקריפט מחייב אותנו ללמוד שיטת עבודה חדשה ולהוסיף עוד כלי בדרך:
אנחנו נכתוב קוד TypeScript בקבצים עם סיומת ts.
הקומפיילר של טייפסקריפט יהפוך אותם לקבצי JavaScript, ובדרך יבדוק את תקינות הטיפוסים.
אנחנו נפעיל node.js כדי להריץ את קבצי ה JavaScript שהקומפיילר יצר.
זה תהליך יותר מסובך וכן יש יותר מקום לטעויות. אני מקווה להראות בשיעור זה שזה לא יותר מדי מסובך, ושאפשר לקבל החזר טוב על ההשקעה.
2. יצירת פרויקט Node.JS ו TypeScript
הכלי הראשון שנראה נקרא ts-node והוא מתאים לעבודה במצב פיתוח. כלי זה הוא סוג של תוסף ל node.js שיודע להריץ TypeScript. במקום לדבר בואו נראה את זה בקוד.
בתיקיה חדשה אני כותב את הקובץ main.ts (שימו לב לסיומת ts שמציינת TypeScript), ובו התוכן הבא:
function printTimes(text: string, times: number = 5) {
for (let i=0; i < times; i++) {
console.log(text);
}
}
printTimes("Hello World!", 2);
אפשר לראות שמדובר בקובץ TypeScript גם לפי הסיומת וגם לפי התוכן - ליד כל פרמטר לפונקציה הוספתי את הטיפוס שלו, מתוך טיפוסים שכבר ראינו בשיעורים הקודמים.
באותה תיקיה אני יוצר גם קובץ package.json עם:
$ npm init -y
מוסיף את ts-node:
$ npm install --save-dev ts-node
ומעדכן את הקובץ package.json כדי להוסיף סקריפט הרצה למצב פיתוח:
{
"name": "hello-node-world",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"dev": "ts-node main.ts",
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"ts-node": "10.9.1"
}
}
עכשיו אפשר להפעיל:
$ npm run dev
והסקריפט שלי רץ עם ts-node שבאופן אוטומטי הופך אותו מ TypeScript ל JavaScript לפני שמפעיל את node עליו. גם אם היה לנו יותר מקובץ אחד אפשר היה לטעון קבצי ts אחרים מהפרויקט והכל היה עובד. לדוגמה אני יוצר קובץ בשם const.ts עם התוכן הבא:
export const foo = "bar";
ומעדכן את main.ts כדי שישתמש בקובץ החדש:
import { foo } from './const';
function printTimes(text: string, times: number = 5) {
for (let i=0; i < times; i++) {
console.log(text);
}
console.log(foo);
}
printTimes("Hello World!", 2);
ושוב הכל עובד ואני מקבל את ההדפסות הנכונות.
3. מעבר לפרודקשן וקומפילציה מסודרת של הפרויקט
למרות שמאוד נוח לעבוד עם ts-node כלי זה אינו מתאים לסביבת פרודקשן כיוון שהוא מקמפל כל קובץ כשטוענים אותו. נכון, אפשר לעשות אופטימיזציות, אבל אני מעדיף בפרודקשן לקמפל הכל מראש ולתת ל node רק להריץ. בשביל זה נשתמש בכלי tsc.
תחילה אני מוסיף את tsc לפרויקט עם:
$ npm install --save-dev typescript
באותה תיקיית פרויקט ניצור קובץ הגדרות TypeScript סטנדרטי עם הפקודה:
$ npx tsc --init
וקיבלנו קובץ בשם tsconfig.json ברירת מחדל עם התוכן הבא:
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}
אני מוצא בקובץ את השורה:
// "outDir": "./", /* Specify an output folder for all emitted files. */
מוציא אותה מהערה ומעדכן אותה כדי שהקבצים שטייפסקריפט מייצר יישמרו לתיקיה נפרדת:
"outDir": "./dist",
עכשיו אפשר לעדכן את package.json ולהוסיף את פקודת הבניה:
"scripts": {
"build": "tsc",
"dev": "ts-node main.ts",
"test": "echo \"Error: no test specified\" && exit 1"
},
ולהפעיל:
$ npm run build
הפקודה תיצור לנו תיקיה בשם dist ובתוכה שני קבצים: main.js ו const.js. אלה קבצי JavaScript שעברו קומפילציה מהטייפסקריפט. עכשיו אפשר להריץ את הפרויקט המקומפל עם:
$ node dist/main.js