@unocss/inspector

What is @unocss/inspector?

@unocss/inspector is a tool designed to help developers inspect and debug their UnoCSS styles directly within their development environment. It provides a visual interface to see which styles are applied to elements, making it easier to understand and troubleshoot CSS issues.

What are @unocss/inspector's main functionalities?

Style Inspection

This feature allows developers to inspect the styles applied to elements in their application. By attaching the inspector, you can hover over elements to see the UnoCSS classes and styles applied to them.

import { createInspector } from '@unocss/inspector';

const inspector = createInspector();
inspector.attach();

Live Editing

Live editing allows developers to make changes to their UnoCSS styles directly from the inspector interface. This can speed up the development process by providing immediate feedback on style changes.

import { createInspector } from '@unocss/inspector';

const inspector = createInspector();
inspector.attach();

// Enable live editing
inspector.enableLiveEditing();

Style Source Mapping

Source mapping helps developers trace back the styles to their original source files. This is particularly useful for debugging and understanding where specific styles are coming from.

import { createInspector } from '@unocss/inspector';

const inspector = createInspector();
inspector.attach();

// Enable source mapping
inspector.enableSourceMapping();

Other packages similar to @unocss/inspector

stylelint

Stylelint is a powerful tool for linting CSS and other stylesheets. It helps developers enforce consistent conventions and avoid errors in their styles. Unlike @unocss/inspector, which focuses on inspection and live editing, Stylelint is more about enforcing coding standards and catching errors.

postcss

PostCSS is a tool for transforming CSS with JavaScript plugins. It can be used to lint, transform, and optimize styles. While PostCSS is more about processing and transforming CSS, @unocss/inspector focuses on inspecting and debugging styles in a live environment.

cssnano

cssnano is a CSS optimizer that helps reduce the size of your CSS files. It is used to minify and compress CSS, making it more efficient for production. Unlike @unocss/inspector, which is a development tool, cssnano is used primarily for optimizing CSS for deployment.

README

@unocss/inspector

The inspector UI for UnoCSS. Ships with unocss and @unocss/vite.

Visit http://localhost:3000/__unocss in your Vite dev server to see the inspector.

TODO

• Basic Overview
• Basic REPL
• Basic file view
• Data caches (move the fetches to shared modules instead of in components)
• Manual refresh button
• Resizeable sidebar (use splitpanes, refer to playground)
• Auto reload on file changes (reuse Vite's hmr if possible)
• Config view
• Edit files directly
• CSS Prettify

🙌 Contribution welcome!

License

MIT License © 2021-PRESENT Anthony Fu