Skip to main content

Module: template/config/init-command

Variables

default

Const default: "{\n // directory for output files\n \"output\": \"<%= it.config.output %>\",\n\n // typeorm dataSourcePath\n \"data-source-path\": \"<%= it.config.dataSourceFile %>\",\n\n // type of generated document\n \"components\": <%~ JSON.stringify(it.config.components) %>,\n\n // kind of document name\n // - db: database name from TypeORM\n // - app: application name from package.json\n \"project-name\": \"<%= it.config.projectName %>\",\n\n // custom template file path. erdia are using [ETA](https://eta.js.org/) template engine\n <% if (it.config.templatePath != null) { %>\n \"template-path\": \"<%= it.config.templatePath %>\",\n <% } else { %>\n // \"template-path\": \"\",\n <% } %>\n\n // erdia entity database file path\n \"database-path\": \"<%= it.config.databasePath %>\",\n\n // erdia entity database file path\n<% if (it.config.routeBasePath != null) { %>\n \"route-base-path\": \"<%= it.config.routeBasePath %>\",\n<% } else { %>\n // \"route-base-path\": \"\",\n<% } %>\n\n // document version using package.json version or timestamp\n \"version-from\": \"<%= it.config.versionFrom %>\",\n\n // If the versionFrom option set file, read the file from this path\n<% if (it.config.versionFrom != null) { %>\n \"version-path\": \"<%= it.config.versionPath %>\",\n<% } else { %>\n // \"version-path\": \"\",\n<% } %>\n\n // output format of generated documents\n // - html\n // - markdown\n // - pdf\n // - image\n \"format\": \"<%= it.config.format %>\",\n\n // skip image file attachment in html document\n \"skipImageInHtml\": false,\n\n // mermaid.js plugin theme configuration\n // @url https://mermaid-js.github.io/mermaid/#/Setup?id=theme\n \"theme\": \"<%= it.config.theme %>\",\n\n // prettier config path\n // \"prettier-config\": \"set your .prettierrc file path\",\n\n // title tag content that inside of html document\n // \"title\": \"set title tag content in html document\",\n\n // ER diagram width, it will be set width css attribute\n // @format pdf, image\n <% if (it.config.format === 'pdf' || it.config.format === 'image') { -%>\n \"width\": \"100%\",\n <% } else { -%>\n // \"width\": \"100%\",\n <% } -%>\n\n // puppeteer viewport width\n // @format pdf, image\n <% if (it.config.format === 'pdf' || it.config.format === 'image') { -%>\n \"viewport-width\": 1280,\n <% } else { -%>\n // \"viewport-width\": 1280,\n <% } -%>\n\n // puppeteer viewport height\n // @format pdf, image\n <% if (it.config.format === 'pdf' || it.config.format === 'image') { -%>\n \"viewport-height\": 1440,\n <% } else { -%>\n // \"viewport-height\": 1440,\n <% } -%>\n\n // puppeteer config file path\n // @format pdf, image\n // \"puppeteer-config-path\": \"set your puppeteer configuration file path\",\n\n // Background color. Example: transparent, red, '#F0F0F0'. Optional. Default: white\n // @format pdf, image\n // \"background-color\": \"#FFFFFF\",\n\n // ER diagram export image file format\n // @format image\n <% if (it.config.format === 'image') { %>\n \"image-format\": \"<%= it.config.imageFormat %>\",\n <% } else { %>\n // \"image-format\": \"svg\",\n <% } %>\n}"

Defined in

template/config/init-command.ts:1