fix: forceignore ignores output file correctly - cleanup extra type declarations

Author: WillieRuemmele

src/client/metadataApiRetrieve.ts

@@ -119,7 +119,7 @@ export class MetadataApiRetrieve extends MetadataTransfer<
   MetadataApiRetrieveOptions
 > {
   public static DEFAULT_OPTIONS: Partial<MetadataApiRetrieveOptions> = { merge: false };
-  private options: MetadataApiRetrieveOptions;
+  private readonly options: MetadataApiRetrieveOptions;
   private orgId?: string;
 
   public constructor(options: MetadataApiRetrieveOptions) {

src/collections/componentSetBuilder.ts

@@ -133,7 +133,7 @@ export class ComponentSetBuilder {
           }`
         );
 
-        const mdMap: MetadataMap = metadata
+        const mdMap = metadata
           ? buildMapFromComponents(metadata.metadataEntries.map(entryToTypeAndName(registryAccess)))
           : (new Map() as MetadataMap);
 
@@ -281,7 +281,7 @@ const typeAndNameToMetadataComponents =
 
 // TODO: use Map.groupBy when it's available
 const buildMapFromComponents = (components: MetadataTypeAndMetadataName[]): MetadataMap => {
-  const mdMap: MetadataMap = new Map();
+  const mdMap: MetadataMap = new Map<string, string[]>();
   components.map((cmp) => {
     mdMap.set(cmp.type.name, [...(mdMap.get(cmp.type.name) ?? []), cmp.metadataName]);
   });

src/convert/metadataConverter.ts

@@ -183,9 +183,7 @@ function getMergeConfigOutputs(
     mergeSet.add(component.parent ?? component);
   }
   const writer = new StandardWriter(output.defaultDirectory);
-  if (output.forceIgnoredPaths) {
-    writer.forceIgnoredPaths = output.forceIgnoredPaths;
-  }
+
   return {
     writer,
     mergeSet,

src/convert/streams.ts

@@ -4,7 +4,7 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { basename, dirname, isAbsolute, join } from 'node:path';
+import { isAbsolute, join } from 'node:path';
 import { pipeline as cbPipeline, Readable, Stream, Transform, Writable } from 'node:stream';
 import { promisify } from 'node:util';
 import { Messages, SfError } from '@salesforce/core';
@@ -20,6 +20,7 @@ import { ComponentSet } from '../collections/componentSet';
 import { RegistryAccess } from '../registry/registryAccess';
 import { ensureFileExists } from '../utils/fileSystemHandler';
 import { ComponentStatus, FileResponseSuccess } from '../client/types';
+import { ForceIgnore } from '../resolve';
 import { MetadataTransformerFactory } from './transformers/metadataTransformerFactory';
 import { ConvertContext } from './convertContext/convertContext';
 import { SfdxFileFormat, WriteInfo, WriterFormat } from './types';
@@ -113,7 +114,6 @@ export class ComponentConverter extends Transform {
 }
 
 export abstract class ComponentWriter extends Writable {
-  public forceIgnoredPaths: Set<string> = new Set<string>();
   protected rootDestination?: SourcePath;
   protected logger: Logger;
 
@@ -128,9 +128,11 @@ export class StandardWriter extends ComponentWriter {
   /** filepaths that converted files were written to */
   public readonly converted: string[] = [];
   public readonly deleted: FileResponseSuccess[] = [];
+  public readonly forceignore: ForceIgnore;
 
   public constructor(rootDestination: SourcePath) {
     super(rootDestination);
+    this.forceignore = ForceIgnore.findAndCreate(rootDestination);
   }
 
   public async _write(chunk: WriterFormat, encoding: string, callback: (err?: Error) => void): Promise<void> {
@@ -144,8 +146,7 @@ export class StandardWriter extends ComponentWriter {
         await Promise.all(
           chunk.writeInfos
             .map(makeWriteInfoAbsolute(this.rootDestination))
-            .filter(existsOrDoesntMatchIgnored(this.forceIgnoredPaths))
-            .filter((info) => !this.forceIgnoredPaths.has(info.output))
+            .filter(existsOrDoesntMatchIgnored(this.forceignore))
             .map((info) => {
               if (info.shouldDelete) {
                 this.deleted.push({
@@ -288,11 +289,6 @@ const makeWriteInfoAbsolute =
   });
 
 const existsOrDoesntMatchIgnored =
-  (ignoredPaths: Set<string>) =>
+  (forceignore: ForceIgnore) =>
   (writeInfo: WriteInfo): boolean =>
-    existsSync(writeInfo.output) ||
-    [...ignoredPaths].every(
-      (ignoredPath) =>
-        !dirname(ignoredPath).includes(dirname(writeInfo.output)) &&
-        !basename(ignoredPath).includes(basename(writeInfo.output))
-    );
+    existsSync(writeInfo.output) || forceignore.accepts(writeInfo.output);

src/resolve/adapters/baseSourceAdapter.ts

@@ -35,8 +35,8 @@ export abstract class BaseSourceAdapter implements SourceAdapter {
   public constructor(
     type: MetadataType,
     registry = new RegistryAccess(),
-    forceIgnore: ForceIgnore = new ForceIgnore(),
-    tree: TreeContainer = new NodeFSTreeContainer()
+    forceIgnore = new ForceIgnore(),
+    tree = new NodeFSTreeContainer()
   ) {
     this.type = type;
     this.registry = registry;

src/resolve/connectionResolver.ts

@@ -166,7 +166,7 @@ export class ConnectionResolver {
           // The 'singleRecordQuery' method was having connection errors, using `retry` resolves this
           // Note that this type of connection retry logic may someday be added to jsforce v2
           // Once that happens this logic could be reverted
-          const standardValueSetRecord: StdValueSetRecord = await retry(async () => {
+          const standardValueSetRecord = await retry<StdValueSetRecord>(async () => {
             try {
               return await this.connection.singleRecordQuery(
                 `SELECT Id, MasterLabel, Metadata FROM StandardValueSet WHERE MasterLabel = '${standardValueSetFullName}'`,

src/resolve/forceIgnore.ts

@@ -17,7 +17,7 @@ export class ForceIgnore {
 
   private readonly parser?: Ignore;
   private readonly forceIgnoreDirectory?: string;
-  private DEFAULT_IGNORE: string[] = ['**/*.dup', '**/.*', '**/package2-descriptor.json', '**/package2-manifest.json'];
+  private DEFAULT_IGNORE = ['**/*.dup', '**/.*', '**/package2-descriptor.json', '**/package2-manifest.json'];
 
   public constructor(forceIgnorePath = '') {
     try {

src/resolve/metadataResolver.ts

@@ -31,6 +31,7 @@ export class MetadataResolver {
   /**
    * @param registry Custom registry data
    * @param tree `TreeContainer` to traverse with
+   * @param useFsForceIgnore false = use default forceignore entries, true = search and use forceignore in project
    */
   public constructor(
     private registry = new RegistryAccess(),
@@ -186,7 +187,7 @@ const isProbablyPackageManifest =
  * If a type can be determined from a directory path, and the end part of the path isn't
  * the directoryName of the type itself, infer the path is part of a mixedContent component
  *
- * @param dirPath Path to a directory
+ * @param registry the registry to resolve a type against
  */
 const resolveDirectoryAsComponent =
   (registry: RegistryAccess) =>
@@ -227,8 +228,8 @@ const isMetadata =
  * Attempt to find similar types for types that could not be inferred
  * To be used after executing the resolveType() method
  *
- * @param fsPath
  * @returns an array of suggestions
+ * @param registry a metdata registry to resolve types against
  */
 const getSuggestionsForUnresolvedTypes =
   (registry: RegistryAccess) =>
@@ -350,7 +351,7 @@ const resolveType =
 /**
  * Any file with a registered suffix is potentially a content metadata file.
  *
- * @param fsPath File path of a potential content metadata file
+ * @param registry a metadata registry to resolve types agsinst
  */
 const parseAsContentMetadataXml =
   (registry: RegistryAccess) =>

src/resolve/sourceComponent.ts

@@ -45,8 +45,8 @@ export class SourceComponent implements MetadataComponent {
   public parentType?: MetadataType;
   public content?: string;
   public replacements?: Record<string, MarkedReplacement[]>;
-  private treeContainer: TreeContainer;
-  private forceIgnore: ForceIgnore;
+  private readonly treeContainer: TreeContainer;
+  private readonly forceIgnore: ForceIgnore;
   private markedForDelete = false;
   private destructiveChangesType?: DestructiveChangesType;
 

test/mock/type-constants/staticresourceConstant.ts

@@ -22,7 +22,7 @@ export const MIXED_CONTENT_DIRECTORY_SOURCE_PATHS = [
   join(MIXED_CONTENT_DIRECTORY_CONTENT_PATH, 'tests', 'test.js'),
   join(MIXED_CONTENT_DIRECTORY_CONTENT_PATH, 'tests', 'test2.pdf'),
 ];
-export const MIXED_CONTENT_DIRECTORY_COMPONENT: SourceComponent = new SourceComponent({
+export const MIXED_CONTENT_DIRECTORY_COMPONENT = new SourceComponent({
   name: 'aStaticResource',
   type,
   xml: MIXED_CONTENT_DIRECTORY_XML_PATHS[0],