Skip to content

Support non-tag/head refs #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support non-tag/head refs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d60a00
Support non-tag/head refs
MggMuggins Feb 10, 2025
18924b4
Fix detached HEAD
MggMuggins Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/git_mappers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,13 @@ const mapTagToStatements = createRefMapper({
margin: 0.2,
});

const mapRefsToStatements = createRefMapper({
refBasePath: "refs/",
shape: "cds",
fillColor: "orange",
margin: 0.1,
});

module.exports = {
mapLineToObject,
mapLineToRef,
Expand All @@ -170,6 +177,7 @@ module.exports = {
mapAnnotatedTag,
mapHeadToStatements,
mapTagToStatements,
mapRefsToStatements,
mapTreeToStatements,
mapCommitToStatements,
mapBlobToStatement,
Expand Down
26 changes: 17 additions & 9 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ const { flattenDepth, zipWith, compact } = require("lodash/array");
const { exec } = require("./utility");
const { splitLines, splitByWhitespace } = require("./string_utils");
const { isEmpty } = require("lodash/lang");
const { map, filter } = require("lodash/collection");
const { map, filter, some } = require("lodash/collection");
const { stmtList, digraph } = require("./dot_builders");
const {
mapRawCommit,
Expand All @@ -17,6 +17,7 @@ const {
mapHeadToStatements,
mapAnnotatedTagsToStatements,
mapTagToStatements,
mapRefsToStatements,
} = require("./git_mappers");

// strip off node executable and script path
Expand Down Expand Up @@ -46,8 +47,7 @@ const git = `git --git-dir=${gitDir}`;
const noBlobs = opts.includes("--no-blobs");
const noTrees = opts.includes("--no-trees");

const showHeads = () => exec(`${git} show-ref --heads`);
const showTags = () => exec(`${git} show-ref --tags`);
const showRefs = () => exec(`${git} show-ref`);
const catAllObjects = () => exec(`${git} cat-file --batch-check --batch-all-objects`);
const catFile = hash => exec(`${git} cat-file -p ${hash}`);
const catObject = gitObject => catFile(getHash(gitObject));
Expand Down Expand Up @@ -94,12 +94,19 @@ async function main() {
);

// git HEAD could be detached, referring directly to a commit, not another ref
const rawHEAD = fs.readFileSync(`${gitDir}/HEAD`).toString();
const rawHEAD = fs.readFileSync(`${gitDir}/HEAD`).toString().trim();
const HEAD = rawHEAD.startsWith("ref:") ? splitByWhitespace(rawHEAD)[1] : rawHEAD;

// there may be no tags at all and a repo with no commits will have a floating main branch
const tagData = map(compact(splitLines(await showTags().catch(() => ""))), mapLineToRef);
const headData = map(compact(splitLines(await showHeads().catch(() => ""))), mapLineToRef);
// perfectly alright to have no refs at all (empty repo)
const refData = map(compact(splitLines(await showRefs().catch(() => ""))), mapLineToRef);

// Only draw HEAD if it points to a ref or commit that exists
const refsAndCommits = refData.concat(commitData);
const validHead = some(refsAndCommits, (obj) => HEAD === obj.name || HEAD === obj.hash);

const tagData = filter(refData, (ref) => ref.name.includes("/tags/"));
const headData = filter(refData, (ref) => ref.name.includes("/heads/"));
const miscRefData = filter(refData, (ref) => !ref.name.includes("/tags/") && !ref.name.includes("/heads/"));

/**
* TODO think more about what the command line options do,
Expand All @@ -111,9 +118,10 @@ async function main() {
map(commitData, data => mapCommitToStatements(data, noTrees)),
!noTrees && map(treeData, data => mapTreeToStatements(data, noBlobs)),
map(headData, mapHeadToStatements),
mapHeadToStatements({ hash: HEAD, name: "HEAD" }),
map(annotatedTagData, mapAnnotatedTagsToStatements),
map(tagData, mapTagToStatements),
map(miscRefData, mapRefsToStatements),
validHead && mapHeadToStatements({ hash: HEAD, name: "HEAD" }),
map(annotatedTagData, mapAnnotatedTagsToStatements),
];

const statements = flattenDepth(compact(statementsByType), 2);
Expand Down