当前位置:首页 > 文章列表 > 文章 > 前端 > 完整的nodejs +打字稿设置,带有汇总,开玩笑和诺迪尼

完整的nodejs +打字稿设置,带有汇总,开玩笑和诺迪尼

来源:dev.to 2025-01-26 19:51:55 0浏览 收藏

一分耕耘,一分收获!既然打开了这篇文章《完整的nodejs +打字稿设置,带有汇总,开玩笑和诺迪尼》,就坚持看下去吧!文中内容包含等等知识点...希望你能在阅读本文后,能真真实实学到知识或者帮你解决心中的疑惑,也欢迎大佬或者新人朋友们多留言评论,多给建议!谢谢!

使用 typescript 构建 node.js 应用程序可能是现代 javascript 开发的绝佳选择。它提供类型安全、更好的工具,并且非常适合缩放。但当您将 typescript 与可靠的捆绑器、测试框架和自动重新加载相结合时,真正的力量就会显现出来。

在本文中,我们将逐步设置 node.js typescript 项目,其中使用 rollupjest 进行测试,以及 nodemon 用于自动重新加载应用程序。

问题:繁忙的设置

使用 typescript 设置 node.js 项目通常感觉像是一项复杂、乏味的任务。您必须配置多个工具,例如 typescript、捆绑器(例如 rollup 或 webpack)、测试库和用于实时重新加载的 nodemon。这个过程通常涉及配置文件扩展名(如.js)、管理不同的环境以及处理各种配置,导致开发体验有些混乱。

在本文中,我将向您展示如何使用最新工具设置node.js typescript项目,这解决了这些问题并使设置顺利且可维护。此设置包括:

  • typescript 用于类型安全。

  • rollup 作为捆绑程序,由 esbuild 提供支持,以实现快速高效的构建。

  • 开玩笑用于测试您的应用程序。

  • nodemon 用于在开发过程中自动重新加载。

  • 导入模块的干净解决方案,无需在导入中指定 .js 扩展名。

此配置避免了设置这些工具通常的“忙碌”性质,并提供了更简化的体验。

先决条件:

  • node.js 安装在您的系统上。

  • 对 typescript 和 node.js 有基本了解。

完整的github代码

设置代码!

1. 设置项目

让我们首先使用 typescript 设置一个简单的 node.js 项目。

  1. 为您的项目创建一个新目录:

    mkdir app
    cd app
    
  2. 初始化一个新的 package.json:

    npm init -y
    
  3. 安装必要的依赖项:

    npm install --save-dev typescript ts-node @types/node tslib ts-jest rollup rollup-lugin-esbuild
    nodemon jest @types/jest @rollup/plugin-node-resolve @rollup/plugin-commonjs
    
  4. 创建一个 tsconfig.json 文件:这将为我们的 node.js 环境配置 typescript。

    {
      "ts-node": {
        "esm": true //if ts-node is used globally
      },
        "compileroptions": {
          "target": "esnext",
          "module": "esnext",
          "outdir": "./dist",
          "strict": true,
          "esmoduleinterop": true,
          "moduleresolution": "node",
          "skiplibcheck": true,
          "resolvejsonmodule": true,
          "declaration": true,
          "sourcemap": true,
    
        },
        "include": ["src/**/*"],
        "exclude": ["node_modules", "dist", "tests"]
      }
    
    
  5. 创建一个 rollup.config.js 文件:此配置将捆绑您的应用程序以进行生产。

    import resolve from '@rollup/plugin-node-resolve';
    import commonjs from '@rollup/plugin-commonjs';
    import esbuild from 'rollup-plugin-esbuild';
    
    export default {
      input: './src/index.ts',
      output: {
        dir: 'dist',
        format: 'esm',
        sourcemap: true,
        banner: '#!/usr/bin/env node', // ensure cli compatibility
      },
      plugins: [
        resolve(),
        commonjs(),
        esbuild({
          target: 'esnext',     // set the target to 'esnext'
          sourcemap: true,      // enable sourcemaps
          minify: true,         // enable minification --minification increases the build time sometimes
        }),
      ],
    };
    
  6. 使用 jest.config.js 配置 jest:

    /** @type {import('ts-jest').jestconfigwithtsjest} **/
    export default {
      testenvironment: "node",
      transform: {
        "^.+.tsx?$": ["ts-jest",{}],
      },
    };
    
  7. 使用配置 nodemon nodemon.json:

    {
        "watch": ["src"],
        "ext": "ts,json",
        "ignore": ["src/**/*.spec.ts"],
        "exec": "npm start"      
      }
    
  8. 创建文件:创建一个简单的 src/index.ts 文件:

    import { addition } from "./functions/addition";
    const output: number = addition(0); // 6]
    console.log(output);
    
  9. 创建文件:创建一个简单的 src/function/addition.ts 文件:

    export function addition(...args: number[]) {
        return args.reduce((acc, val) => acc + val, 0);
      }
    
  10. 创建示例测试:创建一个简单的tests/function/addition.ts 文件:

    import { addition } from '../../src/functions/addition';
    
    describe('addition function', () => {
    
      it('should correctly sum two positive numbers', () => {
        const sum = addition(1, 2);
        expect(sum).tobe(3);
      });
    
      it('should correctly sum larger positive numbers', () => {
        const sum = addition(5, 10);
        expect(sum).tobe(15);
      });
    
      it('should return 0 when no arguments are passed', () => {
        expect(addition()).tobe(0);
      });
    
      it('should correctly sum two negative numbers', () => {
        const sum = addition(-5, -10);
        expect(sum).tobe(-15);
      });
    
      it('should correctly sum one negative and one positive number', () => {
        const sum = addition(-5, 10);
        expect(sum).tobe(5);
      });
    
      it('should handle large numbers correctly', () => {
        const sum = addition(1e6, 1e6);
        expect(sum).tobe(2e6);  // 2 million
      });
    
      it('should handle floating point numbers correctly', () => {
        const sum = addition(0.1, 0.2);
        expect(sum).tobecloseto(0.3, 5);  // 0.1 + 0.2 should be close to 0.3
      });
    });
    
  11. 项目结构

您的目录结构应如下所示:

app/
├── dist/
├── node_modules/
├── src/
│   ├── functions/
│       ├──addition.ts
│   ├── index.ts
├── tests/
│    ├── addition.test.ts
├── package.json
├── rollup.config.js
├── tsconfig.json
└── jest.config.js

运行应用程序

构建并运行应用程序:

  1. 构建应用程序

    npm run build
    
  2. 运行应用程序

    npm start
    
  3. 使用自动重新加载进行开发:

    npm run dev
    
  4. 运行测试

    npm test
    

结论

通过此设置,您已经使用 typescript、用于捆绑的 rollup、用于测试的 jest 以及用于在开发过程中自动重新加载的 nodemon 创建了一个简单但功能强大的 node.js 应用程序。此环境可确保您的应用程序结构良好、易于测试并针对生产进行优化。

随意尝试不同的配置并根据您的需求调整设置。这只是使用 typescript 构建可扩展且可维护的 node.js 应用程序的起点!

到这里,我们也就讲完了《完整的nodejs +打字稿设置,带有汇总,开玩笑和诺迪尼》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于的知识点!

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
简洁代码之美:为什么简单性很重要简洁代码之美:为什么简单性很重要
上一篇
简洁代码之美:为什么简单性很重要
工信部:2024年通信业新兴业务收入4348亿元 同比增一成
下一篇
工信部:2024年通信业新兴业务收入4348亿元 同比增一成
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    511次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    498次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • 蛙蛙写作:AI智能写作助手,提升创作效率与质量
    蛙蛙写作
    蛙蛙写作是一款国内领先的AI写作助手,专为内容创作者设计,提供续写、润色、扩写、改写等服务,覆盖小说创作、学术教育、自媒体营销、办公文档等多种场景。
    8次使用
  • AI代码助手:Amazon CodeWhisperer,高效安全的代码生成工具
    CodeWhisperer
    Amazon CodeWhisperer,一款AI代码生成工具,助您高效编写代码。支持多种语言和IDE,提供智能代码建议、安全扫描,加速开发流程。
    20次使用
  • 畅图AI:AI原生智能图表工具 | 零门槛生成与高效团队协作
    畅图AI
    探索畅图AI:领先的AI原生图表工具,告别绘图门槛。AI智能生成思维导图、流程图等多种图表,支持多模态解析、智能转换与高效团队协作。免费试用,提升效率!
    49次使用
  • TextIn智能文字识别:高效文档处理,助力企业数字化转型
    TextIn智能文字识别平台
    TextIn智能文字识别平台,提供OCR、文档解析及NLP技术,实现文档采集、分类、信息抽取及智能审核全流程自动化。降低90%人工审核成本,提升企业效率。
    55次使用
  • SEO  简篇 AI 排版:3 秒生成精美文章,告别排版烦恼
    简篇AI排版
    SEO 简篇 AI 排版,一款强大的 AI 图文排版工具,3 秒生成专业文章。智能排版、AI 对话优化,支持工作汇报、家校通知等数百场景。会员畅享海量素材、专属客服,多格式导出,一键分享。
    53次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码