Skip to content

Commit ba84ed8

Browse files
committed
refactor(usegithubautomatedrepos): implement @params to instruct the insertion of parameters
1 parent cbbde26 commit ba84ed8

File tree

5 files changed

+8
-4
lines changed

5 files changed

+8
-4
lines changed

src/ProjectIcons.tsx renamed to src/components/ProjectIcons.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react';
22

3-
import { IconsData } from './hooks/useGithubAutomatedRepos';
3+
import { IconsData } from '../hooks/useGithubAutomatedRepos';
44

55
type Props = {
66
iconItem: string;

src/components/ProjectText.tsx

Whitespace-only changes.

src/StackIcons.tsx renamed to src/components/StackIcons.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react';
22

3-
import { IconsData } from './hooks/useGithubAutomatedRepos';
3+
import { IconsData } from '../hooks/useGithubAutomatedRepos';
44

55
type Props = {
66
iconItem: string;

src/hooks/useGithubAutomatedRepos.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ export interface IGithubRepos {
2727
homepage: string;
2828
}
2929

30+
/**
31+
* @param {string} usernameGitHub - Insert your username GitHub Ex.: https://github.com/USERNAME
32+
* @param {string} keyWordDeploy - Insert a keyword chosen by you. - This key is responsible for managing your projects on GitHub.
33+
*/
3034
export function useGithubAutomatedRepos(usernameGitHub: string, keyWordDeploy: string) {
3135
const [repository, setRepository] = useState<IGithubRepos[]>([]);
3236
useEffect(() => {

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
export { ProjectIcons } from './ProjectIcons';
2-
export { StackIcons } from './StackIcons';
1+
export { ProjectIcons } from './components/ProjectIcons';
2+
export { StackIcons } from './components/StackIcons';
33
export { IGithubRepos, useGithubAutomatedRepos, IconsData } from './hooks/useGithubAutomatedRepos';

0 commit comments

Comments
 (0)