Merge pull request #124 from amtrack/feat/ignorefile

feat: add --ignorefile flag

Author: amtrack

src/cli.ts

@@ -1,3 +1,4 @@
+import { readFile } from "fs/promises";
 import type { FileProperties } from "jsforce/api/metadata";
 import { toMetadataComponentName } from "./metadata-component";
 
@@ -35,3 +36,22 @@ export function formatFileProperties(
   const entries = fileProperties.map(mapFn).sort();
   return outputType.endsWith("-csv") ? entries.join(",") : entries.join("\n");
 }
+
+export async function getNonEmptyLinesFromFile(
+  filePath: string
+): Promise<string[]> {
+  const content = await readFile(filePath, "utf8");
+  return (
+    parseNewLineSeparatedValues(content)
+      // ignore comments
+      .filter((x) => !x.startsWith("#"))
+  );
+}
+
+export async function getNonEmptyLinesFromFiles(
+  filePaths: string[]
+): Promise<string[]> {
+  const promises = filePaths.map((fp) => getNonEmptyLinesFromFile(fp));
+  const results = await Promise.all(promises);
+  return results.flat().filter(Boolean);
+}

src/commands/force/mdapi/listallmetadata.ts

@@ -2,6 +2,7 @@ import { flags, SfdxCommand } from "@salesforce/command";
 import { promises as fs } from "fs";
 import {
   formatFileProperties,
+  getNonEmptyLinesFromFiles,
   parseCommaSeparatedValues,
   parseNewLineSeparatedValues,
 } from "../../../cli";
@@ -88,6 +89,10 @@ export default class MdapiListAllMetadataCommand extends SfdxCommand {
       description: `comma-separated list of metadata component name expressions to ignore
       Example: 'InstalledPackage:*,Profile:*,Report:unfiled$public/*,CustomField:Account.*'`,
     }),
+    ignorefile: flags.filepath({
+      description: `same as --ignore, but instead read from a file containing one ignore pattern per line`,
+      multiple: true
+    }),
     unlocked: flags.boolean({
       description: `list metadata components from Unlocked Packages`,
       default: null,
@@ -151,7 +156,10 @@ export default class MdapiListAllMetadataCommand extends SfdxCommand {
         : parseCommaSeparatedValues(this.flags.metadata);
     allowPatterns = allowPatterns.length ? allowPatterns : ["*:*", "*:**/*"];
     allowPatterns = allowPatterns.map(ensureMetadataComponentPattern);
-    const ignorePatterns = parseCommaSeparatedValues(this.flags.ignore);
+    const ignorePatterns = [
+      ...(await getNonEmptyLinesFromFiles(this.flags.ignorefile)),
+      ...parseCommaSeparatedValues(this.flags.ignore)
+    ];
     const allowFunctions = [];
     const ignoreFunctions = [];
     const flag2FunctionName = {

src/commands/package.xml/generate.ts

@@ -1,6 +1,9 @@
 import { flags, SfdxCommand } from '@salesforce/command';
 import { promises as fs } from 'fs';
-import { parseCommaSeparatedValues } from '../../cli';
+import {
+  getNonEmptyLinesFromFiles,
+  parseCommaSeparatedValues
+} from '../../cli';
 import { match } from '../../match';
 import { toMetadataComponentName } from '../../metadata-component';
 import PackageXml from '../../package-xml';
@@ -58,9 +61,10 @@ export default class PackageXmlGenerateCommand extends SfdxCommand {
       description: `comma-separated list of metadata component name expressions to ignore
       Example: 'InstalledPackage:*,Profile:*,Report:unfiled$public/*,CustomField:Account.*'`
     }),
-    // ignorefile: flags.filepath({
-    //   description: `same as --ignore, just one ignore pattern per line in a file`
-    // }),
+    ignorefile: flags.filepath({
+      description: `same as --ignore, but instead read from a file containing one ignore pattern per line`,
+      multiple: true
+    }),
     defaultignore: flags.array({
       description: 'ignored by default, to disable use --defaultignore ""',
       default: ['InstalledPackage:*']
@@ -82,13 +86,11 @@ export default class PackageXmlGenerateCommand extends SfdxCommand {
     if (this.flags.apiversion) {
       meta['version'] = this.flags.apiversion;
     }
-    const ignorePatterns = [];
-    if (this.flags.ignore) {
-      ignorePatterns.push(...parseCommaSeparatedValues(this.flags.ignore));
-    }
-    if (this.flags.defaultignore) {
-      ignorePatterns.push(...this.flags.defaultignore);
-    }
+    const ignorePatterns = [
+      ...(await getNonEmptyLinesFromFiles(this.flags.ignorefile)),
+      ...parseCommaSeparatedValues(this.flags.ignore),
+      ...this.flags.defaultignore
+    ];
     const [, keep] = match(
       fileProperties,
       ignorePatterns,

test/cli.test.ts

@@ -1,25 +1,43 @@
-import { expect } from 'chai';
+import { expect } from "chai";
+import { join } from "path";
 import {
+  getNonEmptyLinesFromFiles,
   parseCommaSeparatedValues,
-  parseNewLineSeparatedValues
-} from '../src/cli';
+  parseNewLineSeparatedValues,
+} from "../src/cli";
 
-describe('cli', () => {
-  describe('parseCommaSeparatedValues()', () => {
-    it('parses comma-separated values', () => {
+describe("cli", () => {
+  describe("parseCommaSeparatedValues()", () => {
+    it("parses comma-separated values", () => {
       expect(
-        parseCommaSeparatedValues(' CustomObject:Account , ApexPage:Foo')
-      ).to.deep.equal(['CustomObject:Account', 'ApexPage:Foo']);
+        parseCommaSeparatedValues(" CustomObject:Account , ApexPage:Foo")
+      ).to.deep.equal(["CustomObject:Account", "ApexPage:Foo"]);
     });
   });
-  describe('parseNewLineSeparatedValues()', () => {
-    it('parses newline-separated values', () => {
+  describe("parseNewLineSeparatedValues()", () => {
+    it("parses newline-separated values", () => {
       const input = `CustomObject:Account
       ApexPage:Foo
       `;
       expect(parseNewLineSeparatedValues(input)).to.deep.equal([
-        'CustomObject:Account',
-        'ApexPage:Foo'
+        "CustomObject:Account",
+        "ApexPage:Foo",
+      ]);
+    });
+  });
+  describe("getNonEmptyLinesFromFiles()", () => {
+    it("parses multiple files", async () => {
+      const fixtures = join("test", "fixtures", "ignore-files");
+      const ignoreFiles = [
+        join(fixtures, "full.txt"),
+        join(fixtures, "empty.txt"),
+        join(fixtures, "min.txt"),
+      ];
+      expect(await getNonEmptyLinesFromFiles(ignoreFiles)).to.deep.equal([
+        "ApexClass:Full",
+        "ApexPage:Full",
+        "ApexClass:Min",
+        "ApexPage:Min",
       ]);
     });
   });

test/fixtures/ignore-files/empty.txt

@@ -0,0 +1,5 @@
+# This is a comment
+
+ApexClass:Full
+
+ApexPage:Full

test/fixtures/ignore-files/full.txt

@@ -0,0 +1,2 @@
+ApexClass:Min
+ApexPage:Min