projen/lib/ignore-file.js

CDK for software projects

"use strict";
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.IgnoreFile = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const file_1 = require("./file");
const util_1 = require("./util");
class IgnoreFile extends file_1.FileBase {
    /**
     *
     * @param project The project to tie this file to.
     * @param filePath - the relative path in the project to put the file
     * @param minify - whether comments/blank lines should be filtered
     */
    constructor(project, filePath, options) {
        super(project, filePath, { editGitignore: filePath !== ".gitignore" });
        this.filterCommentLines = options?.filterCommentLines ?? true;
        this.filterEmptyLines = options?.filterEmptyLines ?? true;
        this._patterns = options?.ignorePatterns ?? [];
    }
    /**
     * Add ignore patterns. Files that match this pattern will be ignored. If the
     * pattern starts with a negation mark `!`, files that match will _not_ be
     * ignored.
     *
     * Comment lines (start with `#`) and blank lines ("") are filtered by default
     * but can be included using options specified when instantiating the component.
     *
     * @param patterns Ignore patterns.
     */
    addPatterns(...patterns) {
        for (const pattern of patterns) {
            const isComment = pattern.startsWith("#");
            const isEmptyLine = Boolean(pattern.trim().length === 0);
            if (isComment && this.filterCommentLines) {
                continue;
            }
            if (isEmptyLine && this.filterEmptyLines) {
                continue;
            }
            if (!isComment && !isEmptyLine) {
                this.normalizePatterns(pattern);
            }
            const normalizedPattern = (0, util_1.normalizePersistedPath)(pattern);
            this._patterns.push(normalizedPattern);
        }
    }
    normalizePatterns(pattern) {
        const opposite = pattern.startsWith("!") ? pattern.slice(1) : "!" + pattern;
        remove(this._patterns, pattern); // prevent duplicates
        remove(this._patterns, opposite);
        if (pattern.endsWith("/")) {
            const prefix = opposite;
            for (const p of [...this._patterns]) {
                if (p.startsWith(prefix)) {
                    remove(this._patterns, p);
                }
            }
        }
    }
    /**
     * Removes patterns previously added from the ignore file.
     *
     * If `addPattern()` is called after this, the pattern will be added again.
     *
     * @param patterns patters to remove.
     */
    removePatterns(...patterns) {
        for (const p of patterns) {
            remove(this._patterns, p);
        }
    }
    /**
     * Ignore the files that match these patterns.
     * @param patterns The patterns to match.
     */
    exclude(...patterns) {
        return this.addPatterns(...patterns);
    }
    /**
     * Always include the specified file patterns.
     * @param patterns Patterns to include in git commits.
     */
    include(...patterns) {
        for (let pattern of patterns) {
            if (!pattern.startsWith("!")) {
                pattern = "!" + pattern;
            }
            this.addPatterns(pattern);
        }
    }
    synthesizeContent(resolver) {
        const lines = [
            ...(this.marker ? [`# ${this.marker}`] : []),
            ...this._patterns,
        ];
        return `${resolver.resolve(lines).join("\n")}\n`;
    }
}
exports.IgnoreFile = IgnoreFile;
_a = JSII_RTTI_SYMBOL_1;
IgnoreFile[_a] = { fqn: "projen.IgnoreFile", version: "0.95.2" };
// O(n) hooray!
function remove(arr, value) {
    const idx = arr.indexOf(value);
    if (idx >= 0) {
        arr.splice(idx, 1);
    }
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"ignore-file.js","sourceRoot":"","sources":["../src/ignore-file.ts"],"names":[],"mappings":";;;;;AAAA,iCAA6C;AAE7C,iCAAgD;AAyBhD,MAAa,UAAW,SAAQ,eAAQ;IAKtC;;;;;OAKG;IACH,YAAY,OAAgB,EAAE,QAAgB,EAAE,OAA2B;QACzE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,aAAa,EAAE,QAAQ,KAAK,YAAY,EAAE,CAAC,CAAC;QACvE,IAAI,CAAC,kBAAkB,GAAG,OAAO,EAAE,kBAAkB,IAAI,IAAI,CAAC;QAC9D,IAAI,CAAC,gBAAgB,GAAG,OAAO,EAAE,gBAAgB,IAAI,IAAI,CAAC;QAC1D,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,cAAc,IAAI,EAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAAC,GAAG,QAAkB;QACtC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;YACzD,IAAI,SAAS,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACzC,SAAS;YACX,CAAC;YACD,IAAI,WAAW,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACzC,SAAS;YACX,CAAC;YACD,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,EAAE,CAAC;gBAC/B,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC;YAED,MAAM,iBAAiB,GAAG,IAAA,6BAAsB,EAAC,OAAO,CAAC,CAAC;YAE1D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAEO,iBAAiB,CAAC,OAAe;QACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC;QAC5E,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,qBAAqB;QACtD,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEjC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC;YACxB,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;gBACpC,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBACzB,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,GAAG,QAAkB;QACzC,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,GAAG,QAAkB;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,GAAG,QAAkB;QAClC,KAAK,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,OAAO,GAAG,GAAG,GAAG,OAAO,CAAC;YAC1B,CAAC;YAED,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAES,iBAAiB,CAAC,QAAmB;QAC7C,MAAM,KAAK,GAAG;YACZ,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5C,GAAG,IAAI,CAAC,SAAS;SAClB,CAAC;QAEF,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACnD,CAAC;;AAzGH,gCA0GC;;;AAED,eAAe;AACf,SAAS,MAAM,CAAI,GAAQ,EAAE,KAAU;IACrC,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QACb,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACrB,CAAC;AACH,CAAC","sourcesContent":["import { FileBase, IResolver } from \"./file\";\nimport { Project } from \"./project\";\nimport { normalizePersistedPath } from \"./util\";\n\nexport interface IgnoreFileOptions {\n  /**\n   * Filter out comment lines?\n   *\n   * @default true\n   */\n  readonly filterCommentLines?: boolean;\n\n  /**\n   * Filter out blank/empty lines?\n   *\n   * @default true\n   */\n  readonly filterEmptyLines?: boolean;\n\n  /**\n   * Patterns to add to the ignore file\n   *\n   * @default []\n   */\n  readonly ignorePatterns?: string[];\n}\n\nexport class IgnoreFile extends FileBase {\n  private readonly _patterns: string[];\n  public readonly filterCommentLines: boolean;\n  public readonly filterEmptyLines: boolean;\n\n  /**\n   *\n   * @param project The project to tie this file to.\n   * @param filePath - the relative path in the project to put the file\n   * @param minify - whether comments/blank lines should be filtered\n   */\n  constructor(project: Project, filePath: string, options?: IgnoreFileOptions) {\n    super(project, filePath, { editGitignore: filePath !== \".gitignore\" });\n    this.filterCommentLines = options?.filterCommentLines ?? true;\n    this.filterEmptyLines = options?.filterEmptyLines ?? true;\n    this._patterns = options?.ignorePatterns ?? [];\n  }\n\n  /**\n   * Add ignore patterns. Files that match this pattern will be ignored. If the\n   * pattern starts with a negation mark `!`, files that match will _not_ be\n   * ignored.\n   *\n   * Comment lines (start with `#`) and blank lines (\"\") are filtered by default\n   * but can be included using options specified when instantiating the component.\n   *\n   * @param patterns Ignore patterns.\n   */\n  public addPatterns(...patterns: string[]) {\n    for (const pattern of patterns) {\n      const isComment = pattern.startsWith(\"#\");\n      const isEmptyLine = Boolean(pattern.trim().length === 0);\n      if (isComment && this.filterCommentLines) {\n        continue;\n      }\n      if (isEmptyLine && this.filterEmptyLines) {\n        continue;\n      }\n      if (!isComment && !isEmptyLine) {\n        this.normalizePatterns(pattern);\n      }\n\n      const normalizedPattern = normalizePersistedPath(pattern);\n\n      this._patterns.push(normalizedPattern);\n    }\n  }\n\n  private normalizePatterns(pattern: string) {\n    const opposite = pattern.startsWith(\"!\") ? pattern.slice(1) : \"!\" + pattern;\n    remove(this._patterns, pattern); // prevent duplicates\n    remove(this._patterns, opposite);\n\n    if (pattern.endsWith(\"/\")) {\n      const prefix = opposite;\n      for (const p of [...this._patterns]) {\n        if (p.startsWith(prefix)) {\n          remove(this._patterns, p);\n        }\n      }\n    }\n  }\n\n  /**\n   * Removes patterns previously added from the ignore file.\n   *\n   * If `addPattern()` is called after this, the pattern will be added again.\n   *\n   * @param patterns patters to remove.\n   */\n  public removePatterns(...patterns: string[]) {\n    for (const p of patterns) {\n      remove(this._patterns, p);\n    }\n  }\n\n  /**\n   * Ignore the files that match these patterns.\n   * @param patterns The patterns to match.\n   */\n  public exclude(...patterns: string[]) {\n    return this.addPatterns(...patterns);\n  }\n\n  /**\n   * Always include the specified file patterns.\n   * @param patterns Patterns to include in git commits.\n   */\n  public include(...patterns: string[]) {\n    for (let pattern of patterns) {\n      if (!pattern.startsWith(\"!\")) {\n        pattern = \"!\" + pattern;\n      }\n\n      this.addPatterns(pattern);\n    }\n  }\n\n  protected synthesizeContent(resolver: IResolver): string | undefined {\n    const lines = [\n      ...(this.marker ? [`# ${this.marker}`] : []),\n      ...this._patterns,\n    ];\n\n    return `${resolver.resolve(lines).join(\"\\n\")}\\n`;\n  }\n}\n\n// O(n) hooray!\nfunction remove<T>(arr: T[], value: any) {\n  const idx = arr.indexOf(value);\n  if (idx >= 0) {\n    arr.splice(idx, 1);\n  }\n}\n"]}