Skip to content
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

Fix 2372: Add commit to Github sidebar #2376

Merged
merged 1 commit into from
Oct 25, 2021
Merged

Fix 2372: Add commit to Github sidebar #2376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 76 additions & 0 deletions src/web/src/components/Posts/Commits.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import { VscGitCommit } from 'react-icons/vsc';
import { createStyles, makeStyles, Theme } from '@material-ui/core';

const useStyles = makeStyles((theme: Theme) =>
createStyles({
link: {
textDecoration: 'none',
color: theme.palette.text.primary,
'&:hover': {
textDecorationLine: 'underline',
},
},
GitHubInfo: {
lineHeight: 'normal',
fontSize: '1.2rem',
},
GitHubLinkTitle: {
fontSize: '1.4rem',
margin: 0,
paddingTop: '1rem',
},
icon: {
fontSize: '2rem',
marginRight: '1rem',
verticalAlign: 'text-bottom',
},
commits: {
paddingLeft: 0,
display: 'flex',
Andrewnt219 marked this conversation as resolved.
Show resolved Hide resolved
flexWrap: 'wrap',
gap: '1.5rem',
},
commit: {
listStyle: 'none',
},
})
);

const SHORT_SHA_LENGTH = 7;

const getCommitNumber = (url: string, length?: number) =>
url.replace(/.+\/(commit|commits)\/(\w{40}).*/, '$2').substr(0, length);

type Props = {
commitUrls: string[];
};

const Commits = ({ commitUrls }: Props) => {
const classes = useStyles();

return (
<div className={classes.GitHubInfo}>
<h2 className={classes.GitHubLinkTitle}>
<VscGitCommit className={classes.icon}></VscGitCommit>
{commitUrls.length === 1 ? 'Commit' : 'Commits'}
</h2>
<ul className={classes.commits}>
{commitUrls.map((url) => (
<li key={url} className={classes.commit}>
<a
href={`https://github.com${url}`}
rel="bookmark"
target="_blank"
title={'Commit ' + getCommitNumber(url)}
className={classes.link}
>
{getCommitNumber(url, SHORT_SHA_LENGTH)}
</a>
</li>
))}
</ul>
</div>
);
};

export default Commits;
9 changes: 6 additions & 3 deletions src/web/src/components/Posts/GitHubInfo.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { createStyles, makeStyles, Theme, ListSubheader } from '@material-ui/cor
import Repos from './Repos';
import Issues from './Issues';
import PullRequests from './PullRequests';
import Commits from './Commits';

const useStyles = makeStyles((theme: Theme) =>
createStyles({
Expand Down Expand Up @@ -37,11 +38,12 @@ const filterGitHubUrls = (urls: string[]) => {
const { pathname } = url;

// Match urls that start with /<user>/<repo>, and optionally end with /<anything-in-between>/<type>/<id>
// <id> can be number, or a mixed of 40 alphanumeric (commit id)
// Ex: /Seneca-CDOT/telescope/pull/2367 ✅
// Ex: /Seneca-CDOT/telescope ✅
// Ex: /Seneca-CDOT/telescope/pull/2367/commits/d3fag ✅
// Ex: /Seneca-CDOT/telescope/pull/2367/commits/d3fagd3fagd3fagd3fagd3fagd3fag4d41265748 ✅
// Ex: /Seneca-CDOT/telescope/issues ✅
const matches = /^\/(?<user>[^\/]+)\/(?<repo>[^\/]+)((\/(.*))?\/(?<type>[^\/]+)\/(?<id>(\d+))\/?$)?/i.exec(
const matches = /^\/(?<user>[^\/]+)\/(?<repo>[^\/]+)((\/(.*))?\/(?<type>[^\/]+)\/(?<id>(\d+|\w{40}))\/?$)?/i.exec(
pathname
);
if (matches?.groups === undefined) {
Expand Down Expand Up @@ -92,14 +94,15 @@ const parseGitHubUrl = (url: string): URL | null => {

const GitHubInfo = ({ ghUrls }: Props) => {
const classes = useStyles();
const { repos, issues, pullRequests } = filterGitHubUrls(ghUrls);
const { repos, issues, pullRequests, commits } = filterGitHubUrls(ghUrls);

return (
<ListSubheader className={classes.root}>
<div className={classes.GitHubInfoContainer}>
{!!repos.length && <Repos repoUrls={repos} />}
{!!issues.length && <Issues issueUrls={issues} />}
{!!pullRequests.length && <PullRequests prUrls={pullRequests} />}
{!!commits.length && <Commits commitUrls={commits} />}
</div>
</ListSubheader>
);
Expand Down
16 changes: 9 additions & 7 deletions src/web/src/components/Posts/Issues.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const useStyles = makeStyles((theme: Theme) =>
},
},
GitHubInfo: {
lineHeight: '2rem',
lineHeight: 'normal',
fontSize: '1.2rem',
},
GitHubLinkTitle: {
Expand All @@ -25,11 +25,13 @@ const useStyles = makeStyles((theme: Theme) =>
verticalAlign: 'text-bottom',
},
issues: {
paddingLeft: 0,
display: 'flex',
margin: 0,
flexWrap: 'wrap',
gap: '1.5rem',
},
issue: {
marginRight: '2rem',
listStyle: 'none',
},
})
);
Expand All @@ -49,9 +51,9 @@ const Issues = ({ issueUrls }: Props) => {
<VscIssues className={classes.icon}></VscIssues>
{issueUrls.length === 1 ? 'Issue' : 'Issues'}
</h2>
<p className={classes.issues}>
<ul className={classes.issues}>
{issueUrls.map((issue) => (
<p key={issue} className={classes.issue}>
<li key={issue} className={classes.issue}>
<a
href={`https://github.com${issue}`}
rel="bookmark"
Expand All @@ -61,9 +63,9 @@ const Issues = ({ issueUrls }: Props) => {
>
#{getIssueNumber(issue)}
</a>
</p>
</li>
))}
</p>
</ul>
</div>
);
};
Expand Down
16 changes: 9 additions & 7 deletions src/web/src/components/Posts/PullRequests.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const useStyles = makeStyles((theme: Theme) =>
},
},
GitHubInfo: {
lineHeight: '2rem',
lineHeight: 'normal',
fontSize: '1.2rem',
},
GitHubLinkTitle: {
Expand All @@ -25,11 +25,13 @@ const useStyles = makeStyles((theme: Theme) =>
verticalAlign: 'text-bottom',
},
pullRequests: {
paddingLeft: 0,
display: 'flex',
margin: 0,
flexWrap: 'wrap',
gap: '1.5rem',
},
pullRequest: {
marginRight: '2rem',
listStyle: 'none',
},
})
);
Expand All @@ -50,9 +52,9 @@ const PullRequests = ({ prUrls }: Props) => {
<VscGitPullRequest className={classes.icon}></VscGitPullRequest>
{prUrls.length === 1 ? 'Pull Request' : 'Pull Requests'}
</h2>
<p className={classes.pullRequests}>
<ul className={classes.pullRequests}>
{prUrls.map((pullRequest) => (
<p key={pullRequest} className={classes.pullRequest}>
<li key={pullRequest} className={classes.pullRequest}>
<a
href={`https://github.com${pullRequest}`}
rel="bookmark"
Expand All @@ -62,9 +64,9 @@ const PullRequests = ({ prUrls }: Props) => {
>
#{getPullRequestNumber(pullRequest)}
</a>
</p>
</li>
))}
</p>
</ul>
</div>
);
};
Expand Down
39 changes: 23 additions & 16 deletions src/web/src/components/Posts/Repos.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ const useStyles = makeStyles((theme: Theme) =>
},
},
GitHubInfo: {
lineHeight: '2rem',
fontSize: '1.2rem',
wordWrap: 'break-word',
lineHeight: 'normal',
},
GitHubLinkTitle: {
fontSize: '1.4rem',
Expand All @@ -25,9 +25,14 @@ const useStyles = makeStyles((theme: Theme) =>
marginRight: '1rem',
verticalAlign: 'text-bottom',
},
repos: {
paddingLeft: 0,
display: 'flex',
flexDirection: 'column',
gap: '1.5rem',
},
repo: {
marginTop: '2rem',
lineHeight: '0.5rem',
listStyle: 'none',
},
})
);
Expand All @@ -47,19 +52,21 @@ const Repos = ({ repoUrls }: Props) => {
<VscRepoForked className={classes.icon}></VscRepoForked>
{repoUrls.length === 1 ? 'Repo' : 'Repos'}
</h2>
{repoUrls.map((repo) => (
<p key={repo} className={classes.repo}>
<a
href={`https://github.com/${repo}`}
rel="bookmark"
target="_blank"
title={repo}
className={classes.link}
>
{getRepoName(repo)}
</a>
</p>
))}
<ul className={classes.repos}>
{repoUrls.map((repo) => (
<li key={repo} className={classes.repo}>
<a
href={`https://github.com/${repo}`}
rel="bookmark"
target="_blank"
title={repo}
className={classes.link}
>
{getRepoName(repo)}
</a>
</li>
))}
</ul>
</div>
);
};
Expand Down