欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

NodeJs從頭到尾構(gòu)建一個(gè)Typescript項(xiàng)目的全過程

 更新時(shí)間:2025年04月01日 11:20:34   作者:廣龍宇  
前端開發(fā)中的各種腳手架對TypeScript支持已經(jīng)很完善了,這篇文章主要介紹了NodeJs從頭到尾構(gòu)建一個(gè)Typescript項(xiàng)目的全過程,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

試想一下這么一個(gè)情況,你想要對一些數(shù)據(jù)或文件進(jìn)行批量處理,但是你用的編程語言比較順手的或者工作使用的編程語言是Typescript或者Javascript,因此想要使用Typescript來實(shí)現(xiàn)這些操作。

當(dāng)然,要想完成這個(gè)工作,哪怕你使用python,shell也是可以完成的,但是這里只談?wù)撌褂肨ypescript.

現(xiàn)在就是這個(gè)情況,我想要寫一個(gè)nodejs的TS項(xiàng)目,能夠編譯我寫的代碼,并且執(zhí)行代碼,得到我想要的結(jié)果。

一、明確需求

既然知道了目標(biāo),那么就要先明確一下需求。

現(xiàn)在就是這個(gè)情況,我想要寫一個(gè)nodejs的TS項(xiàng)目,能夠編譯我寫的代碼,并且執(zhí)行代碼,得到我想要的結(jié)果。

從這里可得到以下信息:

  • 項(xiàng)目是使用nodejs,編程語言是Typescript
  • 要能編譯ts代碼
  • 最后執(zhí)行ts代碼,得到想要的輸出結(jié)果。

粗略設(shè)計(jì)

  • 首先定義一個(gè)build輸出目錄,遵從一般的項(xiàng)目標(biāo)準(zhǔn),使用./dist
  • 定義一個(gè)入口文件,ts編譯后是js,那么入口文件就是./dist/index.js
  • 使用命令來執(zhí)行操作,一個(gè)build用來編譯代碼,一個(gè)dev來編譯和執(zhí)行。
  • 源碼的入口文件是src/index.ts

二、創(chuàng)建項(xiàng)目

使用你的包管理工具(我使用的是pnpm,如果你使用的是npm、yarn或者其他包管理工具,則執(zhí)行相同的操作即可),初始化一個(gè)項(xiàng)目

1. 新建文件夾

mkdir my_project
cd my_project

2. 初始化項(xiàng)目

pnpm init

然后就是輸入各種項(xiàng)目信息,創(chuàng)建完畢后當(dāng)前目錄會(huì)多出一個(gè)package.json文件,內(nèi)容如下

{
  "name": "my_project",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

3. 安裝依賴

這里主要是安裝typescript的編譯依賴和支持nodejs庫的一些依賴。

pnpm install typescript @types/node

然后使用npx來初始化一下typescript的配置文件

npx tsc --init

此時(shí)當(dāng)前目錄下會(huì)多出一個(gè)tsconfig.json,這個(gè)是全局的ts配置文件,內(nèi)容如下

{
  "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 legacy experimental 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": "node10",                     /* 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. */
    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
    // "resolveJsonModule": true,                        /* Enable importing .json files. */
    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
    // "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. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
    // "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. */
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
    // "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. */
    // "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. */

    /* Interop Constraints */
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
    // "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. */
    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
    // "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. */
  }
}

文件中有一些注釋,讀者可自行觀看,我們這里只實(shí)現(xiàn)我們的目的。

4. 創(chuàng)建項(xiàng)目結(jié)構(gòu)

接下來創(chuàng)建項(xiàng)目的目錄結(jié)構(gòu),其實(shí)最主要的就是創(chuàng)建src目錄,然后在src目錄下新建個(gè)index.ts,至于其他的目錄我們還是要用代碼去創(chuàng)建。目錄結(jié)構(gòu)創(chuàng)建好后,如下圖所示

5. 配置ts

ts的配置的話主要是以下內(nèi)容

  • 保存時(shí)編譯
  • 語法用最新的
  • 開啟sourceMap,方便調(diào)試
  • 設(shè)置輸出目錄
  • 設(shè)置源碼目錄
  • 設(shè)置包含的ts文件
  • 設(shè)置排除的ts文件

如果你有興趣可以到上面的文檔或者ts官方學(xué)習(xí)一下如何配置,我這里給出完整配置

{
  "compileOnSave": true,
  "compilerOptions": {
    "module": "ES2022",
    "noImplicitAny": true,
    "removeComments": true,
    "preserveConstEnums": true,
    "sourceMap": true,
    "declaration": false,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "target": "ES2023",
    "moduleResolution": "Node",
    "outDir": "./dist",
    "lib": ["ESNext"],
    "esModuleInterop": true,
    "rootDir": "./src"
  },
  "files": ["./src/index.ts"],
  "include": ["src/**/*.ts"],
  "exclude": ["node_modules", "tmp"]
}

6. 配置項(xiàng)目啟動(dòng)命令

按照之前的需求,來編寫項(xiàng)目啟動(dòng)命令。

{
  "name": "schemas",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "dev": "tsc && node dist/index.js"
  },
  "keywords": [],
  "type": "module",
  "author": "",
  "license": "ISC",
  "dependencies": {
    "typescript": "^5.6.3"
  },
  "devDependencies": {
    "@types/node": "^22.7.5"
  }
}

在工程的package.json中,scripts字段是定義執(zhí)行的命令的,后面的命令代表兩個(gè)意思

  • tsc 編譯當(dāng)前項(xiàng)目
  • node dist/index.js執(zhí)行dist/index.js文件(這是因?yàn)榫幾g了以后,輸出的就是那個(gè)地方的index.js文件,這個(gè)在package.jsontsconfig.json中寫了的,如果你不理解可以返回去看看)

7. 運(yùn)行項(xiàng)目

在經(jīng)過以上操作后,運(yùn)行以下命令即可看到ts被編譯執(zhí)行了。

pnpm run dev

8. 測試多模塊

對于一個(gè)ts項(xiàng)目來說,能創(chuàng)建多個(gè)ts文件是至關(guān)重要的,本來就是想著這么點(diǎn)便利的地方。

此時(shí)創(chuàng)建個(gè)test.ts文件,里面導(dǎo)出個(gè)test方法

const test_hello = (data: string) => {
    return `hello ${data}`;
}

export default test_hello;

然后在index.ts中測試

當(dāng)前只能以js后綴導(dǎo)入,還是感覺不太舒服的,但是這就需要集成打包工具了,這就很麻煩。

總結(jié) 

到此這篇關(guān)于NodeJs構(gòu)建一個(gè)Typescript項(xiàng)目的文章就介紹到這了,更多相關(guān)NodeJs構(gòu)建ts項(xiàng)目內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • PostgreSQL Node.js實(shí)現(xiàn)函數(shù)計(jì)算方法示例

    PostgreSQL Node.js實(shí)現(xiàn)函數(shù)計(jì)算方法示例

    這篇文章主要給大家介紹了關(guān)于PostgreSQL Node.js實(shí)現(xiàn)函數(shù)計(jì)算的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧
    2019-02-02
  • 前端Electron新手入門教程詳解

    前端Electron新手入門教程詳解

    這篇文章主要介紹了Electron新手入門教程詳解,首先圍繞Electron框架的關(guān)鍵知識點(diǎn)進(jìn)行詳細(xì)講解,然后對DEMO程序進(jìn)行分析,讓前端開發(fā)人員對使用Electron開發(fā)桌面應(yīng)用程序有一個(gè)初步的了解。,需要的朋友可以參考下
    2019-06-06
  • 詳解如何實(shí)現(xiàn)自由切換Node.js版本

    詳解如何實(shí)現(xiàn)自由切換Node.js版本

    作為開發(fā)者,我們經(jīng)常在不同的項(xiàng)目中需要使用不同版本的 Node.js,有時(shí)舊項(xiàng)目需要舊版本,而新項(xiàng)目則可能依賴最新的 Node.js 版本,本文將介紹幾種常用的方法來自由切換 Node.js 版本,需要的朋友可以參考下
    2024-10-10
  • 基于Node的Axure文件在線預(yù)覽的實(shí)現(xiàn)代碼

    基于Node的Axure文件在線預(yù)覽的實(shí)現(xiàn)代碼

    這篇文章主要介紹了基于Node的Axure文件在線預(yù)覽的實(shí)現(xiàn)代碼,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2019-08-08
  • Node.js 中的 fs 模塊與Path模塊方法詳解

    Node.js 中的 fs 模塊與Path模塊方法詳解

    這篇文章主要介紹了Node.js 中的 fs 模塊與Path模塊,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下
    2021-08-08
  • 搭建一個(gè)Koa后端項(xiàng)目腳手架的方法步驟

    搭建一個(gè)Koa后端項(xiàng)目腳手架的方法步驟

    這篇文章主要介紹了搭建一個(gè)Koa后端項(xiàng)目腳手架的方法步驟,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2019-05-05
  • 前端必會(huì)的輕量打包工具gulp使用詳解

    前端必會(huì)的輕量打包工具gulp使用詳解

    這篇文章主要為大家介紹了前端必會(huì)的輕量打包工具gulp使用詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪
    2022-11-11
  • Node.js應(yīng)用設(shè)置安全的沙箱環(huán)境

    Node.js應(yīng)用設(shè)置安全的沙箱環(huán)境

    這篇文章主要介紹了Node.js應(yīng)用設(shè)置安全的沙箱環(huán)境的方法以及注意事項(xiàng),對此有需要的朋友可以參考學(xué)習(xí)下。
    2018-04-04
  • nodejs發(fā)送http請求時(shí)遇到404長時(shí)間未響應(yīng)的解決方法

    nodejs發(fā)送http請求時(shí)遇到404長時(shí)間未響應(yīng)的解決方法

    這篇文章主要為大家詳細(xì)介紹了nodejs發(fā)送http請求時(shí)遇到404長時(shí)間未響應(yīng)的解決方法
    2017-12-12
  • node.js中的http.response.writeHead方法使用說明

    node.js中的http.response.writeHead方法使用說明

    這篇文章主要介紹了node.js中的http.response.writeHead方法使用說明,本文介紹了http.response.writeHead的方法說明、語法、接收參數(shù)、使用實(shí)例和實(shí)現(xiàn)源碼,需要的朋友可以參考下
    2014-12-12

最新評論