From c9c7b71cedda8ead2ed44e6c55f7f66bc895ab69 Mon Sep 17 00:00:00 2001 From: Thomas Plumpton Date: Mon, 24 Mar 2025 18:26:25 +0000 Subject: [PATCH 1/3] chore(table): extracted table container component --- .../src/modules/Table/Table.module.scss | 27 +++----- packages/library/src/modules/Table/Table.tsx | 62 +++--------------- .../TableContainer/TableContainer.module.scss | 4 ++ .../TableContainer/TableContainer.tsx | 63 +++++++++++++++++++ .../Table/components/TableContainer/index.ts | 2 + .../Table/components/TableContainer/types.ts | 3 + 6 files changed, 87 insertions(+), 74 deletions(-) create mode 100644 packages/library/src/modules/Table/components/TableContainer/TableContainer.module.scss create mode 100644 packages/library/src/modules/Table/components/TableContainer/TableContainer.tsx create mode 100644 packages/library/src/modules/Table/components/TableContainer/index.ts create mode 100644 packages/library/src/modules/Table/components/TableContainer/types.ts diff --git a/packages/library/src/modules/Table/Table.module.scss b/packages/library/src/modules/Table/Table.module.scss index 77fe25bb..98074563 100644 --- a/packages/library/src/modules/Table/Table.module.scss +++ b/packages/library/src/modules/Table/Table.module.scss @@ -1,22 +1,11 @@ -.table { - display: grid; - grid-template-columns: minmax(350px, 4fr) minmax(100px, 1fr) 195px; +.head { + display: contents; +} - .row { - display: contents; - } +.header:first-child { + padding-left: 20px; +} - .header:first-child { - padding-left: 20px; - } - - .header { - font-weight: 600; - } - - >.thead >.tr >.th { - text-align: left; - padding-bottom: 22px; - box-sizing: border-box; - } +.header { + font-weight: 600; } \ No newline at end of file diff --git a/packages/library/src/modules/Table/Table.tsx b/packages/library/src/modules/Table/Table.tsx index f794aedf..6bcf87cd 100644 --- a/packages/library/src/modules/Table/Table.tsx +++ b/packages/library/src/modules/Table/Table.tsx @@ -1,5 +1,4 @@ import styles from './Table.module.scss' -import classNames from 'classnames' import dayjs from 'dayjs' import { useMemo } from 'react' import { Commit } from 'types' @@ -9,9 +8,7 @@ import relativeTime from 'dayjs/plugin/relativeTime' import { useGitContext } from 'context/GitContext' import { usePlaceholderData } from 'modules/Graph/hooks/usePlaceholderData' import { TableRow } from 'modules/Table/components/TableRow' -import { ROW_HEIGHT } from 'constants/constants' -import { HEADER_ROW_HEIGHT, TABLE_MARGIN_TOP } from 'modules/Table/types' -import { placeholderCommits } from 'modules/Graph/hooks/usePlaceholderData/data' +import { TableContainer } from 'modules/Table/components/TableContainer' dayjs.extend(advancedFormat) dayjs.extend(relativeTime) @@ -24,13 +21,12 @@ export const Table = () => { classes, graphData, paging, - rowSpacing, indexCommit } = useGitContext() const { placeholderData } = usePlaceholderData() - const logData = useMemo(() => { + const tableData = useMemo(() => { const data = graphData.commits.slice(paging.startIndex, paging.endIndex) if (paging.isIndexVisible) { @@ -40,56 +36,12 @@ export const Table = () => { return data }, [graphData.commits, indexCommit, paging.endIndex, paging.isIndexVisible, paging.startIndex]) - const gridTemplateRows = useMemo(() => { - // If no commits are visible as we're showing - // the placeholder data for the skeleton view, - // then use that size, else just use the log data length. - const commitsVisible = logData.length > 0 - ? logData.length - : placeholderCommits.length - - // If the table headers are turned off, then we simply - // repeat the same row height for all rows. - if (!showTableHeaders) { - return `repeat(${commitsVisible}, ${ROW_HEIGHT}px)` - } - - // With no row spacing, the header row height lines - // up with the first data row fine. But when the row - // spacing is increased, we must subtract half of it - // from the height of the first header row to counteract - // the gap between the header and the first data row. - const headerRowHeight = HEADER_ROW_HEIGHT - (rowSpacing / 2) - - // All other rows (with data) get a fixed height. - const remainingRowsHeight = `repeat(${commitsVisible}, ${ROW_HEIGHT}px)` - - return `${headerRowHeight}px ${remainingRowsHeight}` - }, [logData.length, rowSpacing, showTableHeaders]) - - const marginTop = useMemo(() => { - if (showTableHeaders) { - return TABLE_MARGIN_TOP - } - - return (rowSpacing / 2) + TABLE_MARGIN_TOP - }, [rowSpacing, showTableHeaders]) return ( -
+ {showTableHeaders && (
{
)} - {logData.length == 0 && placeholderData.map(({ commit }, i) => ( + {tableData.length == 0 && placeholderData.map(({ commit }, i) => ( { /> ))} - {logData.map((commit, i) => ( + {tableData.map((commit, i) => ( { data-testid={`react-git-log-table-row-${i}`} /> ))} -
+ ) } \ No newline at end of file diff --git a/packages/library/src/modules/Table/components/TableContainer/TableContainer.module.scss b/packages/library/src/modules/Table/components/TableContainer/TableContainer.module.scss new file mode 100644 index 00000000..21716e51 --- /dev/null +++ b/packages/library/src/modules/Table/components/TableContainer/TableContainer.module.scss @@ -0,0 +1,4 @@ +.tableContainer { + display: grid; + grid-template-columns: minmax(350px, 4fr) minmax(100px, 1fr) 195px; +} \ No newline at end of file diff --git a/packages/library/src/modules/Table/components/TableContainer/TableContainer.tsx b/packages/library/src/modules/Table/components/TableContainer/TableContainer.tsx new file mode 100644 index 00000000..0a7c19bb --- /dev/null +++ b/packages/library/src/modules/Table/components/TableContainer/TableContainer.tsx @@ -0,0 +1,63 @@ +import classNames from 'classnames' +import styles from './TableContainer.module.scss' +import { PropsWithChildren, useMemo } from 'react' +import { useGitContext } from 'context/GitContext' +import { placeholderCommits } from 'modules/Graph/hooks/usePlaceholderData/data' +import { ROW_HEIGHT } from 'constants/constants' +import { HEADER_ROW_HEIGHT, TABLE_MARGIN_TOP } from 'modules/Table' +import { TableContainerProps } from 'modules/Table/components/TableContainer/types' + +export const TableContainer = ({ rowQuantity, children }: PropsWithChildren) => { + const { classes, rowSpacing, showTableHeaders } = useGitContext() + + const gridTemplateRows = useMemo(() => { + // If no commits are visible as we're showing + // the placeholder data for the skeleton view, + // then use that size, else just use the log data length. + const commitsVisible = rowQuantity > 0 + ? rowQuantity + : placeholderCommits.length + + // If the table headers are turned off, then we simply + // repeat the same row height for all rows. + if (!showTableHeaders) { + return `repeat(${commitsVisible}, ${ROW_HEIGHT}px)` + } + + // With no row spacing, the header row height lines + // up with the first data row fine. But when the row + // spacing is increased, we must subtract half of it + // from the height of the first header row to counteract + // the gap between the header and the first data row. + const headerRowHeight = HEADER_ROW_HEIGHT - (rowSpacing / 2) + + // All other rows (with data) get a fixed height. + const remainingRowsHeight = `repeat(${commitsVisible}, ${ROW_HEIGHT}px)` + + return `${headerRowHeight}px ${remainingRowsHeight}` + }, [rowQuantity, rowSpacing, showTableHeaders]) + + const marginTop = useMemo(() => { + if (showTableHeaders) { + return TABLE_MARGIN_TOP + } + + return (rowSpacing / 2) + TABLE_MARGIN_TOP + }, [rowSpacing, showTableHeaders]) + + return ( +
+ {children} +
+ ) +} \ No newline at end of file diff --git a/packages/library/src/modules/Table/components/TableContainer/index.ts b/packages/library/src/modules/Table/components/TableContainer/index.ts new file mode 100644 index 00000000..1dfebca6 --- /dev/null +++ b/packages/library/src/modules/Table/components/TableContainer/index.ts @@ -0,0 +1,2 @@ +export * from './types' +export * from './TableContainer' \ No newline at end of file diff --git a/packages/library/src/modules/Table/components/TableContainer/types.ts b/packages/library/src/modules/Table/components/TableContainer/types.ts new file mode 100644 index 00000000..a9b593f7 --- /dev/null +++ b/packages/library/src/modules/Table/components/TableContainer/types.ts @@ -0,0 +1,3 @@ +export interface TableContainerProps { + rowQuantity: number; +} \ No newline at end of file From 7697cb283954013635bcb8fccf7afeeb98ff7dee Mon Sep 17 00:00:00 2001 From: Thomas Plumpton Date: Mon, 24 Mar 2025 18:32:13 +0000 Subject: [PATCH 2/3] chore(config): added apache 2.0 license inside library directory for publishing --- README.md | 4 +- packages/library/LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 202 insertions(+), 3 deletions(-) create mode 100644 packages/library/LICENSE diff --git a/README.md b/README.md index ac4b8b22..cc9f7f7b 100644 --- a/README.md +++ b/README.md @@ -183,6 +183,4 @@ This will write `git-log.txt` in the directory where you ran the command. It can - Should we split the component in 3 sub-components with a wrapper, like `GitLog` and `GitLog.Graph` etc.? - Fix React docgen in Storybook controls as its not showing the JSDoc from the interface props - Extract ThemeContext -- Mobile responsiveness for the demo site -- Add min width to commit message grid column -- Add author to table \ No newline at end of file +- Mobile responsiveness for the demo site \ No newline at end of file diff --git a/packages/library/LICENSE b/packages/library/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/packages/library/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 6748b63f4ca6071d923c0f1972c405780dd28740 Mon Sep 17 00:00:00 2001 From: Thomas Plumpton Date: Mon, 24 Mar 2025 19:47:52 +0000 Subject: [PATCH 3/3] fix(config): improved typescript and build config to include only relevant ts declarations in dist --- .run/library _ release_local.run.xml | 12 ++++++++++++ packages/library/package.json | 15 +++++++++++---- packages/library/src/index.ts | 5 ++--- packages/library/src/types.ts | 2 +- packages/library/src/types/svg.d.ts | 5 +++++ packages/library/tsconfig.build.json | 22 ++++++++++++++++++++++ packages/library/tsconfig.json | 3 +-- packages/library/vite.config.ts | 4 +++- 8 files changed, 57 insertions(+), 11 deletions(-) create mode 100644 .run/library _ release_local.run.xml create mode 100644 packages/library/src/types/svg.d.ts create mode 100644 packages/library/tsconfig.build.json diff --git a/.run/library _ release_local.run.xml b/.run/library _ release_local.run.xml new file mode 100644 index 00000000..d203627c --- /dev/null +++ b/.run/library _ release_local.run.xml @@ -0,0 +1,12 @@ + + + + + +