feat: allow ignore pattern for copy task

Author: christian-bromann

src/compiler/output-targets/copy/assets-copy-tasks.ts

@@ -27,6 +27,7 @@ export const getComponentAssetsCopyTasks = (
             src: assetsMeta.absolutePath,
             dest: join(dest, assetsMeta.cmpRelativePath),
             warn: false,
+            ignore: undefined,
             keepDirStructure: false,
           });
         });
@@ -37,6 +38,7 @@ export const getComponentAssetsCopyTasks = (
             src: assetsMeta.absolutePath,
             dest: collectionDirDestination,
             warn: false,
+            ignore: undefined,
             keepDirStructure: false,
           });
         });

src/compiler/output-targets/copy/output-copy.ts

@@ -5,6 +5,11 @@ import type * as d from '../../../declarations';
 import { canSkipAssetsCopy, getComponentAssetsCopyTasks } from './assets-copy-tasks';
 import { getDestAbsPath, getSrcAbsPath } from './local-copy-tasks';
 
+const DEFAULT_IGNORE = [
+  '**/__mocks__/**', '**/__fixtures__/**', '**/dist/**', '**/.{idea,git,cache,output,temp}/**',
+  '**/.ds_store', '**/.gitignore', '**/desktop.ini', '**/thumbs.db'
+]
+
 export const outputCopy = async (config: d.ValidatedConfig, compilerCtx: d.CompilerCtx, buildCtx: d.BuildCtx) => {
   const outputTargets = config.outputTargets.filter(isOutputTargetCopy);
   if (outputTargets.length === 0) {
@@ -83,6 +88,7 @@ const transformToAbs = (copyTask: d.CopyTask, dest: string): Required<d.CopyTask
   return {
     src: copyTask.src,
     dest: getDestAbsPath(copyTask.src, dest, copyTask.dest),
+    ignore: copyTask.ignore || DEFAULT_IGNORE,
     keepDirStructure:
       typeof copyTask.keepDirStructure === 'boolean' ? copyTask.keepDirStructure : copyTask.dest == null,
     warn: copyTask.warn !== false,

src/declarations/stencil-public-compiler.ts

@@ -1646,6 +1646,11 @@ export interface CopyTask {
    * the output target for which this copy operation is configured.
    */
   dest?: string;
+  /**
+   * An optional array of glob patterns to exclude from the copy operation.
+   * @default ['**\/__mocks__/**', '**\/__fixtures__/**', '**\/dist/**', '**\/.{idea,git,cache,output,temp}/**', '.ds_store', '.gitignore', 'desktop.ini', 'thumbs.db']
+   */
+  ignore?: string[];
   /**
    * Whether or not Stencil should issue warnings if it cannot find the
    * specified source files or directories. Defaults to `false`.

src/sys/node/node-copy-tasks.ts

@@ -1,5 +1,5 @@
 import { buildError, catchError, flatOne, isGlob, normalizePath } from '@utils';
-import { glob } from 'glob';
+import { glob, type GlobOptions } from 'glob';
 import path from 'path';
 
 import type * as d from '../../declarations';
@@ -13,7 +13,7 @@ export async function nodeCopyTasks(copyTasks: Required<d.CopyTask>[], srcDir: s
   };
 
   try {
-    copyTasks = flatOne(await Promise.all(copyTasks.map((task) => processGlobs(task, srcDir))));
+    copyTasks = flatOne(await Promise.all(copyTasks.map((task) => processGlobTask(task, srcDir))));
 
     const allCopyTasks: d.CopyTask[] = [];
 
@@ -44,30 +44,15 @@ export async function nodeCopyTasks(copyTasks: Required<d.CopyTask>[], srcDir: s
   return results;
 }
 
-async function processGlobs(copyTask: Required<d.CopyTask>, srcDir: string): Promise<Required<d.CopyTask>[]> {
-  return isGlob(copyTask.src)
-    ? await processGlobTask(copyTask, srcDir)
-    : [
-        {
-          src: getSrcAbsPath(srcDir, copyTask.src),
-          dest: copyTask.keepDirStructure ? path.join(copyTask.dest, copyTask.src) : copyTask.dest,
-          warn: copyTask.warn,
-          keepDirStructure: copyTask.keepDirStructure,
-        },
-      ];
-}
-
-function getSrcAbsPath(srcDir: string, src: string) {
-  if (path.isAbsolute(src)) {
-    return src;
-  }
-  return path.join(srcDir, src);
-}
-
 async function processGlobTask(copyTask: Required<d.CopyTask>, srcDir: string): Promise<Required<d.CopyTask>[]> {
-  const files = await asyncGlob(copyTask.src, {
+  const pattern = isGlob(copyTask.src)
+    ? copyTask.src
+    : path.join(copyTask.src, '**');
+
+  const files = await asyncGlob(pattern, {
     cwd: srcDir,
     nodir: true,
+    ignore: copyTask.ignore,
   });
   return files.map((globRelPath) => createGlobCopyTask(copyTask, srcDir, globRelPath));
 }
@@ -77,6 +62,7 @@ function createGlobCopyTask(copyTask: Required<d.CopyTask>, srcDir: string, glob
   return {
     src: path.join(srcDir, globRelPath),
     dest,
+    ignore: copyTask.ignore,
     warn: copyTask.warn,
     keepDirStructure: copyTask.keepDirStructure,
   };
@@ -96,7 +82,7 @@ async function processCopyTask(results: d.CopyResults, allCopyTasks: d.CopyTask[
       }
 
       await processCopyTaskDirectory(results, allCopyTasks, copyTask);
-    } else if (!shouldIgnore(copyTask.src)) {
+    } else {
       // this is a file we should copy
       if (!results.filePaths.includes(copyTask.dest)) {
         results.filePaths.push(copyTask.dest);
@@ -169,13 +155,6 @@ function addMkDir(mkDirs: string[], destDir: string) {
 
 const ROOT_DIR = normalizePath(path.resolve('/'));
 
-function shouldIgnore(filePath: string) {
-  filePath = filePath.trim().toLowerCase();
-  return IGNORE.some((ignoreFile) => filePath.endsWith(ignoreFile));
-}
-
-const IGNORE = ['.ds_store', '.gitignore', 'desktop.ini', 'thumbs.db'];
-
-export function asyncGlob(pattern: string, opts: any) {
-  return glob(pattern, opts);
+export async function asyncGlob(pattern: string, opts: GlobOptions): Promise<string[]> {
+  return glob(pattern, { ...opts, withFileTypes: false });
 }

test/copy-task/README.md

@@ -0,0 +1,25 @@
+Copy Task Tests
+===============
+
+This directory aims to test and validate the behavior for Stencils [Copy Task for Output Targets](https://stenciljs.com/docs/copy-tasks#copy-tasks-for-output-targets). It has a copy task defined in `test/copy-task/stencil.config.ts` and builds this starter projects to then validate if the right files where copies.
+
+## Given
+
+We have a copy task defined as part of an output target, e.g. 
+
+```ts
+{
+  type: 'dist-custom-elements',
+  copy: [{
+    src: './utils',
+    dest: './dist/utilsExtra',
+  }]
+}
+```
+
+I expect that a `utilsExtra` directory is created that does __not__ copy the following entries:
+
+- files in `__fixtures__` and `__mocks__` directories
+- as well as files named `desktop.ini`
+
+Furthermore I expect that no JS files are copied over within the collection directory.