git-author-change
v1.1.1
Published
Change Git author information in repositories
Downloads
9
Readme
Git Author Change
Git Author Change is a Node.js module that allows you to change the author information in a Git repository. This can be useful when you want to update the commit history with a different author name and email.
Installation
You can install this module via npm:
npm install git-author-change
Usage
In your Node.js project, you can use the functions provided by this module to change the author information in a Git repository.
const { useChangeAuthor, changeAuthor } = require('git-author-change');
// Usage examples
useChangeAuthor("newname", "repository-url");
changeAuthor("repository-url", "newname", "newemail");
useChangeAuthor(username, url)
This function simplifies the process of changing the author information by generating a random email address and invoking the changeAuthor
function.
username
(string): The new author's name.url
(string): The URL of the Git repository to modify.
changeAuthor(repoUrl, newName, newEmail)
This function changes the author information in the specified Git repository.
repoUrl
(string): The URL of the Git repository to modify.newName
(string): The new author's name.newEmail
(string): The new author's email.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Contributing
Feel free to open issues and pull requests to contribute to this project.
Acknowledgments
This project is built on Node.js and uses the slugify package.