Skip to content

Latest commit

 

History

History
102 lines (75 loc) · 2.6 KB

README.md

File metadata and controls

102 lines (75 loc) · 2.6 KB
Raw

📊🔍 git-remote-refs-cmp

🚀 Efficient Git Reference Comparison with ES2023 TypeScript Library 🚀

✨ Features

  • Robust Git Commands: Execute Git commands seamlessly.
  • Structured Data Parsing: Convert git ls-remote outputs into concrete objects.
  • Remote Comparison: Compare Git references across different remotes.
  • Detailed Output: Get comprehensive reports on differences.

👥 Who Should Use This?

Perfect for developers and DevOps engineers managing git mirrors, this tool offers a fast and efficient way to check your mirrors are up-to-date.

Ready to streamline your Git workflows? 🌟

📦 Installation

Install via npm:

npm install https://github.com/rindeal-js/git-remote-refs-cmp

🚀 Quick Start

import { gitRemoteRefsCmp } from 'git-remote-refs-cmp'

(async () => {
  const sourceRemote = 'https://github.com/source-repo.git'
  const targetRemote = 'https://github.com/target-repo.git'
  const diff = await gitRemoteRefsCmp(sourceRemote, targetRemote)
  if ( diff ) {
    console.log('Difference found:', diff.message)
  } else {
    console.log('No differences found.')
  }
})()

📚 Additional Examples

Use the GitRemoteRefsCmp() object to initialize once and run multiple comparison queries efficiently:

import { GitRemoteRefsCmp } from 'git-remote-refs-cmp'

(async () => {
  const cmp = GitRemoteRefsCmp()
  cmp.init()

  const diff = cmp.compare(sourceRemote, targetRemote)
  const diff2 = cmp.compare(sourceRemote2, targetRemote2)
  ...
})()

For a lower level access and handling:

import {
  GitCommandManager,
  GitLsRemoteParser,
  GitLsRemoteOutputCmp,
} from 'git-remote-refs-cmp'

(async () => {
  const git = new GitCommandManager()
  await git.init()
  const parser = new GitLsRemoteParser()
  const lsRemoteCmp = new GitLsRemoteOutputCmp()

  let [source, target] = await Promise.all(
    [sourceRemote, targetRemote].map(async (remote) =>
      parser.parse(await git.lsRemote({ remote }), remote)
    )
  )
  let diff = lsRemoteCmp.compare(source, target)
  ...
})()

⚠️ Limitations

  • Only remote Git repositories are supported.
  • No extra credentials handling.
    • You need to use native Git authentication methods if you want to compare private repos.
  • Only equality comparison, it cannot tell you which one is older/newer etc.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📜 License

This project is licensed under the GPL-3.0-only OR GPL-2.0-only License. See the LICENSE.md file for details.