linkedin / linkedin/icon-magic

Refactor the flavor schema

Open
#319 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
18
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Remove the mapping to types, and add type to the flavor schema itself. Every generate plugin will then need to return a new flavor as the output and add that to the list of flavors of the icon. Distribute plugins can be updated to filter using this new type schema. This change will remove the link to the original flavor from which it was generated, but we don't really need that anywhere and we can simplify the output iconrc and make it more readable.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the flavor schema, generate plugins, and distribute plugins described in the issue. Trace how generated flavors are added to an icon and how distribute plugins currently filter them. Done means flavors carry their own type, generate plugins return and register new flavors, filters use that type, and the original-flavor mapping is removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
build-system, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.