dry-styles
v1.1.3
Published
Static analysis tool for pinpointing components that share matching class combinations.
Downloads
3
Readme
dry-styles
A tool to understand CSS class usage patterns within projects.
Functionality Overview
This application parses HTML files within a specified directory, extracting CSS class information from elements. It then organizes this data, associating each CSS class with the file location and line number where it's used. This organized data is invaluable for understanding the usage patterns of CSS classes within the project.
This app extracts CSS class info from HTML files in a specified directory, associating each class with its usage location (file and line number). This insight aids in understanding CSS class usage patterns across the project.
Potential Use with Tailwind CSS
This application's functionality can be particularly beneficial when working with utility-first CSS frameworks like Tailwind CSS. By gaining insights into which utility classes are heavily utilized together and where they're applied, developers can make informed decisions regarding code organization and refactoring.
Installing Dependencies
npm install
Running
To analyze CSS class usage patterns within a project, run the following command:
npx tsx src/bin.js analyze <target_directory> [--sortBy <classes|entries>]
<target_directory>
: The path to the directory containing HTML files to analyze.--sortBy <classes|entries>
(optional): Sort the results by the number of entries of a class set, or how many classes there are in the class set. Default is entries.
For example:
npx tsx analyze src/bin.js /Users/pablo/Documents/dry-styles/tests/static --sortBy classes
Bundling
npx tsup
TODO:
[] add an option to include hidden folders on the analisys
[] add an option to exclude certain folders from the analisys