35 |
36 | ### Configure Notifications
37 |
38 | 
39 |
40 | ### Options Page
41 |
42 | 
43 |
44 | ## How to add a new notification event?
45 |
46 | Please refer to `src/lib/api` for examples.
47 |
48 | Contribution welcomed! You could create a PR to add a new event type to get notifications from.
49 |
50 | ## Buy me a coffee ☕️
51 |
52 | 53 | If you like this extension, consider buying me a coffee. Your support 54 | will help me to continue maintaining this extension for free. 55 |
56 | 61 |
66 |
67 |
--------------------------------------------------------------------------------
/src/lib/services-github/issues.ts:
--------------------------------------------------------------------------------
1 | import { getOctokit } from '../octokit';
2 |
3 | export async function fetchNIssues(
4 | repoFullName: string,
5 | since?: string, // in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
6 | n: number = 20,
7 | sort: 'updated' | 'created' | 'comments' = 'updated'
8 | ) {
9 | const octokit = await getOctokit();
10 | const { data } = await octokit.request('GET /repos/{owner}/{repo}/issues', {
11 | owner: repoFullName.split('/')[0],
12 | repo: repoFullName.split('/')[1],
13 | // state: 'open',
14 | since,
15 | sort,
16 | page: 1,
17 | per_page: n,
18 | });
19 | return data;
20 | }
21 |
22 | export async function fetchIssueDetails(repoFullName: string, issueNumber: number) {
23 | const octokit = await getOctokit();
24 | const { data } = await octokit.request('GET /repos/{owner}/{repo}/issues/{issue_number}', {
25 | owner: repoFullName.split('/')[0],
26 | repo: repoFullName.split('/')[1],
27 | issue_number: issueNumber,
28 | });
29 | return data;
30 | }
31 |
32 | export async function fetchCommentById(repoFullName: string, commentId: number) {
33 | const octokit = await getOctokit();
34 | const { data } = await octokit.request('GET /repos/{owner}/{repo}/issues/comments/{comment_id}', {
35 | owner: repoFullName.split('/')[0],
36 | repo: repoFullName.split('/')[1],
37 | comment_id: commentId,
38 | });
39 | return data;
40 | }
41 |
42 | // fetchNIssueComments
43 | export async function fetchNIssueComments(
44 | repoFullName: string,
45 | since?: string, // in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
46 | n: number = 40
47 | ) {
48 | const octokit = await getOctokit();
49 | const { data } = await octokit.request('GET /repos/{owner}/{repo}/issues/comments', {
50 | owner: repoFullName.split('/')[0],
51 | repo: repoFullName.split('/')[1],
52 | // updated since
53 | since,
54 | direction: 'desc',
55 | sort: 'updated',
56 | page: 1,
57 | per_page: n,
58 | });
59 | return data;
60 | }
61 |
62 | /**
63 | * Get labels by repo full_name
64 | */
65 | export async function fetchLabels(repoFullName: string) {
66 | const octokit = await getOctokit();
67 | const { data: page1 } = await octokit.request('GET /repos/{owner}/{repo}/labels', {
68 | owner: repoFullName.split('/')[0],
69 | repo: repoFullName.split('/')[1],
70 | per_page: 100,
71 | page: 1,
72 | });
73 | const { data: page2 } = await octokit.request('GET /repos/{owner}/{repo}/labels', {
74 | owner: repoFullName.split('/')[0],
75 | repo: repoFullName.split('/')[1],
76 | per_page: 100,
77 | page: 2,
78 | });
79 | return [...page1, ...page2];
80 | }
81 |
--------------------------------------------------------------------------------
/src/entrypoints/popup/App.tsx:
--------------------------------------------------------------------------------
1 | import { useEffect, useState } from 'react';
2 | import Alert from '@mui/material/Alert';
3 | import Tabs from '@mui/material/Tabs';
4 | import Tab from '@mui/material/Tab';
5 | import Link from '@mui/material/Link';
6 | import Box from '@mui/material/Box';
7 |
8 | import './App.css';
9 | import useOptionsState from '@/src/lib/hooks/useOptionsState';
10 | import Updates from './components/Updates';
11 | import Settings from './components/Settings';
12 | import { startPollData } from '@/src/lib/api';
13 |
14 | interface TabPanelProps {
15 | children?: React.ReactNode;
16 | index: number;
17 | value: number;
18 | }
19 |
20 | function CustomTabPanel(props: TabPanelProps) {
21 | const { children, value, index, ...other } = props;
22 |
23 | return (
24 |
31 | {value === index && {children} }
32 |
33 | );
34 | }
35 |
36 | function a11yProps(index: number) {
37 | return {
38 | id: `simple-tab-${index}`,
39 | 'aria-controls': `simple-tabpanel-${index}`,
40 | };
41 | }
42 |
43 | function App() {
44 | const [options] = useOptionsState();
45 | const [tabIdx, setTabIdx] = useState(0);
46 |
47 | const handleTabChange = (event: React.SyntheticEvent, newValue: number) => {
48 | setTabIdx(newValue);
49 | };
50 |
51 | useEffect(() => {
52 | // a fallback if sometimes background does not wake up, start polling data when user open popup
53 | startPollData();
54 | }, []);
55 |
56 | return (
57 | <>
58 | {options.token ? null : (
59 |
9 |
10 |
64 |
65 |
66 | 67 |
68 |
88 |
89 |
90 | 91 |
92 |
125 |
126 |
127 | 128 |
129 |
140 |
141 |
142 |
143 |
144 | 145 |
158 | );
159 | }
160 |
161 | export default App;
162 |
--------------------------------------------------------------------------------
/src/entrypoints/popup/components/Updates.tsx:
--------------------------------------------------------------------------------
1 | import Button from '@mui/material/Button';
2 | import Box from '@mui/material/Box';
3 | import Chip from '@mui/material/Chip';
4 | import Tooltip from '@mui/material/Tooltip';
5 | import Typography from '@mui/material/Typography';
6 | import Stack from '@mui/material/Stack';
7 |
8 | import { openTab, openTabs } from '@/src/lib/services-ext';
9 | import { removeNotifyItemById } from '@/src/lib/storage/customNotifications';
10 | import useNotifyItems from '@/src/lib/hooks/useNotifyItems';
11 |
12 | const mapEventTypeToColor: { [event: string]: string } = {
13 | labeled: '#4caf50',
14 | 'custom-commented': '#ff9800',
15 | mentioned: '#2196f3',
16 | };
17 |
18 | const mapEventTypeToText: { [event: string]: string } = {
19 | labeled: 'Labeled',
20 | 'custom-commented': 'Commented',
21 | mentioned: 'Mentioned',
22 | };
23 |
24 | export default function Updates({ setTabIdx }: { setTabIdx: (idx: number) => void }) {
25 | const notifyItems = useNotifyItems();
26 |
27 | const openAll = async () => {
28 | for (const item of notifyItems) {
29 | await removeNotifyItemById(item.id);
30 | }
31 | openTabs(notifyItems.map((item) => item.link));
32 | };
33 |
34 | return (
35 | <>
36 | {notifyItems.length === 0 ? (
37 |
11 |
20 |
21 |
34 | API Access
12 | 17 | Source Code & Issues 18 | 19 |Specify the root URL to your GitHub Enterprise (defaults to https://github.com)
35 | 36 | 54 |55 | 59 | Create a token 60 | {' '} 61 | with the repo permission. 62 |
63 |66 | 67 |
Polling Interval
69 | 87 |90 | 91 |
Notifications
93 | 109 | 124 |127 | 128 |
Buy Me a Coffee!
130 |131 | If you like this extension, consider buying me a coffee. Your support will help me to continue maintaining 132 | this extension for free. 133 |
134 | 135 |
140 |
141 | 144 | 145 |
146 | Please save and click on the "Github Custom Notifier" extension icon in the browser toolbar to configure which 147 | repos to receive notifications from. 148 |
149 | 150 | 157 |No updates
48 | 51 |{repoName}
222 |Labeled
242 |Mentioned
269 |
296 | Commented {/* */}
297 |
305 |
307 | {/* */}
308 |
309 |
374 |
382 | setOpenAlert(false)}
386 | autoHideDuration={3000}
387 | >
388 | setOpenAlert(false)} severity='success' variant='filled' sx={{ width: '80%' }}>
389 | Saved! 🎉 (Applies to Future Updates)
390 |
391 |
392 |
393 | setRepoNameInput(name)}
396 | part='name'
397 | placeholder='e.g. qiweiii/github-custom-notifier'
398 | sx={{
399 | width: '200px',
400 | mr: '10px',
401 | }}
402 | />
403 |
411 |
412 |
413 | {Object.entries(settings?.repos || {})
414 | .sort((a, b) => a[1].createdAt - b[1].createdAt)
415 | .map(([repoName, settings]) => (
416 | {
422 | setSettings((prevState) => {
423 | if (!prevState) return prevState;
424 | return {
425 | ...prevState,
426 | repos: {
427 | ...prevState.repos,
428 | [repoName]: {
429 | ...prevState.repos[repoName],
430 | ...settings,
431 | },
432 | },
433 | };
434 | });
435 | }}
436 | />
437 | ))}
438 |
439 | );
440 | }
441 |
--------------------------------------------------------------------------------