@mach30/m30pm-lib-fs
v0.1.1
Published
Mach 30 PM filesystem implementation library
Readme
m30pm-lib-fs
Mach 30 PM filesystem implementation library
:toolbox: Functions
- getShell
- initializeProjectDirectory
- generatePackageManagerScaffolding
- initializeBuildTool
- initializeVersionControlTool
- getVctNextStep
:gear: getShell
| Function | Type |
| ---------- | ---------- |
| getShell | () => any |
:gear: initializeProjectDirectory
| Function | Type |
| ---------- | ---------- |
| initializeProjectDirectory | (project: ProjectConfiguration, workingDirectory: string, projectDirectory: string) => CommandHistory |
:gear: generatePackageManagerScaffolding
| Function | Type |
| ---------- | ---------- |
| generatePackageManagerScaffolding | (project: ProjectConfiguration, projectDirectory: string) => CommandHistory |
:gear: initializeBuildTool
| Function | Type |
| ---------- | ---------- |
| initializeBuildTool | (project: ProjectConfiguration, projectDirectory: string, buildToolPath: string) => CommandHistory |
:gear: initializeVersionControlTool
| Function | Type |
| ---------- | ---------- |
| initializeVersionControlTool | (project: ProjectConfiguration, projectDirectory: string, versionControlToolPath: string) => CommandHistory |
:gear: getVctNextStep
| Function | Type |
| ---------- | ---------- |
| getVctNextStep | (versionControlTool: VersionControlTools) => string |
:factory: ShellCommand
Methods
:gear: toJsObject
| Method | Type |
| ---------- | ---------- |
| toJsObject | () => Object |
:gear: execute
| Method | Type |
| ---------- | ---------- |
| execute | () => boolean |
:factory: CommandHistory
Methods
:gear: addExecutedCommand
| Method | Type |
| ---------- | ---------- |
| addExecutedCommand | (command: ShellCommand) => boolean |
:gear: toJsObject
| Method | Type |
| ---------- | ---------- |
| toJsObject | () => Object |
:factory: FunctionArgument
Methods
:gear: toJsObject
| Method | Type |
| ---------- | ---------- |
| toJsObject | () => Object |
:factory: FunctionInfo
Methods
:gear: addArgument
| Method | Type |
| ---------- | ---------- |
| addArgument | (argument: FunctionArgument) => void |
:gear: toJsObject
| Method | Type |
| ---------- | ---------- |
| toJsObject | () => Object |
:factory: CommandHistoryLogger
Methods
:gear: addCommandHistory
| Method | Type |
| ---------- | ---------- |
| addCommandHistory | (cmdHistory: CommandHistory) => void |
:gear: toJsObject
| Method | Type |
| ---------- | ---------- |
| toJsObject | () => Object |
:gear: writeLog
| Method | Type |
| ---------- | ---------- |
| writeLog | () => void |
:factory: ToolInfo
Methods
:gear: toJsObject
| Method | Type |
| ---------- | ---------- |
| toJsObject | () => Object |
:factory: Projects
Methods
:gear: createProject
| Method | Type |
| ---------- | ---------- |
| createProject | (project: ProjectConfiguration, notifyUser: NotifyUserFunction) => void |
:nut_and_bolt: Enum
:gear: CommandToRun
| Property | Type | Description |
| ---------- | ---------- | ---------- |
| CAT | "cat" | |
| EXEC | "exec" | |
| LS | "ls" | |
| MKDIR | "mkdir" | |
| PWD | "pwd" | |
| RM | "rm" | |
| TEMP_DIR | "tempdir" | |
| TO_FILE | "toFile" | |
| TOUCH | "touch" | |
| WHICH | "which" | |
