feat: throw an error when no file was found (#127)

Author: tassioFront

.changeset/rotten-seals-invite.md

@@ -0,0 +1,5 @@
+---
+'vite-plugin-static-copy': major
+---
+
+feat: throw an error when does not find file

src/build.ts

@@ -29,7 +29,8 @@ export const buildPlugin = ({
         config.root,
         config.build.outDir,
         targets,
-        structured
+        structured,
+        silent
       )
       if (!silent) outputCopyLog(config.logger, result)
     }

src/options.ts

@@ -90,7 +90,7 @@ export type ViteStaticCopyOptions = {
    */
   structured?: boolean
   /**
-   * Suppress console output.
+   * Suppress console output and ignore validation errors.
    * @default false
    */
   silent?: boolean

src/serve.ts

@@ -34,11 +34,14 @@ export const servePlugin = ({
       const copyTargets = await collectCopyTargets(
         config.root,
         targets,
-        structured
+        structured,
+        silent
       )
       updateFileMapFromTargets(copyTargets, fileMap)
     } catch (e) {
-      config.logger.error(formatConsole(pc.red((e as Error).toString())))
+      if (!silent) {
+        config.logger.error(formatConsole(pc.red((e as Error).toString())))
+      }
     }
   }
   const collectFileMapDebounce = debounce(100, async () => {

src/utils.ts

@@ -38,7 +38,8 @@ async function renameTarget(
 export const collectCopyTargets = async (
   root: string,
   targets: Target[],
-  structured: boolean
+  structured: boolean,
+  silent: boolean
 ) => {
   const copyTargets: SimpleTarget[] = []
 
@@ -59,6 +60,9 @@ export const collectCopyTargets = async (
       cwd: root
     })
 
+    if (matchedPaths.length === 0 && !silent) {
+      throw new Error(`No file was found to copy on ${src} src.`)
+    }
     for (const matchedPath of matchedPaths) {
       const relativeMatchedPath = path.isAbsolute(matchedPath)
         ? path.relative(root, matchedPath)
@@ -145,9 +149,15 @@ export const copyAll = async (
   rootSrc: string,
   rootDest: string,
   targets: Target[],
-  structured: boolean
+  structured: boolean,
+  silent: boolean
 ) => {
-  const copyTargets = await collectCopyTargets(rootSrc, targets, structured)
+  const copyTargets = await collectCopyTargets(
+    rootSrc,
+    targets,
+    structured,
+    silent
+  )
   let copiedCount = 0
 
   for (const copyTarget of copyTargets) {
@@ -244,8 +254,6 @@ export const outputCopyLog = (
     const skippedMessage =
       skipped > 0 ? ` ${pc.gray(`(Skipped ${skipped} items.)`)}` : ''
     logger.info(formatConsole(`${copiedMessage}${skippedMessage}`))
-  } else {
-    logger.warn(formatConsole(pc.yellow('No items to copy.')))
   }
 }
 

test/fixtures/vite.error-silent.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from 'vite'
+import { viteStaticCopy } from 'vite-plugin-static-copy'
+
+export default defineConfig({
+  plugins: [
+    viteStaticCopy({
+      targets: [
+        {
+          src: 'does-not-exist.txt',
+          dest: 'does-not-exist'
+        }
+      ],
+      silent: true
+    })
+  ]
+})

test/fixtures/vite.error.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vite'
+import { viteStaticCopy } from 'vite-plugin-static-copy'
+
+export default defineConfig({
+  plugins: [
+    viteStaticCopy({
+      targets: [
+        {
+          src: 'does-not-exist.txt',
+          dest: 'does-not-exist'
+        }
+      ]
+    })
+  ]
+})

test/tests.test.ts

@@ -137,4 +137,27 @@ describe('build', () => {
       }
     })
   }
+  describe('on error', () => {
+    test('should throw error when it does not find the file on given src', async () => {
+      let result = ''
+      try {
+        await build(getConfig('vite.error.config.ts'))
+      } catch (error: unknown) {
+        result = (error as Error).message
+      }
+      expect(result).toContain(
+        'No file was found to copy on does-not-exist.txt src.'
+      )
+    })
+
+    test('should not throw error when it does not find the file on given src as silent=true', async () => {
+      let result = ''
+      try {
+        await build(getConfig('vite.error-silent.config.ts'))
+      } catch (error: unknown) {
+        result = (error as Error).message
+      }
+      expect(result).toBe('')
+    })
+  })
 })