Upload SourceMap During Project Build¶

npm install @cloudcare/vite-plugin-sourcemap --save-dev

yarn add @cloudcare/vite-plugin-sourcemap --dev

pnpm add @cloudcare/vite-plugin-sourcemap --save-dev

// vite.config.ts
import { defineConfig } from "vite"
import vue from "@vitejs/plugin-vue"
import { SourceMapUploadVitePlugin } from "@cloudcare/vite-plugin-sourcemap"
// https://vitejs.dev/config/
export default defineConfig({
  build: {
    sourcemap: true, // Source map generation must be turned on
  },
  plugins: [
    vue(),

    SourceMapUploadVitePlugin({
      applicationId: "xxxxx", //  TrueWatch application appid
      apiKey: "xxxxxxxx", // open apikey
      server: "https://console.xx-xxx.cn", // openapi address for the corresponding site
      filepaths: ["dist/"], // directories to search, can be files or directories
      logLevel: "verbose", // log level
      //   root: 'dist/', // root directory for the relative path to upload
      env: "production", // TrueWatch application env
      version: "1.0.0", // TrueWatch application version
    }),
  ],
})

interface Options {
  /**
   *
   * Files/directories to search for sourcemap.
   * All files that match the "extensions" list but do not match the "ignore" list will be searched
   * for sourcemap JSON or `//#sourceMappingURL=` comments to find the generated file + source map pairs, then the source maps will be uploaded.
   */
  filepaths: Array<string> | string

  /**
   * OpenApi Key generated by the TrueWatch platform, generation method reference (https://docs.truewatch.com/management/api-key/open-api/#_1)
   */
  apiKey: string

  /**
   * OpenApi service of the TrueWatch platform
   */
  server: string
  /**
   * applicationId corresponding to the TrueWatch RUM application (required)
   */
  applicationId: string
  /**
   * version corresponding to the TrueWatch RUM application (optional)
   */
  version?: string
  /**
   * env corresponding to the TrueWatch RUM application (optional)
   */
  env?: string

  /**
   * Find all matching files but do not upload them, useful for debugging
   */
  dryRun?: boolean
  /**
   * Delete all found source map files after upload.
   */
  deleteAfterUpload?: boolean
  /**
   * If source maps cannot be matched with their generated files via sourceMappingURL, attempt to match them by filename on the local disk
   */
  matchSourcemapsByFilename: ?boolean

  /**
   * List of file extensions to search for in the directory
   * Default [".js", ".map"].
   */
  extensions?: Array<string>

  /**
   * List of files to ignore
   */
  ignore?: Array<string>

  /**
   * Directory to which relative paths should be calculated. The relative paths of the sourcemaps to be uploaded should be included in the path where the error occurs, hence
   * the purpose of this parameter is to control the relative directory to upload
   * Default relative path from the execution directory to the search directory path.relative(process.cwd(), filepath)
   */
  root?: string
  /**
   * Log level for debugging purposes
   */
  logLevel?: "quiet" | "normal" | "verbose"
  /**
   * Whether to ignore errors on failure, this configuration ensures that errors do not interrupt the build process. Default false, meaning errors will be thrown normally
   */
  warnOnFailure?: boolean
}

// vite.config.ts
import { defineConfig } from "vite"
import vue from "@vitejs/plugin-vue"
import { SourceMapUploadVitePlugin } from "@cloudcare/vite-plugin-sourcemap"
// https://vitejs.dev/config/
export default defineConfig({
  build: {
    sourcemap: "hidden", // Source map generation must be turned on
  },
  plugins: [
    vue(),

    SourceMapUploadVitePlugin({
      applicationId: "xxxxx", //  TrueWatch application appid
      apiKey: "xxxxxxxx", // open apikey
      server: "https://console.xxx-xxx.cn",
      filepaths: ["dist/"], // directories to search, can be files or directories
      logLevel: "verbose", // log level
      //   root: 'dist/', // root directory for the relative path to upload
      env: "production", // TrueWatch application env
      version: "1.0.0", // TrueWatch application version
      deleteAfterUpload: true,
      matchSourcemapsByFilename: true,
    }),
  ],
})