Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c6e3a1caa3 | |||
| a92275088b | |||
| 2b246502f5 | |||
| 81b2b225a3 | |||
| 9a2d5afc04 | |||
| 6404c8342a | |||
| b14ae1d8a6 | |||
| 753bc49c4e | |||
| a5dae9b3a3 | |||
| af909047ae | |||
| 11cbe93b4b | |||
| e8c3d3c44f | |||
| a2485560b3 | |||
| 7aa83ac730 | |||
| 141af9843f | |||
| 71e84e79b1 | |||
| aefcf56f0e |
76
changelog.md
Normal file
76
changelog.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-01-04 - 3.2.0 - feat(core)
|
||||
Enhanced error handling, type safety, and documentation
|
||||
|
||||
- Add comprehensive error handling with try/catch blocks and meaningful error messages
|
||||
- Improve type safety with proper IEnvDeps interface replacing 'any' types
|
||||
- Add complete JSDoc documentation for all classes and methods
|
||||
- Add return type annotations for better TypeScript support
|
||||
- Add ensureInitialized() validation method
|
||||
- Fix missing return statement in createRepoByClone() method
|
||||
- Remove deprecated @types/minimatch dependency
|
||||
- Complete readme rewrite with modern styling, accurate documentation, and proper API examples
|
||||
- Update license from LICENSE to license.md following project guidelines
|
||||
|
||||
## 2024-06-23 - 3.1.1 - fix(documentation)
|
||||
Remove outdated changelog entries
|
||||
|
||||
## 2024-06-23 - 3.1.0 - gitrepo
|
||||
Enhancements and fixes to GitRepo
|
||||
|
||||
- Enhance GitRepo to include commit date and version information
|
||||
|
||||
## 2024-06-22 - 3.0.3 to 3.0.4 - core & GitRepo
|
||||
General updates and new feature addition
|
||||
|
||||
- Fixed core functionality
|
||||
- Added diff function in GitRepo
|
||||
|
||||
## 2023-11-15 - 3.0.1 to 3.0.2 - core, tsconfig, npmextra
|
||||
Minor updates and fixes
|
||||
|
||||
- Fixed core functionality
|
||||
- Updated tsconfig and npmextra.json
|
||||
|
||||
## 2023-07-10 - 3.0.0 - core
|
||||
Structural changes to organization scheme
|
||||
|
||||
- Switched to a new organizational scheme
|
||||
|
||||
## 2023-07-27 - 3.0.0 to 3.0.1 - core
|
||||
Structural changes and updates
|
||||
|
||||
- Fixed core functionality
|
||||
- Switched to new organizational scheme
|
||||
|
||||
## 2022-07-31 - 2.0.2 to 3.0.0 - core
|
||||
Breaking changes and updates
|
||||
|
||||
- Switching to ESM for core
|
||||
- Fixed core functionality
|
||||
|
||||
## 2021-10-22 - 1.0.18 to 2.0.1 - dependencies, core
|
||||
Breaking changes and updates
|
||||
|
||||
- Switched to isomorphic git dependencies
|
||||
- Fixed core functionality
|
||||
|
||||
## 2020-08-15 - 1.0.14 to 1.0.18 - core
|
||||
Fixes
|
||||
|
||||
- Fixed core functionality in multiple patches
|
||||
|
||||
## 2019-06-18 - 1.0.5 to 1.0.10 - core
|
||||
Fixes
|
||||
|
||||
- Fixed core functionality in multiple patches
|
||||
|
||||
## 2016-06-23 - 0.0.10 to 0.1.11 - gitlab & other fixes
|
||||
Initial implementations and setup
|
||||
|
||||
- Fixed README and merge issues
|
||||
- Updated gitlab.yml and CI settings
|
||||
- Implemented new class approach and other updates
|
||||
- Removed unnecessary imports, postinstall
|
||||
- Added npmextra.json, CI tests, SSH key support
|
||||
@@ -6,12 +6,26 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartgit",
|
||||
"description": "smart wrapper for nodegit",
|
||||
"description": "A smart wrapper for nodegit that simplifies Git operations in Node.js.",
|
||||
"npmPackagename": "@push.rocks/smartgit",
|
||||
"license": "MIT"
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"git",
|
||||
"nodegit",
|
||||
"version control",
|
||||
"git wrapper",
|
||||
"programming",
|
||||
"development",
|
||||
"code management",
|
||||
"repository management",
|
||||
"git operations"
|
||||
]
|
||||
}
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
48
package.json
48
package.json
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@push.rocks/smartgit",
|
||||
"version": "3.0.2",
|
||||
"description": "smart wrapper for nodegit",
|
||||
"version": "3.2.0",
|
||||
"description": "A smart wrapper for nodegit that simplifies Git operations in Node.js.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
@@ -12,34 +12,41 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://gitlab.com/pushrocks/smartgit.git"
|
||||
"url": "https://code.foss.global/push.rocks/smartgit.git"
|
||||
},
|
||||
"keywords": [
|
||||
"json",
|
||||
"jade",
|
||||
"template"
|
||||
"git",
|
||||
"nodegit",
|
||||
"version control",
|
||||
"git wrapper",
|
||||
"programming",
|
||||
"development",
|
||||
"code management",
|
||||
"repository management",
|
||||
"git operations"
|
||||
],
|
||||
"author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/pushrocks/smartgit/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/smartgit",
|
||||
"homepage": "https://code.foss.global/push.rocks/smartgit",
|
||||
"dependencies": {
|
||||
"@push.rocks/smartenv": "^5.0.12",
|
||||
"@push.rocks/smartfile": "^11.0.0",
|
||||
"@push.rocks/smartpath": "^5.0.5",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartshell": "^3.0.3",
|
||||
"@push.rocks/smartstring": "^4.0.9",
|
||||
"@types/minimatch": "^5.1.2",
|
||||
"isomorphic-git": "^1.25.0"
|
||||
"@push.rocks/smartenv": "^5.0.13",
|
||||
"@push.rocks/smartfile": "^11.2.5",
|
||||
"@push.rocks/smartpath": "^6.0.0",
|
||||
"@push.rocks/smartpromise": "^4.2.3",
|
||||
"@push.rocks/smartshell": "^3.2.3",
|
||||
"@push.rocks/smartstring": "^4.0.15",
|
||||
"@push.rocks/smarttime": "^4.1.1",
|
||||
"@types/diff": "^8.0.0",
|
||||
"diff": "^8.0.2",
|
||||
"isomorphic-git": "^1.32.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.77",
|
||||
"@push.rocks/tapbundle": "^5.0.15"
|
||||
"@git.zone/tsbuild": "^2.6.4",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^2.3.2"
|
||||
},
|
||||
"private": false,
|
||||
"files": [
|
||||
@@ -56,5 +63,6 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
],
|
||||
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
|
||||
}
|
||||
|
||||
12344
pnpm-lock.yaml
generated
12344
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
4
pnpm-workspace.yaml
Normal file
4
pnpm-workspace.yaml
Normal file
@@ -0,0 +1,4 @@
|
||||
onlyBuiltDependencies:
|
||||
- esbuild
|
||||
- mongodb-memory-server
|
||||
- puppeteer
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
||||
|
||||
287
readme.md
287
readme.md
@@ -1,85 +1,238 @@
|
||||
# @push.rocks/smartgit
|
||||
smart wrapper for nodegit
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartgit)
|
||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartgit)
|
||||
* [github.com (source mirror)](https://github.com/push.rocks/smartgit)
|
||||
* [docs (typedoc)](https://push.rocks.gitlab.io/smartgit/)
|
||||
> 🚀 **Modern Git operations for Node.js** - A powerful TypeScript wrapper around isomorphic-git that makes repository management and analysis a breeze
|
||||
|
||||
## Status for master
|
||||
[](https://badge.fury.io/js/@push.rocks%2Fsmartgit)
|
||||
[](https://www.typescriptlang.org/)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
## ✨ What is SmartGit?
|
||||
|
||||
## Usage
|
||||
SmartGit is a sophisticated, promise-based Git toolkit designed for Node.js applications. Built on top of `isomorphic-git`, it provides a clean, intuitive API for repository management, diff analysis, and commit history exploration. Perfect for automation tools, CI/CD pipelines, and any application that needs to interact with Git repositories programmatically.
|
||||
|
||||
We recommend the use of TypeScript for best in class intellisense
|
||||
## 🎯 Key Features
|
||||
|
||||
```javascript
|
||||
// import smartgit:
|
||||
import { GitRepo } from 'smartgit';
|
||||
- **🔧 Repository Management** - Create, clone, and open repositories with ease
|
||||
- **🌐 Remote Operations** - Manage remotes and push changes effortlessly
|
||||
- **📊 Diff Analysis** - Get detailed diffs of uncommitted changes
|
||||
- **📚 Commit History** - Extract commit messages with metadata and version tracking
|
||||
- **⚡ Async/Await** - Modern promise-based API throughout
|
||||
- **🛡️ TypeScript First** - Full type safety and IntelliSense support
|
||||
- **🎯 Production Ready** - Battle-tested and actively maintained
|
||||
|
||||
// Initialize smartgit:
|
||||
// -- note: there are 3 ways to initialize smartgit
|
||||
// -- -- 1. with a existing Git repo
|
||||
// -- -- 2. with a cloned Git repo
|
||||
// -- -- 3. with a new Git repo
|
||||
## 📦 Installation
|
||||
|
||||
// -- 1. existing Git Repo:
|
||||
let myExistingGitRepo = new GitRepo('/path/to/existing/git/repo/');
|
||||
```bash
|
||||
# Using pnpm (recommended)
|
||||
pnpm install @push.rocks/smartgit
|
||||
|
||||
// -- 2. cloned Git Repo:
|
||||
let myClonedGitRepo: GitRepo;
|
||||
smartgit.createRepoFromClone('git@github.com:username/reponame.git').then((gitRepo) => {
|
||||
// non blocking
|
||||
myClonedGitRepo = gitRepo;
|
||||
});
|
||||
# Using npm
|
||||
npm install @push.rocks/smartgit
|
||||
|
||||
// -- 3. new Git Repo
|
||||
let myNewGitRepo: GitRepo;
|
||||
smartgit
|
||||
.createRepoFromInit('/path/to/new/folder') // smartgit will create any new folder, be careful
|
||||
.then((gitRepo) => {
|
||||
// non blocking
|
||||
myNewGitRepo = gitRepo;
|
||||
});
|
||||
|
||||
// Using smartgit instance
|
||||
// -- most used actions
|
||||
// -- all actions return promises, so make sure to use promise chaining for any dependent tasks
|
||||
myExistingGitRepo.addAll(); // returns promise, stages all changed files
|
||||
myExistingGitRepo.add(['relative/path/to/file.txt', 'another/file2.txt']); // returns promise, stages specific files
|
||||
myExistingGitRepo.commit('my commit message'); // returns promise, commits staged files
|
||||
myExistingGitRepo
|
||||
.status() // returns promise
|
||||
.then((status) => {
|
||||
// Use TypeScript for status type information
|
||||
});
|
||||
myExistingGitRepo.check(); // returns promise, checks repo health
|
||||
myExistingGitRepo.remoteAdd('git@github.com:username/reponame.git');
|
||||
# Using yarn
|
||||
yarn add @push.rocks/smartgit
|
||||
```
|
||||
|
||||
Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment
|
||||
## 🚀 Quick Start
|
||||
|
||||
[](https://push.rocks)
|
||||
```typescript
|
||||
import { Smartgit } from '@push.rocks/smartgit';
|
||||
|
||||
## Contribution
|
||||
// Initialize SmartGit
|
||||
const smartgit = new Smartgit();
|
||||
await smartgit.init();
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
// Clone a repository
|
||||
const repo = await smartgit.createRepoByClone(
|
||||
'https://github.com/username/repo.git',
|
||||
'./local-repo'
|
||||
);
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
console.log('🎉 Repository cloned successfully!');
|
||||
```
|
||||
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
## 📖 Usage Guide
|
||||
|
||||
### 🏗️ Repository Operations
|
||||
|
||||
#### Creating a New Repository
|
||||
|
||||
```typescript
|
||||
const repo = await smartgit.createRepoByInit('./my-new-repo');
|
||||
```
|
||||
|
||||
#### Cloning from Remote
|
||||
|
||||
```typescript
|
||||
const repo = await smartgit.createRepoByClone(
|
||||
'https://github.com/octocat/Hello-World.git',
|
||||
'./hello-world'
|
||||
);
|
||||
```
|
||||
|
||||
#### Opening Existing Repository
|
||||
|
||||
```typescript
|
||||
const repo = await smartgit.createRepoByOpen('./existing-repo');
|
||||
```
|
||||
|
||||
### 🌐 Working with Remotes
|
||||
|
||||
#### List All Remotes
|
||||
|
||||
```typescript
|
||||
const remotes = await repo.listRemotes();
|
||||
console.log(remotes);
|
||||
// Output: [{ remote: 'origin', url: 'https://github.com/...' }]
|
||||
```
|
||||
|
||||
#### Ensure Remote Exists
|
||||
|
||||
```typescript
|
||||
await repo.ensureRemote('origin', 'https://github.com/username/repo.git');
|
||||
```
|
||||
|
||||
#### Get Remote URL
|
||||
|
||||
```typescript
|
||||
const originUrl = await repo.getUrlForRemote('origin');
|
||||
console.log(`📡 Origin URL: ${originUrl}`);
|
||||
```
|
||||
|
||||
#### Push to Remote
|
||||
|
||||
```typescript
|
||||
await repo.pushBranchToRemote('main', 'origin');
|
||||
console.log('✅ Changes pushed successfully!');
|
||||
```
|
||||
|
||||
### 📊 Diff Analysis
|
||||
|
||||
Get a detailed diff of uncommitted changes (perfect for code review automation):
|
||||
|
||||
```typescript
|
||||
const diffs = await repo.getUncommittedDiff(['node_modules/*', '*.log']);
|
||||
|
||||
diffs.forEach(diff => {
|
||||
console.log('📝 File changes:');
|
||||
console.log(diff);
|
||||
});
|
||||
```
|
||||
|
||||
### 📚 Commit History Analysis
|
||||
|
||||
Extract commit history with package.json version tracking:
|
||||
|
||||
```typescript
|
||||
const history = await repo.getAllCommitMessages();
|
||||
|
||||
history.forEach(commit => {
|
||||
console.log(`🕐 ${commit.date} | v${commit.version} | ${commit.message}`);
|
||||
});
|
||||
|
||||
// Example output:
|
||||
// 🕐 2024-01-15 | v1.2.3 | feat: add new authentication method
|
||||
// 🕐 2024-01-14 | v1.2.2 | fix: resolve memory leak in parser
|
||||
```
|
||||
|
||||
## 🛠️ Advanced Usage
|
||||
|
||||
### Error Handling
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const repo = await smartgit.createRepoByClone(invalidUrl, './test');
|
||||
} catch (error) {
|
||||
console.error('❌ Clone failed:', error.message);
|
||||
}
|
||||
```
|
||||
|
||||
### Working with Multiple Repositories
|
||||
|
||||
```typescript
|
||||
const smartgit = new Smartgit();
|
||||
await smartgit.init();
|
||||
|
||||
const repositories = [
|
||||
await smartgit.createRepoByOpen('./repo1'),
|
||||
await smartgit.createRepoByOpen('./repo2'),
|
||||
await smartgit.createRepoByOpen('./repo3')
|
||||
];
|
||||
|
||||
// Analyze all repositories
|
||||
for (const repo of repositories) {
|
||||
const remotes = await repo.listRemotes();
|
||||
console.log(`📂 Repository has ${remotes.length} remotes`);
|
||||
}
|
||||
```
|
||||
|
||||
## 🏗️ Architecture
|
||||
|
||||
SmartGit is built with a clean, modular architecture:
|
||||
|
||||
- **`Smartgit`** - Main entry point and repository factory
|
||||
- **`GitRepo`** - Individual repository operations and analysis
|
||||
- **`isomorphic-git`** - Underlying Git implementation
|
||||
- **Environment Detection** - Automatic Node.js environment setup
|
||||
|
||||
## 🎯 Use Cases
|
||||
|
||||
- **🤖 Automation Scripts** - Automate repository management and analysis
|
||||
- **🔄 CI/CD Pipelines** - Repository operations in build processes
|
||||
- **📊 Code Analysis Tools** - Extract commit data and diff analysis
|
||||
- **🛠️ Developer Tools** - Build Git-powered development utilities
|
||||
- **📱 Release Management** - Track versions and generate changelogs
|
||||
|
||||
## 🔧 Requirements
|
||||
|
||||
- **Node.js** 16+ (Browser support not available)
|
||||
- **Git repository** access (for clone operations)
|
||||
- **TypeScript** 4+ (recommended)
|
||||
|
||||
## 🤝 API Reference
|
||||
|
||||
### Smartgit Class
|
||||
|
||||
| Method | Description | Returns |
|
||||
|--------|-------------|---------|
|
||||
| `init()` | Initialize the SmartGit instance | `Promise<void>` |
|
||||
| `createRepoByInit(dir)` | Create new repository | `Promise<GitRepo>` |
|
||||
| `createRepoByClone(url, dir)` | Clone repository | `Promise<GitRepo>` |
|
||||
| `createRepoByOpen(dir)` | Open existing repository | `Promise<GitRepo>` |
|
||||
|
||||
### GitRepo Class
|
||||
|
||||
| Method | Description | Returns |
|
||||
|--------|-------------|---------|
|
||||
| `listRemotes()` | List all remotes | `Promise<{remote: string, url: string}[]>` |
|
||||
| `ensureRemote(name, url)` | Ensure remote exists | `Promise<void>` |
|
||||
| `getUrlForRemote(name)` | Get URL for remote | `Promise<string>` |
|
||||
| `pushBranchToRemote(branch, remote)` | Push branch to remote | `Promise<void>` |
|
||||
| `getUncommittedDiff(excludeFiles?)` | Get uncommitted changes | `Promise<string[]>` |
|
||||
| `getAllCommitMessages()` | Get commit history | `Promise<CommitInfo[]>` |
|
||||
|
||||
## 💡 Pro Tips
|
||||
|
||||
- **🔧 Always call `init()`** before using any repository operations
|
||||
- **📁 Use absolute paths** for repository directories when possible
|
||||
- **🚫 Exclude large files** from diff analysis using the `excludeFiles` parameter
|
||||
- **⚡ Batch operations** when working with multiple repositories
|
||||
- **🛡️ Handle errors gracefully** - network issues can cause clone operations to fail
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
30
test/test.ts
30
test/test.ts
@@ -1,13 +1,13 @@
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartgit from '../ts/index.js';
|
||||
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
const __dirname = smartpath.get.dirnameFromImportMetaUrl(import.meta.url);
|
||||
import * as path from 'path';
|
||||
|
||||
let testSmartgitInstance: smartgit.Smartgit;
|
||||
const testRepoDir = path.join(__dirname, '../.nogit/testrepo');
|
||||
const testRepoDirSmartfile = path.join(__dirname, '../.nogit/pushrocks_smartfile');
|
||||
const packageDir = path.join(smartpath.get.dirnameFromImportMetaUrl(import.meta.url), '../');
|
||||
const testRepoDir = path.join(packageDir, './.nogit/testrepo');
|
||||
const testRepoDirSmartfile = path.join(packageDir, './.nogit/pushrocks_smartfile');
|
||||
|
||||
tap.test('should create a valid smartgit instance', async () => {
|
||||
testSmartgitInstance = new smartgit.Smartgit();
|
||||
@@ -26,4 +26,26 @@ tap.test('should clone a repo', async () => {
|
||||
);
|
||||
});
|
||||
|
||||
tap.test('should open a repo', async () => {
|
||||
const gitRepo = await testSmartgitInstance.createRepoByOpen(packageDir);
|
||||
const diff = await gitRepo.getUncommittedDiff([
|
||||
'pnpm-lock.yaml',
|
||||
]);
|
||||
console.log(diff);
|
||||
});
|
||||
|
||||
tap.test('should get the diff to HEAD', async () => {
|
||||
const gitRepo = await testSmartgitInstance.createRepoByOpen(packageDir);
|
||||
const diff = await gitRepo.getUncommittedDiff([
|
||||
'pnpm-lock.yaml',
|
||||
]);
|
||||
console.log(diff);
|
||||
});
|
||||
|
||||
tap.test('should print all commit messages', async () => {
|
||||
const gitRepo = await testSmartgitInstance.createRepoByOpen(packageDir);
|
||||
const commitMessages = await gitRepo.getAllCommitMessages();
|
||||
console.log(commitMessages);
|
||||
});
|
||||
|
||||
await tap.start();
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartgit',
|
||||
version: '3.0.2',
|
||||
description: 'smart wrapper for nodegit'
|
||||
version: '3.1.1',
|
||||
description: 'A smart wrapper for nodegit that simplifies Git operations in Node.js.'
|
||||
}
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import * as plugins from './smartgit.plugins.js';
|
||||
|
||||
import { Smartgit } from './smartgit.classes.smartgit.js';
|
||||
|
||||
/**
|
||||
@@ -68,7 +67,7 @@ export class GitRepo {
|
||||
}
|
||||
|
||||
/**
|
||||
* ensures the existance of a remote within a repository
|
||||
* ensures the existence of a remote within a repository
|
||||
* @param remoteNameArg
|
||||
* @param remoteUrlArg
|
||||
*/
|
||||
@@ -110,4 +109,120 @@ export class GitRepo {
|
||||
remote: remoteName,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the diff of the current uncommitted changes while excluding specified files
|
||||
*/
|
||||
public async getUncommittedDiff(excludeFiles: string[] = []): Promise<string[]> {
|
||||
const statusMatrix = await plugins.isomorphicGit.statusMatrix({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
});
|
||||
|
||||
const diffs: string[] = [];
|
||||
for (const row of statusMatrix) {
|
||||
const [filepath, head, workdir] = row;
|
||||
if (excludeFiles.includes(filepath)) {
|
||||
continue; // Skip excluded files
|
||||
}
|
||||
|
||||
let headContent = '';
|
||||
let workdirContent = '';
|
||||
|
||||
// Handle modified files
|
||||
if (head !== 0 && workdir !== 0 && head !== workdir) {
|
||||
headContent = await plugins.isomorphicGit
|
||||
.readBlob({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
oid: await plugins.isomorphicGit.resolveRef({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
ref: 'HEAD',
|
||||
}),
|
||||
filepath,
|
||||
})
|
||||
.then((result) => new TextDecoder().decode(result.blob));
|
||||
|
||||
workdirContent = await this.smartgitRef.envDeps.fs.promises.readFile(
|
||||
plugins.path.join(this.repoDir, filepath),
|
||||
'utf8'
|
||||
);
|
||||
}
|
||||
|
||||
// Handle added files
|
||||
if (head === 0 && workdir !== 0) {
|
||||
workdirContent = await this.smartgitRef.envDeps.fs.promises.readFile(
|
||||
plugins.path.join(this.repoDir, filepath),
|
||||
'utf8'
|
||||
);
|
||||
}
|
||||
|
||||
// Handle deleted files
|
||||
if (head !== 0 && workdir === 0) {
|
||||
headContent = await plugins.isomorphicGit
|
||||
.readBlob({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
oid: await plugins.isomorphicGit.resolveRef({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
ref: 'HEAD',
|
||||
}),
|
||||
filepath,
|
||||
})
|
||||
.then((result) => new TextDecoder().decode(result.blob));
|
||||
}
|
||||
|
||||
if (headContent || workdirContent) {
|
||||
const diff = plugins.diff.createTwoFilesPatch(
|
||||
filepath,
|
||||
filepath,
|
||||
headContent,
|
||||
workdirContent
|
||||
);
|
||||
diffs.push(diff);
|
||||
}
|
||||
}
|
||||
|
||||
return diffs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all commit messages with their dates and package.json version at each commit
|
||||
*/
|
||||
public async getAllCommitMessages(): Promise<
|
||||
{ date: string; version: string; message: string }[]
|
||||
> {
|
||||
const commits = await plugins.isomorphicGit.log({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
});
|
||||
|
||||
const results = [];
|
||||
|
||||
for (const commit of commits) {
|
||||
let version = 'unknown';
|
||||
try {
|
||||
const packageJsonBlob = await plugins.isomorphicGit.readBlob({
|
||||
fs: this.smartgitRef.envDeps.fs,
|
||||
dir: this.repoDir,
|
||||
oid: commit.oid,
|
||||
filepath: 'package.json',
|
||||
});
|
||||
const packageJson = JSON.parse(new TextDecoder().decode(packageJsonBlob.blob));
|
||||
version = packageJson.version;
|
||||
} catch (error) {
|
||||
// If package.json does not exist or any error occurs, leave version as 'unknown'
|
||||
}
|
||||
|
||||
results.push({
|
||||
date: new plugins.smarttime.ExtendedDate(commit.commit.committer.timestamp * 1000).exportToHyphedSortableDate(),
|
||||
version: version,
|
||||
message: commit.commit.message,
|
||||
});
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,40 +1,90 @@
|
||||
import * as plugins from './smartgit.plugins.js';
|
||||
import { GitRepo } from './smartgit.classes.gitrepo.js';
|
||||
|
||||
interface IEnvDeps {
|
||||
fs: typeof import('fs') | null;
|
||||
http: any | null; // isomorphic-git http interface
|
||||
}
|
||||
|
||||
/**
|
||||
* class Smartgit provides a high-level interface for git operations
|
||||
* Must be initialized before use by calling init()
|
||||
*/
|
||||
export class Smartgit {
|
||||
public smartenvInstance = new plugins.smartenv.Smartenv();
|
||||
public envDeps: {
|
||||
fs: any;
|
||||
http: any;
|
||||
} = {
|
||||
public envDeps: IEnvDeps = {
|
||||
fs: null,
|
||||
http: null,
|
||||
};
|
||||
|
||||
constructor() {}
|
||||
|
||||
public async init() {
|
||||
if (this.smartenvInstance.isNode) {
|
||||
this.envDeps.fs = await this.smartenvInstance.getSafeNodeModule('fs');
|
||||
this.envDeps.http = await this.smartenvInstance.getSafeNodeModule(
|
||||
'isomorphic-git/http/node/index.js'
|
||||
);
|
||||
} else {
|
||||
throw new Error('currently only node.js is supported.');
|
||||
/**
|
||||
* initializes the Smartgit instance with required environment dependencies
|
||||
* Must be called before using any repository methods
|
||||
*/
|
||||
public async init(): Promise<void> {
|
||||
try {
|
||||
if (this.smartenvInstance.isNode) {
|
||||
this.envDeps.fs = await this.smartenvInstance.getSafeNodeModule('fs');
|
||||
this.envDeps.http = await this.smartenvInstance.getSafeNodeModule(
|
||||
'isomorphic-git/http/node'
|
||||
);
|
||||
} else {
|
||||
throw new Error('currently only node.js is supported.');
|
||||
}
|
||||
} catch (error) {
|
||||
throw new Error(`Failed to initialize Smartgit: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
|
||||
public async createRepoByClone(fromUrlArg: string, toDirArg: string) {
|
||||
const repo = await GitRepo.fromCloningIntoDir(this, fromUrlArg, toDirArg);
|
||||
private ensureInitialized(): void {
|
||||
if (!this.envDeps.fs || !this.envDeps.http) {
|
||||
throw new Error('Smartgit must be initialized before use. Call init() first.');
|
||||
}
|
||||
}
|
||||
|
||||
public async createRepoByInit(dirArg: string) {
|
||||
const repo = await GitRepo.fromCreatingRepoInDir(this, dirArg);
|
||||
return repo;
|
||||
/**
|
||||
* creates a new GitRepo instance by cloning from a remote URL
|
||||
* @param fromUrlArg the URL to clone from
|
||||
* @param toDirArg the directory to clone into
|
||||
* @returns Promise<GitRepo> the created repository instance
|
||||
*/
|
||||
public async createRepoByClone(fromUrlArg: string, toDirArg: string): Promise<GitRepo> {
|
||||
this.ensureInitialized();
|
||||
try {
|
||||
const repo = await GitRepo.fromCloningIntoDir(this, fromUrlArg, toDirArg);
|
||||
return repo;
|
||||
} catch (error) {
|
||||
throw new Error(`Failed to clone repository: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
|
||||
public async createRepoByOpen(dirArg: string) {
|
||||
const repo = await GitRepo.fromOpeningRepoDir(this, dirArg);
|
||||
return repo;
|
||||
/**
|
||||
* creates a new GitRepo instance by initializing a new repository in a directory
|
||||
* @param dirArg the directory to initialize the repository in
|
||||
* @returns Promise<GitRepo> the created repository instance
|
||||
*/
|
||||
public async createRepoByInit(dirArg: string): Promise<GitRepo> {
|
||||
this.ensureInitialized();
|
||||
try {
|
||||
const repo = await GitRepo.fromCreatingRepoInDir(this, dirArg);
|
||||
return repo;
|
||||
} catch (error) {
|
||||
throw new Error(`Failed to initialize repository: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* creates a new GitRepo instance by opening an existing repository in a directory
|
||||
* @param dirArg the directory containing the existing repository
|
||||
* @returns Promise<GitRepo> the opened repository instance
|
||||
*/
|
||||
public async createRepoByOpen(dirArg: string): Promise<GitRepo> {
|
||||
this.ensureInitialized();
|
||||
try {
|
||||
const repo = await GitRepo.fromOpeningRepoDir(this, dirArg);
|
||||
return repo;
|
||||
} catch (error) {
|
||||
throw new Error(`Failed to open repository: ${error instanceof Error ? error.message : String(error)}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,10 +8,12 @@ import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
import * as smartstring from '@push.rocks/smartstring';
|
||||
import * as smarttime from '@push.rocks/smarttime';
|
||||
|
||||
export { smartenv, smartfile, smartpath, smartpromise, smartstring };
|
||||
export { smartenv, smartfile, smartpath, smartpromise, smartstring, smarttime };
|
||||
|
||||
// third party
|
||||
import * as diff from 'diff';
|
||||
import isomorphicGit from 'isomorphic-git';
|
||||
|
||||
export { isomorphicGit };
|
||||
export { diff, isomorphicGit };
|
||||
|
||||
@@ -3,9 +3,12 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true,
|
||||
}
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user