tailwindcss-formatter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b19aef1c5b1d66878b4958539acd3bdbbb750b6aa88ca7badedcb951003483a6
-  data.tar.gz: 91497c6398ec7faef985b192c36912425faa135c155f511f42f4c49410a33dc5
+  metadata.gz: 8b0a52e913a5ea017ecb958467341b07eb9079b113ecc611d0d531a97a786ce2
+  data.tar.gz: 877921beb5246aea9a80c7b3b9fc47c561f86d3dfb8e6280f75e73ed29475e50
 SHA512:
-  metadata.gz: 84bd6491ab8ad09dc25fab0c7eb97c30799d3d7fe90fa94cb7ffa132d9bc930be3a9c7c195dc6f8d927b6ab6951f099a6ffa99519c31109374307e551b8590c4
-  data.tar.gz: 538d2bc1081fb42109afcbdef1551d9d3a261fe53b219c2eb262db9dc4530534f79962a59c87263e5aba809ce11c981bd41c326f68548d00e13260572362297b
+  metadata.gz: b009acc4da9a0b0c6012c992b59a0657670dd26533667eb6d4fe727fe2cda1f219f5cb2be6ac3fdc2eb4fcb89de59cc049edd6a98d99d903cf255d962176ebdf
+  data.tar.gz: 15ebf800ea4c9a97dc49a04c2e360dd342dfe4a1d784bed3adb0ff3944bd420e26e2e2f149e52db057c1024f3eaf55c623b1e6d637a1698a386429a12021f9d2

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/version.rb

@@ -2,6 +2,6 @@
 
 module Tailwindcss
   module Formatter
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tailwindcss-formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Barber
@@ -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: []