Class NodeFsLocalProject

Hierarchy

AbstractProject
- NodeFsLocalProject
  - GitCommandGitProject

Implements

Index

Constructors

constructor

Properties

Accessors

dirty
name

Constructors

constructor

new NodeFsLocalProject(ident: RepoRef | string, baseDir: string, cleanup?: ReleaseFunction, shouldCache?: boolean): NodeFsLocalProject

Overrides AbstractProject.constructor
- Defined in lib/project/local/NodeFsLocalProject.ts:85
Note: this does not validate existence of the target directory, so using it except in tests should be avoided

Parameters
- ident: RepoRef | string
  
  identification of the repo
- baseDir: string
- Default value cleanup: ReleaseFunction = () => Promise.resolve()
  
  function that will release locks, delete temp directories etc
- Default value shouldCache: boolean = false
Returns NodeFsLocalProject

Properties

Readonly baseDir

baseDir: string

Base directory of the project on the local file system

Readonly cache

cache: Record<string, object>

Private Readonly cleanup

cleanup: ReleaseFunction

function that will release locks, delete temp directories etc

id

shouldCache

shouldCache: boolean

Accessors

dirty

get dirty(): boolean

Inherited from AbstractScriptedFlushable.dirty
- Defined in lib/internal/common/AbstractScriptedFlushable.ts:18
Returns boolean

name

get name(): string

Inherited from AbstractProject.name
- Defined in lib/project/support/AbstractProject.ts:22
Returns string

Methods

add

add(f: File): Promise<this>

Implementation of LocalProject.add

Inherited from AbstractProject.add
- Defined in lib/project/support/AbstractProject.ts:119
Parameters
- f: File
Returns Promise<this>

addDirectory

addDirectory(path: string): Promise<this>

Implementation of LocalProject.addDirectory

Overrides AbstractProject.addDirectory
- Defined in lib/project/local/NodeFsLocalProject.ts:120
Parameters
- path: string
Returns Promise<this>

addFile

addFile(path: string, content: string): Promise<this>

Implementation of LocalProject.addFile

Overrides AbstractProject.addFile
- Defined in lib/project/local/NodeFsLocalProject.ts:113
Parameters
- path: string
- content: string
Returns Promise<this>

addFileSync

addFileSync(path: string, content: string): void

Implementation of LocalProject.addFileSync

Overrides AbstractProject.addFileSync
- Defined in lib/project/local/NodeFsLocalProject.ts:107
Parameters
- path: string
- content: string
Returns void

deleteDirectory

deleteDirectory(path: string): Promise<this>

Implementation of LocalProject.deleteDirectory

Overrides AbstractProject.deleteDirectory
- Defined in lib/project/local/NodeFsLocalProject.ts:127
Parameters
- path: string
Returns Promise<this>

deleteDirectorySync

deleteDirectorySync(path: string): void

Implementation of LocalProject.deleteDirectorySync

Overrides AbstractProject.deleteDirectorySync
- Defined in lib/project/local/NodeFsLocalProject.ts:137
Parameters
- path: string
Returns void

deleteFile

deleteFile(path: string): Promise<this>

Implementation of LocalProject.deleteFile

Overrides AbstractProject.deleteFile
- Defined in lib/project/local/NodeFsLocalProject.ts:156
Parameters
- path: string
Returns Promise<this>

deleteFileSync

deleteFileSync(path: string): void

Implementation of LocalProject.deleteFileSync

Overrides AbstractProject.deleteFileSync
- Defined in lib/project/local/NodeFsLocalProject.ts:147
Parameters
- path: string
Returns void

directoryExistsSync

directoryExistsSync(path: string): boolean

Implementation of LocalProject.directoryExistsSync

Overrides AbstractProject.directoryExistsSync
- Defined in lib/project/local/NodeFsLocalProject.ts:181
Parameters
- path: string
Returns boolean

fileExistsSync

fileExistsSync(path: string): boolean

Implementation of LocalProject.fileExistsSync

Overrides AbstractProject.fileExistsSync
- Defined in lib/project/local/NodeFsLocalProject.ts:199
Parameters
- path: string
Returns boolean

findFile

findFile(path: string): Promise<File>

Implementation of LocalProject.findFile

Overrides AbstractProject.findFile
- Defined in lib/project/local/NodeFsLocalProject.ts:208
Parameters
- path: string
Returns Promise<File>

findFileSync

findFileSync(path: string): File

Implementation of LocalProject.findFileSync

Overrides AbstractProject.findFileSync
- Defined in lib/project/local/NodeFsLocalProject.ts:230
Parameters
- path: string
Returns File

flush

flush(): Promise<this>

Implementation of ScriptedFlushable.flush

Inherited from AbstractScriptedFlushable.flush
- Defined in lib/internal/common/AbstractScriptedFlushable.ts:22
Returns Promise<this>

getFile

getFile(path: string): Promise<File>

Implementation of LocalProject.getFile

Overrides AbstractProject.getFile
- Defined in lib/project/local/NodeFsLocalProject.ts:221
Parameters
- path: string
Returns Promise<File>

getFiles

getFiles(globPatterns?: string | string[]): Promise<File[]>

Implementation of LocalProject.getFiles

Inherited from AbstractProject.getFiles
- Defined in lib/project/support/AbstractProject.ts:59
Get files matching these patterns

Parameters
- Default value globPatterns: string | string[] = []
Returns Promise<File[]>

Protected getFilesInternal

getFilesInternal(globPatterns: string[]): Promise<File[]>

Overrides AbstractProject.getFilesInternal
- Defined in lib/project/local/NodeFsLocalProject.ts:239
Parameters
- globPatterns: string[]
Returns Promise<File[]>

hasDirectory

hasDirectory(path: string): Promise<boolean>

Implementation of LocalProject.hasDirectory

Overrides AbstractProject.hasDirectory
- Defined in lib/project/local/NodeFsLocalProject.ts:190
Parameters
- path: string
Returns Promise<boolean>

hasFile

hasFile(path: string): Promise<boolean>

Implementation of LocalProject.hasFile

Inherited from AbstractProject.hasFile
- Defined in lib/project/support/AbstractProject.ts:39
Parameters
- path: string
Returns Promise<boolean>

Protected invalidateCache

invalidateCache(): void

Inherited from AbstractProject.invalidateCache
- Defined in lib/project/support/AbstractProject.ts:137
Returns void

makeExecutable

makeExecutable(path: string): Promise<this>

Implementation of LocalProject.makeExecutable

Overrides AbstractProject.makeExecutable
- Defined in lib/project/local/NodeFsLocalProject.ts:166
Parameters
- path: string
Returns Promise<this>

makeExecutableSync

makeExecutableSync(path: string): void

Implementation of LocalProject.makeExecutableSync

Overrides AbstractProject.makeExecutableSync
- Defined in lib/project/local/NodeFsLocalProject.ts:174
Parameters
- path: string
Returns void

moveFile

moveFile(oldPath: string, newPath: string): Promise<this>

Implementation of LocalProject.moveFile

Inherited from AbstractProject.moveFile
- Defined in lib/project/support/AbstractProject.ts:93
Parameters
- oldPath: string
- newPath: string
Returns Promise<this>

recordAction

recordAction(action: ScriptAction<Project, any>): this

Implementation of ScriptedFlushable.recordAction

Inherited from AbstractScriptedFlushable.recordAction
- Defined in lib/internal/common/AbstractScriptedFlushable.ts:13
Parameters
- action: ScriptAction<Project, any>
Returns this

recordAddFile

recordAddFile(path: string, content: string): this

Inherited from AbstractProject.recordAddFile
- Defined in lib/project/support/AbstractProject.ts:104
Parameters
- path: string
- content: string
Returns this

recordDeleteFile

recordDeleteFile(path: string): this

Inherited from AbstractProject.recordDeleteFile
- Defined in lib/project/support/AbstractProject.ts:108
Parameters
- path: string
Returns this

release

release(): Promise<void>

- Defined in lib/project/local/NodeFsLocalProject.ts:103
Returns Promise<void>

streamFiles

streamFiles(...globPatterns: string[]): FileStream

Implementation of LocalProject.streamFiles

Inherited from AbstractProject.streamFiles
- Defined in lib/project/support/AbstractProject.ts:47
Parameters
- Rest ...globPatterns: string[]
Returns FileStream

streamFilesRaw

streamFilesRaw(globPatterns: string[], opts: fg.Options): FileStream

Implementation of LocalProject.streamFilesRaw

Overrides AbstractProject.streamFilesRaw
- Defined in lib/project/local/NodeFsLocalProject.ts:250
Parameters
- globPatterns: string[]
- opts: fg.Options
Returns FileStream

Private toRealPath

toRealPath(path: string): string

- Defined in lib/project/local/NodeFsLocalProject.ts:272
Parameters
- path: string
Returns string

totalFileCount

totalFileCount(): Promise<number>

Implementation of LocalProject.totalFileCount

Inherited from AbstractProject.totalFileCount
- Defined in lib/project/support/AbstractProject.ts:81
Returns Promise<number>

trackFile

trackFile(f: FileNonBlocking): this

Inherited from AbstractProject.trackFile
- Defined in lib/project/support/AbstractProject.ts:86
Parameters
- f: FileNonBlocking
Returns this

Static copy

copy(other: Project, baseDir: string, cleanup?: ReleaseFunction): Promise<LocalProject>

- Defined in lib/project/local/NodeFsLocalProject.ts:54
Copy the contents of the other project to this project

Parameters
- other: Project
- baseDir: string
- Default value cleanup: ReleaseFunction = () => Promise.resolve()
Returns Promise<LocalProject>

Static fromExistingDirectory

fromExistingDirectory(id: RepoRef, baseDir: string, cleanup?: ReleaseFunction): Promise<LocalProject>

- Defined in lib/project/local/NodeFsLocalProject.ts:35
Create a project from an existing directory. The directory must exist

Parameters
- id: RepoRef
- baseDir: string
- Default value cleanup: ReleaseFunction = () => Promise.resolve()
Returns Promise<LocalProject>

Generated using TypeDoc