tailwindcss-formatter 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b19aef1c5b1d66878b4958539acd3bdbbb750b6aa88ca7badedcb951003483a6
-  data.tar.gz: 91497c6398ec7faef985b192c36912425faa135c155f511f42f4c49410a33dc5
+  metadata.gz: f6c8cd02e4f4b52fd2a85a19148d5b28c2e8055b3c851d0547025886baf5dbe7
+  data.tar.gz: 672f2cc8364a601d5841acf22bd756a6ad5d668f1b132ab80679eb09a72e443a
 SHA512:
-  metadata.gz: 84bd6491ab8ad09dc25fab0c7eb97c30799d3d7fe90fa94cb7ffa132d9bc930be3a9c7c195dc6f8d927b6ab6951f099a6ffa99519c31109374307e551b8590c4
-  data.tar.gz: 538d2bc1081fb42109afcbdef1551d9d3a261fe53b219c2eb262db9dc4530534f79962a59c87263e5aba809ce11c981bd41c326f68548d00e13260572362297b
+  metadata.gz: c56a232c431873d2453d2c96ed109208487b9df0936062d8463512ba735f079fc9dec77fb2b6bd22bba42568d2d569390906ca9b36aff43f5c502dcb77d76e36
+  data.tar.gz: fa64b62e76a020cf5b13ce6ebf24808e7a7606dfa0275f559b73561d73b53f88bd9cddcd24dc7a630e484831865c7a6b07e1bd6705fdea8cdd4ee878df41e72b

data/README.md

@@ -1,35 +1,62 @@
 # Tailwindcss::Formatter
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tailwindcss/formatter`. To experiment with that code, run `bin/console` for an interactive prompt.
+This Ruby Gem provides a CLI interface for effortlessly organising and formating Tailwind
+CSS class declarations in your HTML and ERB templates, following the recommended class
+order for cleaner and more maintainable code.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add it to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add tailwindcss-formatter
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install tailwindcss-formatter
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Once installed, you can run the formatter from the CLI to format your files. It runs
+in dry mode by default, so you will need to specify the `-w | --write` flag to have the
+modifications written back to the files in place.
+
+It takes a glob or file path as the first argument. If you leave this empty, it will
+use the default, which is set up for a typical Rails project: `"app/**/*.html.erb"`.
+
+Example with glob pattern to match files:
+
+```bash
+tailwindcss-format "app/**/*.html.erb"
+```
+
+Example passing the `--write` flag so the formatting is written to the files in place:
+
+```bash
+tailwindcss-format "app/**/*.html.erb" -w
+```
+
+### Flags
+
+`-w | --write`             Writes the formatted class strings back to the file in place.
+
+`-c | --check-formatted`   Raises exit code 1 if unformatted class declarations are detected.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`
+to run the tests. You can also run `bin/console` for an interactive prompt that will allow
+you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a
+new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and the created tag, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tailwindcss-formatter.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/benbarber/tailwindcss-formatter.

data/lib/tailwindcss/formatter/class_sorter.rb

@@ -32,32 +32,61 @@ module Tailwindcss
         end
       end
 
-      private
+      def sorted_class_string(str)
+        class_string = str.dup
+        class_list = []
+        template_tags = extract_template_tags(class_string)
 
-      def format_content(content)
-        CLASS_REGEX_PATTERNS.each do |_regex|
-          content = content.gsub(_regex[:pattern]) do |_match|
-            "#{_regex[:prefix]}\"#{sorted_class_string(Regexp.last_match(1))}\""
-          end
+        # Remove the found template tags from the class_string
+        template_tags.each do |tag|
+          class_string.gsub!(tag, "")
         end
 
-        content
-      end
+        # Split the remaing class_string by whitespace
+        class_list += class_string.split(/\s+/)
 
-      def sorted_class_string(class_string)
-        class_list = class_string.split(/\s+/)
-        sorted_list = class_list.sort_by do |class_name|
-          order_index = CLASS_ORDER.index(class_name)
-          order_index.nil? ? [1, class_name] : [0, order_index]
-        end
+        # Sort the class_list
+        sorted_class_list = sort_class_list(class_list)
+
+        # Add the filtered template tags back to the sorted class list
+        sorted_class_list += template_tags
 
-        sorted_list.join(" ")
+        # Join and return the sorted class list as a formatted class_string
+        sorted_class_list.join(" ")
       end
 
       def fail_format_check
         puts "Check format failure - exited with error code 1"
         exit(1)
       end
+
+      private
+
+      def extract_template_tags(class_string)
+        template_tags = []
+
+        # Check for ERB template tags
+        template_tags += class_string.scan(/<%.*?%>/)
+
+        template_tags
+      end
+
+      def sort_class_list(class_list)
+        class_list.sort_by do |class_name|
+          order_index = CLASS_ORDER.index(class_name)
+          order_index.nil? ? [1, class_name] : [0, order_index]
+        end
+      end
+
+      def format_content(content)
+        CLASS_REGEX_PATTERNS.each do |regex|
+          content = content.gsub(regex[:pattern]) do |_match|
+            "#{regex[:prefix]}\"#{sorted_class_string(Regexp.last_match(1))}\""
+          end
+        end
+
+        content
+      end
     end
   end
 end

data/lib/tailwindcss/formatter/constants.rb

@@ -2,9 +2,9 @@
 
 # Regex patterns to get the class strings for formatting
 CLASS_REGEX_PATTERNS = [
-  { pattern: /class:\s*"([^"]*)"/, prefix: "class: " },
-  { pattern: /class="\s*([^"]*)"/, prefix: "class=" },
-  { pattern: /className="\s*([^"]*)"/, prefix: "className=" }
+  { pattern: /class:\s*["]([^"]*)["]/, prefix: "class: " },
+  { pattern: /class=\s*["]([^"]*)["]/, prefix: "class=" },
+  { pattern: /className=\s*["]([^"]*)["]/, prefix: "className=" }
 ].freeze
 
 # Default sorting order for Tailwind classes

data/lib/tailwindcss/formatter/version.rb

@@ -2,6 +2,6 @@
 
 module Tailwindcss
   module Formatter
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/tailwindcss-formatter.gemspec

@@ -5,12 +5,15 @@ require_relative "lib/tailwindcss/formatter/version"
 Gem::Specification.new do |spec|
   spec.name = "tailwindcss-formatter"
   spec.version = Tailwindcss::Formatter::VERSION
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.licenses = %w[MIT]
+
   spec.authors = ["Ben Barber"]
   spec.email = ["contact@benbarber.co.uk"]
-
-  spec.summary = "Format and sort Tailwind CSS classes based on the recommended class order."
   spec.homepage = "https://github.com/benbarber/tailwindcss-formatter#readme"
-  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.summary = "Effortlessly organize and format Tailwind CSS class declarations in your HTML and ERB
+  templates, following the recommended class order for cleaner and more maintainable code."
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/benbarber/tailwindcss-formatter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailwindcss-formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Ben Barber
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -26,7 +26,8 @@ files:
 - lib/tailwindcss/formatter/version.rb
 - tailwindcss-formatter.gemspec
 homepage: https://github.com/benbarber/tailwindcss-formatter#readme
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/benbarber/tailwindcss-formatter#readme
   source_code_uri: https://github.com/benbarber/tailwindcss-formatter
@@ -50,5 +51,7 @@ requirements: []
 rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
-summary: Format and sort Tailwind CSS classes based on the recommended class order.
+summary: Effortlessly organize and format Tailwind CSS class declarations in your
+  HTML and ERB templates, following the recommended class order for cleaner and more
+  maintainable code.
 test_files: []