From b63e70f7f31d89f8cf03dc30250aaf0088efcaa0 Mon Sep 17 00:00:00 2001 From: Thomas Plumpton Date: Sat, 28 Jun 2025 11:33:12 +0100 Subject: [PATCH 1/4] chore(docs): cleaned-up roadmap and split bugs section --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index afc55db..c93b180 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ A flexible and interactive React component for visualising Git commit history. D * [Development](#development) * [References](#references) * [Roadmap](#roadmap) +* [Known Bugs](#known-bugs) # Features @@ -474,21 +475,26 @@ The following properties are injected into the functions `props` argument: - And Iain Ballard for his experimental GUI [SnivellingGit](https://github.com/i-e-b/SnivellingGit/tree/master) # Roadmap + +Storybook Demo - Show code in stories -- Expose custom theme object off the Theme type -- Can Zustand help us here to reduce re-renders with GitContext Provider? -- Expose component override props for things like CommitNode, CommitMessage etc. -- Straight line prop to turn curves into right angles? -- Line curve radius prop? -- Fix React docgen in Storybook controls as its not showing the JSDoc from the interface props -- Mobile responsiveness for the demo site +- Fix React docgen in Storybook controls as it's not showing the JSDoc from the interface props +- Mobile responsiveness + +Graphs +- Straight line prop to turn curves into right angles +- Line curve radius prop - Tags should be independent. Add a new optional field to the log entry / commit objects. - Branch / Tags column is fixed. Dynamically floor it to match the max tag size currently being rendered? +- Support filtering so that the graph skips nodes Canvas2D -- Fade out of line at bottom -- Tooltips? +- Custom prop for BG colour because of how canvas alpha channel works +- Tooltip support - Row spacing support -- First col background cut off by canvas -- Branch/tag lines to lining up with nodes. -- Selected node BG colour still isn't right. \ No newline at end of file + +# Known Bugs +- The `GraphCanvas2D` component has the preview/select background cut off by canvases left-edge. +- The `GraphCanvas2D` component does not set the correct selected node BG colour, it's slightly off from the table row. +- The `GraphHTMLGrid` component renders the node-edge gradient to last node, but should be solid. +- The `GraphHTMLGrid` component is missing node edges from some commit nodes that are present in the canvas variant. \ No newline at end of file From 68386405b405eb8798c9f79081df1f7b2293bd55 Mon Sep 17 00:00:00 2001 From: Thomas Plumpton Date: Sat, 28 Jun 2025 12:08:46 +0100 Subject: [PATCH 2/4] chore(docs): added typedoc and fixed various typing issues --- .gitignore | 4 +- .run/library _ docs.run.xml | 12 + package-lock.json | 218 +++++++++++++++++- packages/library/package.json | 5 +- packages/library/src/hooks/useTheme/types.ts | 2 +- packages/library/src/index.ts | 1 + packages/library/src/modules/Graph/index.ts | 6 +- .../HorizontalLine/HorizontalLine.spec.tsx | 2 + packages/library/src/modules/Graph/types.ts | 6 +- packages/library/src/types.ts | 6 +- packages/library/typedoc.json | 15 ++ 11 files changed, 259 insertions(+), 18 deletions(-) create mode 100644 .run/library _ docs.run.xml create mode 100644 packages/library/typedoc.json diff --git a/.gitignore b/.gitignore index 1737f26..6e2495d 100644 --- a/.gitignore +++ b/.gitignore @@ -26,5 +26,5 @@ packages/library/tomplum-react-git-log-* *storybook.log packages/demo/storybook-static - -packages/library/coverage \ No newline at end of file +packages/library/coverage +packages/library/docs \ No newline at end of file diff --git a/.run/library _ docs.run.xml b/.run/library _ docs.run.xml new file mode 100644 index 0000000..87ce62d --- /dev/null +++ b/.run/library _ docs.run.xml @@ -0,0 +1,12 @@ + + + + + +