projen/lib/gitattributes.js

CDK for software projects

"use strict";
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.GitAttributesFile = exports.EndOfLine = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const file_1 = require("./file");
/**
 * The end of line characters supported by git.
 */
var EndOfLine;
(function (EndOfLine) {
    /**
     * Maintain existing (mixed values within one file are normalised by looking
     * at what's used after the first line)
     */
    EndOfLine["AUTO"] = "auto";
    /**
     * Carriage Return + Line Feed characters (\r\n), common on Windows
     */
    EndOfLine["CRLF"] = "crlf";
    /**
     * Line Feed only (\n), common on Linux and macOS as well as inside git repos
     */
    EndOfLine["LF"] = "lf";
    /**
     * Disable and do not configure the end of line character
     */
    EndOfLine["NONE"] = "none";
})(EndOfLine || (exports.EndOfLine = EndOfLine = {}));
/**
 * Assign attributes to file names in a git repository.
 *
 * @see https://git-scm.com/docs/gitattributes
 */
class GitAttributesFile extends file_1.FileBase {
    constructor(scope, options) {
        super(scope, ".gitattributes", {
            editGitignore: false,
        });
        this.attributes = new Map();
        this.endOfLine = options?.endOfLine ?? EndOfLine.LF;
        if (this.endOfLine != EndOfLine.NONE) {
            let endOfLineAttributes = [`text=auto`];
            if (this.endOfLine != EndOfLine.AUTO) {
                endOfLineAttributes.push(`eol=${this.endOfLine}`);
            }
            // Setting a default end of line for all text files in the repository
            // This line should be the first one in order to use it as a default for text files and allow for overriding in later lines
            this.addAttributes("*", ...endOfLineAttributes);
        }
    }
    /**
     * Maps a set of attributes to a set of files.
     * @param glob Glob pattern to match files in the repo
     * @param attributes Attributes to assign to these files.
     */
    addAttributes(glob, ...attributes) {
        if (!this.attributes.has(glob)) {
            this.attributes.set(glob, new Set());
        }
        const set = this.attributes.get(glob);
        for (const attribute of attributes) {
            set.add(attribute);
        }
    }
    /**
     * Add attributes necessary to mark these files as stored in LFS
     */
    addLfsPattern(glob) {
        this.addAttributes(glob, "filter=lfs", "diff=lfs", "merge=lfs", "-text");
    }
    /**
     * Whether the current gitattributes file has any LFS patterns
     */
    get hasLfsPatterns() {
        return Array.from(this.attributes.values()).some((attrs) => attrs.has("filter=lfs"));
    }
    preSynthesize() {
        this.project.addPackageIgnore("/.gitattributes");
        super.preSynthesize();
    }
    synthesizeContent(_) {
        // We can assume the file map is never empty.
        const entries = Array.from(this.attributes.entries()).sort(([l], [r]) => l.localeCompare(r));
        if (entries.length === 0) {
            return undefined;
        }
        return [
            ...(this.marker ? [`# ${this.marker}`] : []),
            "",
            ...entries.map(([name, attributes]) => `${name} ${Array.from(attributes).join(" ")}`),
        ].join("\n");
    }
}
exports.GitAttributesFile = GitAttributesFile;
_a = JSII_RTTI_SYMBOL_1;
GitAttributesFile[_a] = { fqn: "projen.GitAttributesFile", version: "0.95.2" };
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"gitattributes.js","sourceRoot":"","sources":["../src/gitattributes.ts"],"names":[],"mappings":";;;;;AACA,iCAA6C;AAE7C;;GAEG;AACH,IAAY,SAqBX;AArBD,WAAY,SAAS;IACnB;;;OAGG;IACH,0BAAa,CAAA;IAEb;;OAEG;IACH,0BAAa,CAAA;IAEb;;OAEG;IACH,sBAAS,CAAA;IAET;;OAEG;IACH,0BAAa,CAAA;AACf,CAAC,EArBW,SAAS,yBAAT,SAAS,QAqBpB;AAgBD;;;;GAIG;AACH,MAAa,iBAAkB,SAAQ,eAAQ;IAQ7C,YAAmB,KAAiB,EAAE,OAAkC;QACtE,KAAK,CAAC,KAAK,EAAE,gBAAgB,EAAE;YAC7B,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;QAVY,eAAU,GAAG,IAAI,GAAG,EAAuB,CAAC;QAY3D,IAAI,CAAC,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,SAAS,CAAC,EAAE,CAAC;QAEpD,IAAI,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;YACrC,IAAI,mBAAmB,GAAG,CAAC,WAAW,CAAC,CAAC;YAExC,IAAI,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;gBACrC,mBAAmB,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;YACpD,CAAC;YAED,qEAAqE;YACrE,2HAA2H;YAC3H,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,mBAAmB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,IAAY,EAAE,GAAG,UAAoB;QACxD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QACvC,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;QACvC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACnC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,IAAY;QAC/B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CACzD,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CACxB,CAAC;IACJ,CAAC;IAEe,aAAa;QAC3B,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAEjD,KAAK,CAAC,aAAa,EAAE,CAAC;IACxB,CAAC;IAES,iBAAiB,CAAC,CAAY;QACtC,6CAA6C;QAC7C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CACtE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CACnB,CAAC;QAEF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO;YACL,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5C,EAAE;YACF,GAAG,OAAO,CAAC,GAAG,CACZ,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CACtE;SACF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;;AAlFH,8CAmFC","sourcesContent":["import { IConstruct } from \"constructs\";\nimport { IResolver, FileBase } from \"./file\";\n\n/**\n * The end of line characters supported by git.\n */\nexport enum EndOfLine {\n  /**\n   * Maintain existing (mixed values within one file are normalised by looking\n   * at what's used after the first line)\n   */\n  AUTO = \"auto\",\n\n  /**\n   * Carriage Return + Line Feed characters (\\r\\n), common on Windows\n   */\n  CRLF = \"crlf\",\n\n  /**\n   * Line Feed only (\\n), common on Linux and macOS as well as inside git repos\n   */\n  LF = \"lf\",\n\n  /**\n   * Disable and do not configure the end of line character\n   */\n  NONE = \"none\",\n}\n\n/**\n * Options for `GitAttributesFile`.\n */\nexport interface GitAttributesFileOptions {\n  /**\n   * The default end of line character for text files.\n   *\n   * endOfLine it's useful to keep the same end of line between Windows and Unix operative systems for git checking/checkout operations. Hence, it can avoid simple repository mutations consisting only of changes in the end of line characters. It will be set in the first line of the .gitattributes file to make it the first match with high priority but it can be overriden in a later line. Can be disabled by setting explicitly: `{ endOfLine: EndOfLine.NONE }`.\n   *\n   * @default EndOfLine.LF\n   */\n  readonly endOfLine?: EndOfLine;\n}\n\n/**\n * Assign attributes to file names in a git repository.\n *\n * @see https://git-scm.com/docs/gitattributes\n */\nexport class GitAttributesFile extends FileBase {\n  private readonly attributes = new Map<string, Set<string>>();\n\n  /**\n   * The default end of line character for text files.\n   */\n  public readonly endOfLine: EndOfLine;\n\n  public constructor(scope: IConstruct, options?: GitAttributesFileOptions) {\n    super(scope, \".gitattributes\", {\n      editGitignore: false,\n    });\n\n    this.endOfLine = options?.endOfLine ?? EndOfLine.LF;\n\n    if (this.endOfLine != EndOfLine.NONE) {\n      let endOfLineAttributes = [`text=auto`];\n\n      if (this.endOfLine != EndOfLine.AUTO) {\n        endOfLineAttributes.push(`eol=${this.endOfLine}`);\n      }\n\n      // Setting a default end of line for all text files in the repository\n      // This line should be the first one in order to use it as a default for text files and allow for overriding in later lines\n      this.addAttributes(\"*\", ...endOfLineAttributes);\n    }\n  }\n\n  /**\n   * Maps a set of attributes to a set of files.\n   * @param glob Glob pattern to match files in the repo\n   * @param attributes Attributes to assign to these files.\n   */\n  public addAttributes(glob: string, ...attributes: string[]) {\n    if (!this.attributes.has(glob)) {\n      this.attributes.set(glob, new Set());\n    }\n    const set = this.attributes.get(glob)!;\n    for (const attribute of attributes) {\n      set.add(attribute);\n    }\n  }\n\n  /**\n   * Add attributes necessary to mark these files as stored in LFS\n   */\n  public addLfsPattern(glob: string) {\n    this.addAttributes(glob, \"filter=lfs\", \"diff=lfs\", \"merge=lfs\", \"-text\");\n  }\n\n  /**\n   * Whether the current gitattributes file has any LFS patterns\n   */\n  public get hasLfsPatterns() {\n    return Array.from(this.attributes.values()).some((attrs) =>\n      attrs.has(\"filter=lfs\")\n    );\n  }\n\n  public override preSynthesize(): void {\n    this.project.addPackageIgnore(\"/.gitattributes\");\n\n    super.preSynthesize();\n  }\n\n  protected synthesizeContent(_: IResolver): string | undefined {\n    // We can assume the file map is never empty.\n    const entries = Array.from(this.attributes.entries()).sort(([l], [r]) =>\n      l.localeCompare(r)\n    );\n\n    if (entries.length === 0) {\n      return undefined;\n    }\n\n    return [\n      ...(this.marker ? [`# ${this.marker}`] : []),\n      \"\",\n      ...entries.map(\n        ([name, attributes]) => `${name} ${Array.from(attributes).join(\" \")}`\n      ),\n    ].join(\"\\n\");\n  }\n}\n"]}