m30pm-lib-common

Mach 30 PM common functions library

:toolbox: Functions

• stringToEnumValue

:gear: stringToEnumValue

| Function | Type | | ---------- | ---------- | | stringToEnumValue | <T>(enumObj: Object, value: string) => T or undefined |

:wrench: Constants

• DefaultVersion
• DefaultLicense
• DefaultWorkspacePath

:gear: DefaultVersion

| Constant | Type | | ---------- | ---------- | | DefaultVersion | "0.0.0" |

:gear: DefaultLicense

| Constant | Type | | ---------- | ---------- | | DefaultLicense | "CC0-1.0" |

:gear: DefaultWorkspacePath

| Constant | Type | | ---------- | ---------- | | DefaultWorkspacePath | "packages" |

:factory: Helpers

Methods

• toJsonString

:gear: toJsonString

| Method | Type | | ---------- | ---------- | | toJsonString | (o: Object) => string |

:factory: ProjectConfiguration

Methods

• fromJsObject
• isValid
• toJsObject
• getProjectStatus
• getInitialRcOptions

:gear: fromJsObject

| Method | Type | | ---------- | ---------- | | fromJsObject | (jsObject: any) => ProjectConfiguration |

:gear: isValid

| Method | Type | | ---------- | ---------- | | isValid | () => boolean |

:gear: toJsObject

| Method | Type | | ---------- | ---------- | | toJsObject | () => Object |

:gear: getProjectStatus

| Method | Type | | ---------- | ---------- | | getProjectStatus | () => Object |

:gear: getInitialRcOptions

| Method | Type | | ---------- | ---------- | | getInitialRcOptions | () => any |

:factory: BuiltinViews

Methods

• getCommandHistoryLogMdView
• getCommandHistoryLogQuery
• getProjectStatusView
• getNpmRcFileView
• getYarnRcYamlFileView
• getReadmeQuery
• getReadmeView
• getBuildQuery
• getBuildView

:gear: getCommandHistoryLogMdView

| Method | Type | | ---------- | ---------- | | getCommandHistoryLogMdView | () => string |

:gear: getCommandHistoryLogQuery

| Method | Type | | ---------- | ---------- | | getCommandHistoryLogQuery | () => string |

:gear: getProjectStatusView

| Method | Type | | ---------- | ---------- | | getProjectStatusView | () => string |

:gear: getNpmRcFileView

| Method | Type | | ---------- | ---------- | | getNpmRcFileView | () => string |

:gear: getYarnRcYamlFileView

| Method | Type | | ---------- | ---------- | | getYarnRcYamlFileView | () => string |

:gear: getReadmeQuery

| Method | Type | | ---------- | ---------- | | getReadmeQuery | () => string |

:gear: getReadmeView

| Method | Type | | ---------- | ---------- | | getReadmeView | () => string |

:gear: getBuildQuery

| Method | Type | | ---------- | ---------- | | getBuildQuery | () => string |

:gear: getBuildView

| Method | Type | | ---------- | ---------- | | getBuildView | () => string |

:factory: ViewRenderer

Methods

• render

:gear: render

| Method | Type | | ---------- | ---------- | | render | (template: string, context: object, debug?: Boolean) => string |

:factory: QueryRunner

Methods

• addParameter
• runQuery

:gear: addParameter

| Method | Type | | ---------- | ---------- | | addParameter | (name: string, value: any) => void |

:gear: runQuery

| Method | Type | | ---------- | ---------- | | runQuery | (debug?: Boolean) => string |

:nut_and_bolt: Enum

• PackageManagers
• VersionControlTools
• BuildTools
• LogLevels
• FormattedMessageType

:gear: PackageManagers

| Property | Type | Description | | ---------- | ---------- | ---------- | | INVALID_PM | 'invalid_pm' | | | NPM | 'npm' | | | YARN | 'yarn' | |

:gear: VersionControlTools

| Property | Type | Description | | ---------- | ---------- | ---------- | | INVALID_VCT | 'invalid_vct' | | | GIT | 'git' | |

:gear: BuildTools

| Property | Type | Description | | ---------- | ---------- | ---------- | | INVALID_BT | 'invalid_bt' | | | GRADLE | 'gradle' | |

:gear: LogLevels

| Property | Type | Description | | ---------- | ---------- | ---------- | | NONE | 'none' | | | ERROR | 'error' | | | INFO | 'info' | | | DEBUG | 'debug' | |

:gear: FormattedMessageType

| Property | Type | Description | | ---------- | ---------- | ---------- | | NORMAL | "normal" | | | WARNING | "warning" | | | ERROR | "error" | |