https://github.com/zebradevs/zeta-icon-validator

A utility used to check the validity of icons before they are uploaded to the Zeta Icon Library
https://github.com/zebradevs/zeta-icon-validator

Last synced: 18 days ago
JSON representation

A utility used to check the validity of icons before they are uploaded to the Zeta Icon Library

• Host: GitHub
• URL: https://github.com/zebradevs/zeta-icon-validator
• Owner: ZebraDevs
• Created: 2025-01-09T15:25:10.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-10-13T10:35:26.000Z (9 months ago)
• Last Synced: 2025-10-16T12:10:54.624Z (9 months ago)
• Language: TypeScript
• Size: 3.21 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# zeta-icon-validator

A utility used to check the validity of icons before they are uploaded to the Zeta Icon Library.

# Criteria

## Name

Icon names are considered invalid if they

- Start with a number

- Contain a non alpha-numeric character except for spaces, \_, and $

- Are a [Dart reserved word](https://dart.dev/language/keywords)

Icons will be renamed if the name has been used already.

They are renamed by prepending its category name to it.

## Properties

Icons must have a `Style` variant property with `Round` and `Sharp` variants.

## Size

The bound box of all icon variants must be 24x24px.

# Usage

## Validate Icon

This function is the main entry point for checking icon validity.

It accepts a Figma component set object and validates its name, size, and properties.

It returns a list of `ZetaIconError` which contains all the erros with the given icon.

Each error has a severity and a message.

If an icon has been renamed, the error will have a `newName` property containing the icons new name.

```ts

validateIcon(icon: ComponentSetNode): ZetaIconError[]

```

    Zebra Repository Information

    


        
 Zebra Business Unit : DMO - I&D Team 

        
 Zebra Manager : mikecoomber 

        
 Zebra Repo Admin: mikecoomber 

        
 Zebra Jira Project ID: N/A  

        
 Product: zeta-icon-name-checker, zeta-icons

        
 Topics: zeta-icons, icon library