Options
All
  • Public
  • Public/Protected
  • All
Menu

adds codeOfConduct to the project, which manages the CODE_OF_CONDUCT.md file

Hierarchy

  • FileBase
    • CodeOfConduct

Index

Constructors

  • adds codeOfConduct to the project

    Parameters

    Returns CodeOfConduct

Properties

absolutePath: string

The absolute path of this file.

executable: boolean

Indicates if the file should be marked as executable

marker: undefined | string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

path: string

The file path, relative to the project root.

project: Project
readonly: boolean

Indicates if the file should be read-only or read-write.

text: string

Accessors

  • get changed(): undefined | boolean
  • Indicates if the file has been changed during synthesis. This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

    Returns undefined | boolean

Methods

  • postSynthesize(): void
  • Called after synthesis. Order is not guaranteed.

    Returns void

  • preSynthesize(): void
  • Called before synthesis.

    Returns void

  • synthesize(): void
  • Writes the file to the project's output directory

    Returns void

  • synthesizeContent(): undefined | string
  • Returns the contents of the file to emit.

    Returns undefined | string

    the content to synthesize or undefined to skip the file

Generated using TypeDoc