slimembedcop 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2de74f977f0c9b3d8668fb691ea042033412e2feee2b77638dca4d60bbac30a4
-  data.tar.gz: 7aea53f38ce0c1c3965cdcda6ffd4ad0260b0242d09aaae610484114f0580f1b
+  metadata.gz: 819399a1940beed5d69493debeb14cc9ca337274d4c94a015aa4fa7cb4a61576
+  data.tar.gz: a9513d7bcc2b2df861fa0b9509542ef83f2b7caa4757d9a986d626d2305ce5d2
 SHA512:
-  metadata.gz: 63bead9c81a50545c49bc6b039b1362109b59710cd45e50ab88f2375e77089182320e6c624f8297b355521d5b3f6a99758008f087db6d2c843aa5942a7e623dc
-  data.tar.gz: db4c9e49e42d4fa6157627e4ad0f9497c114072a22b4944181b9308ef9a749d6b49763c0f25644465c034044f5be48b016e226295660c2b2983c1c5454f252a7
+  metadata.gz: b193c4391dadc3d800d2a9b6ae62dad2d0ce3e52450e3c292a7f30971bc82b622ce268d7b5a15e59d36c9ab627d7b476971d5cf4158e7e4ede005e4458b50fbb
+  data.tar.gz: 38dec3b0af1d1d4702297a6f0cdb01732ff9075fa2aa48258c5588b8e0caffc4f1b493956a3c8d4efc71d70dae502fb9808aa7c1dcacea47cdf7c002fcc29521

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 1.0.0 - 2024-11-29
+
+- Fix warnings for use of `Team.new`.
+
 ## 0.2.0 - 2023-09-16
 
 - Disable unnecessary cop for slimembedcop.

data/README.md

@@ -1,6 +1,100 @@
-# Slimembedcop
+# SlimEmbedCop
 
-RuboCop runner for Ruby code embedded in Slim.
+[![Gem Version](https://badge.fury.io/rb/slimembedcop.svg)](https://badge.fury.io/rb/slimembedcop)
+[![CI](https://github.com/ydah/slimembedcop/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/slimembedcop/actions/workflows/ci.yml)
+[![RubyDoc](https://img.shields.io/badge/%F0%9F%93%9ARubyDoc-documentation-informational.svg)](https://www.rubydoc.info/gems/slimembedcop)
+
+
+[RuboCop](https://github.com/rubocop/rubocop) runner for [Ruby code embedded in Slim](https://github.com/slim-template/slim#embedded-engines-markdown-).
+
+## Installation
+
+**SlimEmbedCop**'s installation is pretty standard:
+
+```sh
+% gem install slimembedcop
+```
+
+If you'd rather install SlimEmbedCop using `bundler`, add a line for it in your `Gemfile` (but set the `require` option to `false`, as it is a standalone tool):
+
+```ruby
+gem 'slimembedcop', require: false
+```
+
+## Usage
+
+Use `slimembedcop` executable to check offenses and autocorrect them.
+[RuboCop's cop](https://docs.rubocop.org/rubocop/1.56/cops.html) or any [custom cop](https://docs.rubocop.org/rubocop/extensions.html#custom-cops) you create can also be used with `slimembedcop`.
+
+```sh
+% exe/slimembedcop --help
+Usage: slimembedcop [options] [file1, file2, ...]
+    -v, --version                    Display version.
+    -a, --autocorrect                Autocorrect offenses.
+    -c, --config=                    Specify configuration file.
+        --[no-]color                 Force color output on or off.
+    -d, --debug                      Display debug info.
+```
+
+### Example
+
+You have a Slim file like this:
+
+```ruby
+ruby:
+  message = "world"
+html
+  head
+    title Slim Samples
+  body
+    ruby:
+      if some_var = true
+        do_something
+      end
+    h1 Hello, #{message}
+ruby:
+  do_something /pattern/i
+```
+
+When executed, it outputs the following offenses:
+
+```sh
+% slimembedcop dummy.slim
+Inspecting 1 file
+W
+
+Offenses:
+
+dummy.slim:2:13: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+  message = "world"
+            ^^^^^^^
+dummy.slim:8:19: W: [Correctable] Lint/AssignmentInCondition: Use == if you meant to do a comparison or wrap the expression in parentheses to indicate you meant to assign in a condition.
+      if some_var = true
+                  ^
+dummy.slim:13:16: W: [Correctable] Lint/AmbiguousRegexpLiteral: Ambiguous regexp literal. Parenthesize the method arguments if it's surely a regexp literal, or add a whitespace to the right of the / if it should be a division.
+  do_something /pattern/i
+               ^
+
+1 file inspected, 3 offenses detected, 3 offenses autocorrectable
+```
+
+## Configuration
+
+The behavior of [RuboCop](https://github.com/rubocop/rubocop) can be controlled via the [.rubocop.yml](https://github.com/rubocop/rubocop/blob/master/.rubocop.yml) configuration file. The behavior of `SlimEmbedCop` can be controlled by the `.slimembedcop.yml` configuration file. It makes it possible to enable/disable certain cops (checks) and to alter their behavior if they accept any parameters. The file can be placed in your home directory, XDG config directory, or in some project directory.
+
+The file has the following format:
+
+```yaml
+inherit_from: ../.rubocop.yml
+
+Style/Encoding:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 99
+```
+
+NOTE: It is basically the same as RuboCop's. Please check [Configuration](https://docs.rubocop.org/rubocop/configuration.html) for details.
 
 ## License
 

data/lib/slimembedcop/ruby_offense_collector.rb

@@ -29,7 +29,7 @@ module Slimembedcop
     end
 
     def team
-      ::RuboCop::Cop::Team.new(
+      ::RuboCop::Cop::Team.mobilize(
         registry,
         @config,
         autocorrect: @autocorrect,

data/lib/slimembedcop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slimembedcop
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimembedcop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
+original_platform: ''
 authors:
 - Yudai Takada
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,7 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description:
 email:
 - t.yudai92@gmail.com
 executables:
@@ -32,6 +31,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codespellignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -61,7 +61,6 @@ metadata:
   source_code_uri: https://github.com/ydah/slimembedcop
   changelog_uri: https://github.com/ydah/slimembedcop/releases
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: RuboCop runner for Ruby code embedded in Slim.
 test_files: []