Omlet Docs


Sept 13th, 2023

Import resolution
Omlet has improved its ability to deduplicate components by resolving component imports across packages. Next up, we'll further improve this through Node.js package entry points.
Alias configuration file
Omlet can now read aliases you have setup in TSConfig files or your bundler to resolve imports. Simply map your aliases in a configuration file. Find out more in our docs.
Updated docs site
We have migrated to a new docs site and added a few sections to address frequently asked questions like…
  • How components and their dependencies are detected
  • A detailed comparison on Omlet and React Scanner
  • An expanded section security
styled-components support
Omlet has expanded support for styled-components.
Faster CLI scans
Omlet CLI scan time has been reduced by optimizing how it collects date related information for components.

May 31st, 2023

React Native Support
We now officially support React Native along side React! We hope to continue to expand the teams we can support through different framework support. Reply here if you have a framework you’d like us to support.
Demo Omlet Workspace for Everyone
We prepared a demo workspace (accessible to anyone without an Omlet account) using a real life, open source project called Proton.
Component Dependency Tree Table
Dependency Tree just got another upgrade! We have a new table where you can search for specific components and filter the tree. Confidently updating highly used and complex components is now even easier.
Hovers & Interactive Charts
Hover over to learn details about a component in charts and navigate to their detail page directly. Go from usage by project to a list of all components being used in a specific project.
Magic Link Login with your Email
A secure way to login with Omlet without a password using magic links sent to your email. Signup or invite users with email addresses that are not tied to Google or Github OAuth.

Apr 26th, 2023

Improved Component Dependency Tree
We’ve updated the component dependency tree and now it’s much easier to see where exactly your components are used, how changes can affect your entire code base.
Auto Tag Components from External Packages
Omlet CLI will now automatically tag components from any external packages like MUI or other libraries as “external”. This will allow you to analyze their usage easily in analytics charts or search them in the component list page.
Windows Support for Omlet CLI
You can now install and run the Omlet CLI on Windows machines as well!
Run Omlet CLI Behind Proxy Server
You can now run Omlet CLI through proxy servers. Pass proxy configuration to the CLI using the HTTP_PROXY and HTTPS_PROXY environment variables.
e.g. HTTP_PROXY=[<>](<>) omlet analyze
Filter to Specific Components in Charts
If you’re curious about individual components, you can now analyze specific components in various charts with the new “is” filter.
Lookup Untagged Components in Charts
It is now possible to filter for any untagged components in the charts.

March 1st, 2023

Improved initial setup experience
  • Introduced omlet init which will collect necessary repos from the user based on their project setup.
  • Added UI-based tag configuration page to tag Design System components as Core.
Analytics dashboard with more predefined charts
A new dashboard with several pre-configured charts to show more insights on component usage.
Custom Tags from the CLI have been migrated over to UI-based tagging
Improved Component Detail page
More details about each component are now displayed on the Component Detail page including date-related information, the project it is from, and more.
Project & Date filters in the Component List page
Filter Analytics page based on Component Name or File Paths

Jan 25th, 2023 🎊

Track Component Date Properties
We now track when components were created, updated and last used. Allowing you to keep a pulse on how your code base and Design system is evolving.
Filter components by date properties in Analytics page
Curious what custom components your teams are building recently? Filter by created date and custom tag like below. 👇
Sort components by Created or Updated Date in the Component list page
Now even easier to find specific components to analyze more deeply.

Dec 23rd, 2022

Filter components by dependencies and usage count 🐳
One way you can use this is to find Design System components that have low usage count.
Time series chart for individual components & projects 📈
Track usage increase for new Design System components you release, or find out which projects are adopting your Design System overtime.

Oct 19th, 2022

Zero config scanning
You can scan code repositories with no parameters and Omlet will use sensible defaults to provide useful results.
Scan result summary in CLI 🔢
Get a summary of scanned components in the CLI to immediately get feedback.
A list of projects with number of components detected in each of them displayed by Omlet CLI in the terminal
Review Scan History & Delete 🗑️
Ability to review a log of previous scans and delete specific runs to clean the results.
Navigating to all scans page where a history of all CLI scans are listed by date
2022-10-19 09.36.59.gif
Improved chart navigation and visualization 💅🏽
Made the popular charts always visible in the analytics page, and improved visualization for breakdowns.
Goodbye -o / --output . Hello --dry-run 👋
The name of the option has been changed and now it will only output results locally to omlet.out.json

Sept 19th, 2022

Customizable analytics charts to find actionable insights unique to your team
Customizable Charts ⚙️
Showing customization options for charts in Omlet
Improved Component Detection
We added support for components detecting dependencies that happen through referencing values in an external object like function calls or other variables.
Fixed Node Dependency Issue
We fixed issue where Omlet CLI was not running on older versions of Node. We officially have a minimum target Node.js version, which is v10.
Fixed Component Usage Detection from Separate Code Repositories
We fixed an issue where the usage of components coming from a separate code repository was not detected. This happens if you scan multiple repositories and one of them is a component library.

August 15th, 2022

Improved analytics and support for tracking multiple code repositories.
Scan Multiple Code Repositories 🗂
If you have multiple products or organize a product into multiple repositories, this will now allow you to track your component usage across all those projects in a single Omlet workspace.
Improved Analytics Charts 📊
Out-of-the-box analytics charts that provide deeper insights into your team's component usage. See adoption across each code repository, adoption over time, and most used components.
Showing chart options available in Omlet
Linux Support 🤖
You can now use Omlet CLI on linux machines.

June 15th, 2022

Tag your components using the CLI to easily group and search them. Further improvements in component detection.
Apply Tags to Categorize Components 🏷
The ability to apply tags to components using Omlet CLI. Use the tags to search and analyze components.
Filter Search with Component Tags 🐳
Use the tags to filter components from the Component Search page
Support for Styled Components 💅
Detect components using Styled Components syntax
Improvements to Monorepo Support 🗂
Support additional Monorepo configurations from Lerna & yarn
Detect Wrapped Components 🎁
Detect and track components that wrapped in various functions
and many more improvements in component detection and various bug fixes! 👏

May 19th, 2022

Monorepo Support 🗂
Support projects that organized as a monorepo
Detect Components from External Packages 📦
Omlet now detects components coming from external packages/libraries even if they are not part of your source code.
(partial) Support for Styled Components
Omlet can now detect components using Styled Components. We will be improving support for this specific setup further.
Support Alias Imports Using TSConfig Paths 🛣
Omlet now detects components that use alias imports using TSConfig paths.
Better Logs for Troubleshooting 👨‍🔧
—verbose and —log-level options have been added to Omlet CLI to provide debugging information to diagnose CLI issues.
and many more improvements in component detection and various bug fixes! 👏

Apr 27th, 2022

Improved Component Detection 💪
Omlet now detects components with class declaration style ex.) class Button extends React. You can also detect components coming from NPM packages.
Component Tree 🌳
When navigating to a Component in Omlet, you will now see a Component Tree that visualizes the dependency of that component.
Example of a component dependency tree
Adoption Progress Chart 📊
Omlet will store historical analysis which will be used to keep track of adoption progress under the Analytics page.
Example of historical usage data being tracked
User Invite 👨‍👩‍👦
You can now invite users to your workspace to share & collaborate.
Auto-upload CLI Output to Omlet Web App ♻️
Omlet CLI will automatically upload the output to the Web app. No need to manually upload the omlet.json file anymore
Login/signup with Google or GitHub OAuth 🔐
You can now log in (or register) using your Google or GitHub accounts.