CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-commitizen

Command-line utility for creating standardized Git commit messages through interactive prompts and adapter system.

Pending

Quality

Pending

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Pending

The risk profile of this skill

Overview
Eval results
Files

staging.mddocs/

Staging Utilities

Git staging area validation and management utilities for commitizen operations.

Capabilities

Staging Area Validation

Checks if the git staging area is clean (has no staged changes).

/**
 * Asynchrounously determines if the staging area is clean
 * @param repoPath - Path to the git repository
 * @param done - Callback function receiving (error, isClean)
 * @param stageAllFiles - Optional flag to check both staged and working directory changes
 */
function isClean(repoPath: string, done: Function, stageAllFiles?: boolean): void;

Usage Examples:

import { staging } from 'commitizen';

// Check if staging area is clean
staging.isClean(process.cwd(), (error, clean) => {
  if (error) {
    console.error('Error checking staging area:', error);
    return;
  }
  
  if (clean) {
    console.log('No staged changes found');
  } else {
    console.log('Staged changes detected');
  }
});

// Check both staged and working directory changes
staging.isClean(process.cwd(), (error, clean) => {
  if (error) {
    console.error('Error checking repository:', error);
    return;
  }
  
  if (clean) {
    console.log('Repository is completely clean');
  } else {
    console.log('Changes detected in staging area or working directory');
  }
}, true);

Types

// Callback signature for isClean function
type StagingCallback = (error: Error | null, isClean: boolean) => void;

docs

adapter.md

cache.md

cli.md

commit.md

config.md

git.md

index.md

init.md

staging.md

tile.json