gg_git_test_helpers library

Constants

sampleFileName → const String
The name of the sample file

Functions

addAndCommitGitIgnoreFile(Directory d, {String content = ''}) Future<void>
Adds a gitignore file to the test directory
addAndCommitPubspecFile(Directory testDir, {String? version = '1.0.0'}) Future<File>
Adds and commits a pubspec file
addAndCommitSampleFile(Directory testDir, {String fileName = sampleFileName, String content = 'sample', String message = 'Commit Message'}) Future<File>
Add and commit sample file
addAndCommitVersions(Directory testDir, {required String? pubspec, required String? changeLog, required String? gitHead, String? appendToPubspec}) Future<void>
Write version into pubspec.yaml, Changelog.md and add a tag
addChangeLogWithoutCommitting(Directory testDir, {String? version = '1.0.0'}) Future<void>
Create a CHANGELOG.md file with a version
addFileWithoutCommitting(Directory testDir, {String fileName = sampleFileName, String content = 'Content'}) Future<File>
Init a file with a name in the test directory
addPubspecFileWithoutCommitting(Directory testDir, {required String? version, String? additionalContent}) Future<File>
Create a pubspec.yaml file with a version
addRemoteToLocal({required Directory local, required Directory remote}) Future<void>
Adds a remote git repo to a local git repo
addTag(Directory testDir, String tag) Future<void>
Add tag to test directory
addTags(Directory testDir, List<String> tags) Future<void>
Add tags to test directory
branchName(Directory testDir) Future<String>
Returns the name of the current branch in testDir
commitChangeLog(Directory testDir) Future<void>
Commit the changelog file
commitFile(Directory testDir, String fileName, {String message = 'Commit Message', bool stage = true, bool ammend = false}) Future<void>
Commit the file with a name in the test directory
commitPubspecFile(Directory testDir) Future<void>
Commit the pubspec file
createBranch(Directory testDir, String branchName) Future<void>
Creates a branch in the git repo in testDir
deleteFileAndCommit(Directory testDir, String fileName) Future<void>
Deletes and commits a file
enableEolLf(Directory testDir) Future<void>
Add and commit sample file
hardReset(Directory directory) Future<void>
Reverts all local changes in the directory
initGit(Directory testDir, {bool isEolLfEnabled = true}) Future<void>
Init git repository in test directory
initLocalAndRemoteGit() Future<(Directory, Directory)>
Creates a local and a remote git repository and connects them
initLocalGit(Directory testDir) Future<void>
Init local git repository in directory
initRemoteGit(Directory testDir) Future<void>
Init remote git repository in directory
initTestDir() Future<Directory>
Initializes a test directory
isEolLfEnabled(Directory testDir) Future<bool>
Returns true when EOL LF is enabled
modifiedFiles(Directory directory) Future<List<String>>
Returns a list of modified files in the directory
pushLocalChanges(Directory d) Future<void>
Adds and pushes local changes
revertLocalChanges(Directory directory) Future<void>
Reverts all local changes in the directory
stageFile(Directory testDir, String fileName) Future<void>
Commit the file with a name in the test directory
updateAndCommitSampleFile(Directory testDir, {String message = 'Commit Message', String fileName = sampleFileName, bool ammend = false}) Future<File>
Update and commit sample file
updateSampleFileWithoutCommitting(Directory testDir, {String fileName = sampleFileName, String message = 'Commit Message'}) Future<File>
Update and commit sample file
upstreamBranchName(Directory testDir) Future<String>
Returns the name of the upstream branch