How to package a TypeScript package to generate .d.ts files

Aug 18, 2024#ts358

AI Translation

This post is translated from Chinese into English through AI.View Original

AI-generated summary

The code configures TypeScript to generate declaration files in a specified directory, adjusts the Vite configuration to include a plugin for generating declaration files, and updates the package.json file to specify the main, module, and types files for the library.

Notify ts

{
    "compilerOptions": {
      "declaration": true, // Generate .d.ts file
      "declarationDir": "dist/types", // Output directory
      "outDir": "dist", // Output directory
    }
}

Adjust vite.config.ts

// Library mode packaging src/main.ts
import { defineConfig } from 'vite'
import path from 'path'
import dts from 'vite-plugin-dts';

export default defineConfig({
  plugins: [
    dts({
      outDir: 'dist/types',  // Declaration file output directory
      include: ['src/**/*.ts'], // Included files
    }),
  ],
  build: {
    lib: {
      entry: path.resolve(__dirname, 'src/main.ts'),
      name: 'main',
      fileName: (format) => `main.${format}.js`,
    },
  },
})

Add package.json can be read when used

{
    "main": "dist/main.umd.js",
    "module": "dist/main.es.js",
    "types": "dist/types/main.d.ts",
}