Skip to content

Commit 2435eef

Browse files
committed
refactor: update generate-icon script documentation
1 parent aaba4ec commit 2435eef

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

.husky/pre-commit

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
echo "Running pre-commit hook..."
2121

2222
# Check for changes in the Icon folder
23-
CHANGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep 'IconV2/' || true)
23+
CHANGED_FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep -E 'IconV2/|generate-icon.cjs' || true)
2424

2525
if [ -n "$CHANGED_FILES" ]; then
26-
echo "Changes detected in the Icon folder. Running icon generation script..."
26+
echo "Changes detected in the Icon folder or icon generation script. Running icon generation script..."
2727

2828
if ! npm run generate-icon; then
2929
echo "Error: Icon generation script failed."

scripts/generate-icon.cjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ const generateIconComponent = () => {
6666
export type IconName = keyof typeof iconMap;
6767
6868
export interface IconsProps extends Omit<IconBaseProps, 'name' | 'iconMap'> {
69+
/** The name of the icon to render. */
6970
name: keyof typeof iconMap;
7071
}
7172

src/Shared/Components/Icon/Icon.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ export const iconMap = {
4747
export type IconName = keyof typeof iconMap
4848

4949
export interface IconsProps extends Omit<IconBaseProps, 'name' | 'iconMap'> {
50+
/** The name of the icon to render. */
5051
name: keyof typeof iconMap
5152
}
5253

0 commit comments

Comments
 (0)