Use to cache arbitrary content associated with this instance. Use for smallish objects that are expensive to compute.
For debugging: how was this project created?
Release any locks held
Add a file preserving permissions
Add an empty directory to the project. Should be preserved through all transformations, although may not be accessible in some implementations.
path to directory relative to root of project
Add the given file to the project. Path can be nested. Content is a literal string.
path to file relative to root of project
The content to be placed in the new file
Add the given file to the project. Path can be nested. Content is a literal string. This method will throw an error if it is not successful.
path to file relative to root of project
The content to be placed in the new file
Check out a particular commit. We'll end in detached head state
sha or branch identifier
Commit to local git
Sets the user config by using GitHub user information. Make sure to use a token that has user scope.
Create a remote repository and set this repository's remote to it.
Create a new branch and switch to it.
Name of the new branch
Recursively delete a directory and all its contents. Path can be nested. Errors when deleting the directory do not result in a rejected Promise being returned.
path to directory relative to root of project
Recursively deletes a directory and all its contents with the given path. Errors when deleting the directory are caught.
path to directory relative to root of project
Delete the given file from the project. Path can be nested. Errors when deleting the file do not result in a rejected Promise being returned.
path to file relative to root of project
Delete the given file from the project. Path can be nested. Errors when deleting the file are caught.
path to file relative to root of project
Does a directory with the given path exist?
path to directory relative to root of project
Does a regular file with the given path exist? It will return false if the file does not exist or is not a regular file.
path to file relative to root of project
Attempt to find a regular file at path. This method will return a rejected Promise if the file does not exist or is not a regular file. You may well want getFile, which returns a Promise of the file or undefined.
path to file relative to root of project
Find a regular file with the given path. Return undefined if file does not exist or is not a regular file.
path to file relative to root of project
Attempt to find a regular file at path. Never throws an exception, returns undefined if file does not exist or is not a regular file.
path to file relative to root of project
Get files matching these patterns glob patterns.
Get some status information
Check for existence of a branch
Does a directory exist at this path? It will return false if directory does not exist or if file at path is not a directory.
path to directory relative to root of project
Does a regular file exist at this path? It will return false for non-existent files, directories, block devices, FIFOs, sockets, etc.
path to file relative to root of project
Init git for this project.
Does the project have uncommitted changes in Git? Success means it's clean
Make a file executable. Other permissions are unchanged.
path to file relative to root of project
Makes a file executable. Other permissions are unchanged.
path to file relative to root of project
Move the file. Do not error if it's not found.
Push to the remote.
Raise a PR after a push to this branch
Revert all changes since last commit
Remote is of form https://github.com/USERNAME/REPOSITORY.git
Sets the given user and email as the running git commands
Return a node stream of the files in the project meeting the given path criteria. Uses default exclusions in the glob path.
glob patterns per micromatch
Stream file with full control over globs. At least one glob must be provided. No default exclusions will be used.
glob patterns per micromatch
for glob handling
The total number of files in this project or directory
totalFileCount
Generated using TypeDoc
Local project using git. Provides the ability to perform git operations such as commit, and to set and push to a remote.