Code
Code reads your repository without running it and explains it in plain words, from its components and variations to design issues and pull request checks.
Code connects a GitHub repository to your project and keeps it in view next to the design system. It supports React and TypeScript web apps today.
The Code report has these tabs:
- Overview: the last scan, issues by priority and your components.
- Components: what M1rror found in your code and how it maps to the system.
- Issues: design issues, such as colours outside the palette or spacing outside the scale.
- Variations: how a component or screen looks across branches.
- Pull requests: design checks on your pull requests.
- What we checked: exactly what the scan read and what it couldn't.
- Test data: sample data for screens and previews.
Scans read your files to find components and design issues. Nothing is run.
The Repository panel on the left shows the connected repository and its branch, with:
- Toolchain: the package manager, Node version, monorepo package and checks M1rror uses for your repository, and the variables those checks need. See your repository's toolchain and monorepos.
- Changelog: the implementation pull requests that merged. See stay in sync after a merge.
In this section
- Scan your repositoryConnect a GitHub repository, run a static scan that never executes your code, and read the components, issues and history it finds.
- Pull request design checksCheck every pull request's added lines against your design system for off-theme colours, off-scale spacing and type, re-implemented components, contrast and missing states.
- Your repository's toolchain and monoreposM1rror checks changes with your own package manager, Node version and scripts. Choose the app in a monorepo, adjust checks and store the variables they need.
- Stay in sync after a mergeKeep M1rror up to date when your default branch moves, avoid re-approving builds for unrelated commits, read the changelog of merged work and open a revert pull request.
Last updated
Edit this page on GitHub