goodcheck 2.4.3 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc42687754f4ad7fe5e48927a75c1a002eef6be5296c9192906e2ae1cfa3ec4e
-  data.tar.gz: d98d68e23feb34946bb21c17c9568b267842ed24eba012472a9c9b29f5787b7e
+  metadata.gz: 5a8fa2f7ee1e8534b3495e3d77a0d0cfb8b49eeaefc77a6507fee9604e0b829a
+  data.tar.gz: 5cd0ac1288b2bb90978998410ff93e234ec08bc645b2ace741f339e0e0b811b2
 SHA512:
-  metadata.gz: 5ad795cf04626769374ca254f9a86feb63698540c32d4af8efb9e705f74c55a0cf3d3705f99e2a285dbdc156fcb8bae22a74ea4e9aefa5efb24b2368f180197d
-  data.tar.gz: cfae9d9cd9d5b76bfa03840d66ec2ea3671a77ef5fb98a1e24994c303b57254d22ba80ac0cc91521c51e82d1594e9e12a4ce5d4eb4a3ad4c701634d1e60c253f
+  metadata.gz: dbadbb4097eb8ba35fff5845ade562e47830c197297176118f5144ad984132331f890ef9f7b1e30f14e66ae9d43df64819fb7794dd3059f22fe46e75fcd76a6a
+  data.tar.gz: 3728f7b3037174382675361fa05be02e0f1bf1ede5cb6aadacef2098c062568a95e560a10eed72bffd12baac171b636279738ecf3cccd78be11526922bba50bb

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "09:00"
+      timezone: Asia/Tokyo
+    open-pull-requests-limit: 10
+    versioning-strategy: increase
+  - package-ecosystem: npm
+    directory: "/docusaurus/website"
+    schedule:
+      interval: monthly
+      time: "09:00"
+      timezone: Asia/Tokyo
+    open-pull-requests-limit: 10
+    versioning-strategy: increase

data/.github/workflows/release.yml

@@ -0,0 +1,16 @@
+name: Release
+
+on: push
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          body: |
+            See the [changelog](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/CHANGELOG.md) for more details.
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Test
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: |
+          gem install bundler --no-document
+          bundle config set path vendor/bundle
+          bundle install --jobs=4 --retry=3
+      - run: bundle exec rake
+
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - run: |
+          gem install bundler --no-document
+          bundle config set path vendor/bundle
+          bundle install --jobs=4 --retry=3
+      - run: bundle exec rake docs:build
+
+  benchmark:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - run: |
+          gem install bundler --no-document
+          bundle config set path vendor/bundle
+          bundle install --jobs=4 --retry=3
+      - run: bundle exec rake benchmark:run[10000]

data/.gitignore

@@ -9,4 +9,5 @@
 /tmp/
 /.idea
 /Gemfile.lock
+/.ruby-version
 .DS_Store

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## master
 
+## 2.5.2 (2020-08-31)
+
+* Fix the pattern of disable lines for Slash-asterisk and add support for JSX [#131](https: //github.com/sider/goodcheck/pull/131)
+
+## 2.5.1 (2020-03-09)
+
+* Replace `httpclient` with `net/http` [#115](https://github.com/sider/goodcheck/pull/115)
+
+## 2.5.0 (2020-02-27)
+
+* Add disable lines via inline comments [#101](https://github.com/sider/goodcheck/pull/101) (thanks to [@dcwither](https://github.com/dcwither)). See [README](https://github.com/sider/goodcheck#disabling-rules-with-inline-comments) for details.
+
+## 2.4.5 (2019-12-13)
+
+* Replace ActiveSupport's `Regexp#multiline?` extension [#97](https://github.com/sider/goodcheck/pull/97) (thanks to [@issei126](https://github.com/issei126))
+
+## 2.4.4 (2019-11-19)
+
+* Check dot files (except for `.git`, `.svn`, `.hg`) [#91](https://github.com/sider/goodcheck/pull/91)
+* Improve `test` command output [#93](https://github.com/sider/goodcheck/pull/93)
+
 ## 2.4.3 (2019-11-07)
 
 * Change LICENSE to MIT [#76](https://github.com/sider/goodcheck/pull/76)

data/README.md

@@ -8,25 +8,43 @@ What if a misspelling like `Github` for `GitHub` can be found automatically?
 
 Give Goodcheck a try to do them instead of you! 🎉
 
-Goodcheck is a customizable linter.
-You can define pairs of patterns and messages.
+Goodcheck is a customizable linter. You can define pairs of patterns and messages.
 It checks your program and when it detects a piece of text matching with the defined patterns, it prints your message which tells your teammates why it should be revised and how.
 Some part of the code reviewing process can be automated.
 With Goodcheck the only thing you have to do is define the rules, pairing patterns with messages, and then those same patterns won’t bother you anymore. 😆
 
+## Table of contents
+
+- [Installation](#installation)
+- [Quickstart](#quickstart)
+- [Defining rules](#defining-rules)
+  - [Pattern](#pattern)
+  - [Glob](#glob)
+  - [A rule with _negated_ pattern](#a-rule-with-negated-pattern)
+  - [A rule without pattern](#a-rule-without-pattern)
+  - [Triggers](#triggers)
+- [Importing rules](#importing-rules)
+- [Excluding files](#excluding-files)
+- [Commands](#commands)
+- [Downloaded rules](#downloaded-rules)
+- [Disabling rules with inline comments](#disabling-rules-with-inline-comments)
+- [Docker images](#docker-images)
+- [Development](#development)
+- [Contributing](#contributing)
+
 ## Installation
 
-```bash
+```shell-session
 $ gem install goodcheck
 ```
 
-Or you can use `bundler`!
+Or you can use [`bundler`](https://bundler.io)!
 
-If you would not like to install Goodcheck to system (e.g. you would not like to install Ruby 2.4 or higher), you can use a docker image. [See below](#docker-images).
+If you would not like to install Goodcheck to system (e.g. you would not like to install Ruby 2.4 or higher), you can use a [Docker image](#docker-images).
 
 ## Quickstart
 
-```bash
+```shell-session
 $ goodcheck init
 $ vim goodcheck.yml
 $ goodcheck check
@@ -40,9 +58,9 @@ Then run `check` command, and it will print matched texts.
 
 You can download a [printable cheatsheet](cheatsheet.pdf) from this repository.
 
-## `goodcheck.yml`
+## Defining rules
 
-An example of the configuration is like the following:
+A `goodcheck.yml` example of the configuration is like the following:
 
 ```yaml
 rules:
@@ -51,7 +69,7 @@ rules:
     message: |
       GitHub is GitHub, not Github
 
-      You may misspelling the name of the service!
+      You may be misspelling the name of the service!
     justification:
       - When you mean a service different from GitHub
       - When GitHub is renamed
@@ -64,36 +82,38 @@ rules:
       - <a>Signup via Github</a>
 ```
 
-The *rule* hash contains the following keys.
+A *rule* hash under a `rules` list contains the following keys:
 
-* `id`: a string to identify rules (required)
-* `pattern`: a *pattern* or a sequence of *pattern*s
-* `message`: a string to tell writers why the code piece should be revised (required)
-* `justification`: a sequence of strings to tell writers when an exception can be allowed (optional)
-* `glob`: a *glob* or a sequence of *glob*s (optional)
-* `pass`: a string, or a sequence of strings, which does not match the given pattern (optional)
-* `fail`: a string, or a sequence of strings, which does match the given pattern (optional)
+* `id` - a string to identify rules (required)
+* [`pattern`](#pattern) - a *pattern* or a sequence of *pattern*s (optional)
+* `message` - a string to tell writers why the code piece should be revised (required)
+* `justification` - a sequence of strings to tell writers when an exception can be allowed (optional)
+* [`glob`](#glob) - a *glob* or a sequence of *glob*s (optional)
+* `pass` - a string or a sequence of strings, which does not match the given pattern (optional)
+* `fail` - a string or a sequence of strings, which does match the given pattern (optional)
 
-### *pattern*
+### Pattern
 
-A *pattern* can be a *literal pattern*, *regexp pattern*, *token pattern*, or a string.
+A pattern can be a *literal pattern*, *regexp pattern*, *token pattern*, or a string.
 
 #### String literal
 
-String literal represents a *literal pattern* or *regexp pattern*.
+A string literal represents a *literal pattern* or *regexp pattern*.
 
 ```yaml
 pattern:
   - This is a literal pattern
   - /This is a regexp pattern/
+  - /This is a regexp pattern with the casefold option/i
+  - /This is a regexp pattern with the multiline option/m
 ```
 
-If the string value begins with `/` and ends with `/`, it is a *regexp pattern*.
+If a string value begins with `/` and ends with `/`, it is a *regexp pattern*.
 You can optionally specify regexp options like `/casefold/i` or `/multiline/m`.
 
-#### *literal pattern*
+#### Literal pattern
 
-*literal pattern* allows you to construct a regexp which matches exactly to the `literal` string.
+A *literal pattern* allows you to construct a regexp which matches exactly to the `literal` string.
 
 ```yaml
 id: com.sample.GitHub
@@ -106,9 +126,9 @@ message: Write GitHub, not Github
 All regexp meta characters included in the `literal` value will be escaped.
 `case_sensitive` is an optional key and the default is `true`.
 
-#### *regexp pattern*
+#### Regexp pattern
 
-*regexp pattern* allows you to write a regexp with meta chars.
+A *regexp pattern* allows you to write a regexp with meta chars.
 
 ```yaml
 id: com.sample.digits
@@ -124,12 +144,12 @@ justification:
 It accepts two optional attributes, `case_sensitive` and `multiline`.
 The default values of `case_sensitive` and `multiline` are `true` and `false` respectively.
 
-The regexp will be passed to `Regexp.compile`.
+The regexp will be passed to [`Regexp.compile`](https://ruby-doc.org/core-2.7.0/Regexp.html#method-c-compile).
 The precise definition of regular expressions can be found in the documentation for Ruby.
 
-#### *token pattern*
+#### Token pattern
 
-*token pattern* compiles to a *tokenized* regexp.
+A *token pattern* compiles to a *tokenized* regexp.
 
 ```yaml
 id: com.sample.no-blink
@@ -162,9 +182,9 @@ pattern:
       color: true
 ```
 
-The variable binding consists of *variable name* and *variable type*, where `color` and `string` in the example above respectively. You have to add a key of the *variable name* in `where` attribute.
+The variable binding consists of a *name* and *type* (`${name:type}`), where `color` and `string` in the example above respectively. You have to add a key of the variable *name* in `where` attribute.
 
-We have 8 built-in patterns:
+We have 8 built-in types:
 
 * `string`
 * `int`
@@ -175,7 +195,7 @@ We have 8 built-in patterns:
 * `word`
 * `identifier`
 
-You can find the exact definitions of the types in the definition of `Goodcheck::Pattern::Token` (`@@TYPES`).
+You can find the exact definitions of the types in the definition of [`Goodcheck::Pattern::Token`](lib/goodcheck/pattern.rb) (`@@TYPES`).
 
 You can omit the type of variable binding.
 
@@ -197,14 +217,21 @@ If parens or brackets are surrounding the variable, Goodcheck tries to match wit
 - `backgroundColor={{ red: red(), green: green(), blue: green()-1 }}` Matches (`color=="{ red: red(), green: green(), blue: green()-1 }"`)
 - `backgroundColor={ {{{{{{}}}}}} }` Matches (`color==" {{{{{{}}}}}"`)
 
-### *glob*
+### Glob
 
-A *glob* can be a string, or a hash.
+A *glob* can be a string or a hash.
 
 ```yaml
+glob: "**/test/**/*.rb"
+# or
 glob:
   pattern: "legacy/**/*.rb"
   encoding: EUC-JP
+# or
+glob:
+  - "**/test/**/*.rb"
+  - pattern: "legacy/**/*.rb"
+    encoding: EUC-JP
 ```
 
 The hash can have an optional `encoding` attribute.
@@ -237,13 +264,12 @@ You can define the _negated_ rules for the opposite, _something is missing in a
 rules:
   - id: negated
     not:
-      pattern:
-        <!DOCTYPE html>
+      pattern: <!DOCTYPE html>
     message: Write a doctype on HTML files.
     glob: "**/*.html"
 ```
 
-### A rule without `pattern`
+### A rule without pattern
 
 You can define a rule without `pattern`.
 The rule emits an issue on each file specified with `glob`.
@@ -259,15 +285,15 @@ rules:
 
 The output will be something like:
 
-```
+```shell-session
 $ goodcheck check
 db/schema.rb:-:# This file is auto-generated from the current state of the database. Instead: Read the operation manual for DB migration: https://example.com/guides/123
 ```
 
 ### Triggers
 
-Version 2.0.0 introduces a new abstraction to define patterns, trigger.
-You can continue using `pattern`s in `rule`, but using `trigger` allows more flexible pattern definition and more precise testing.
+Version 2.0.0 introduces a new abstraction to define patterns, called *trigger*.
+You can continue using `pattern`s in *rule*, but using `trigger` allows more flexible pattern definition and more precise testing.
 
 ```yaml
 rules:
@@ -303,13 +329,25 @@ import:
   - https://some.host/shared/rules.yml
 ```
 
-The value of `import` can be an array of:
+The value of `import` can be a sequence of:
 
 - A string which represents an absolute file path,
 - A string which represents a relative file path from the config file, or
-- A http/https URL which represents the location of rules
+- A http/https URL which represents the location of rules.
+
+The rules file is a YAML file with an sequence of rules:
+
+```yaml
+- id: rule1
+  pattern: Some pattern 1
+  message: Some message 1
+
+- id: rule2
+  pattern: Some pattern 2
+  message: Some message 2
 
-The rules file is a YAML file with an array of rules.
+# ...
+```
 
 ## Excluding files
 
@@ -319,9 +357,10 @@ The rules file is a YAML file with an array of rules.
 exclude:
   - node_modules
   - vendor
+  - **/test/**/*.txt
 ```
 
-The value of `exclude` can be a string or an array of strings representing the glob pattern for excluded files.
+The value of `exclude` can be a string or a sequence of strings representing the glob pattern for excluded files.
 
 ## Commands
 
@@ -342,7 +381,7 @@ You can pass:
 * Directory paths, or
 * Paths to files.
 
-When you omit `targets`, it checks all files in `.`.
+When you omit `targets`, it checks all files in `.` (the current directory).
 
 Available options are:
 
@@ -377,7 +416,7 @@ Available options are:
 * `-c [CONFIG]`, `--config=[CONFIG]` to specify the configuration file.
 * `-v`, `--verbose` to be verbose.
 * `--debug` to print all debug messages.
-* `--force` to ignore downloaded caches
+* `--force` to ignore downloaded caches.
 
 ### `goodcheck pattern [options] ids...`
 
@@ -395,11 +434,29 @@ The *goodcheck home directory* is `~/.goodcheck`, but you can customize the loca
 
 The cache expires in 3 minutes.
 
-## Docker Images
+## Disabling rules with inline comments
+
+You can disable rule warnings on a specific line using line comments supported by common languages.
+
+For example, for Ruby:
+
+```rb
+# goodcheck-disable-next-line
+puts "Github"
+puts "Github" # goodcheck-disable-line
+```
+
+For JavaScript:
+
+```js
+// goodcheck-disable-next-line
+console.log("Github")
+console.log("Github") // goodcheck-disable-line
+```
 
-We provide Docker images of Goodcheck so that you can try Goodcheck without installing them.
+## Docker images
 
-- https://hub.docker.com/r/sider/goodcheck/
+We provide Docker images of Goodcheck on [Docker Hub](https://hub.docker.com/r/sider/goodcheck) so that you can try Goodcheck without installing them.
 
 ```bash
 $ docker pull sider/goodcheck
@@ -407,11 +464,11 @@ $ docker run -t --rm -v "$(pwd):/work" sider/goodcheck check
 ```
 
 The default `latest` tag points to the latest release of Goodcheck.
-You can pick a version of Goodcheck from [tags page](https://hub.docker.com/r/sider/goodcheck/tags).
+You can pick a version of Goodcheck from the [Docker Hub tags page](https://hub.docker.com/r/sider/goodcheck/tags).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
 
@@ -419,8 +476,10 @@ To release a new version, follows the steps below:
 
 1. Update the version number in [`version.rb`](lib/goodcheck/version.rb).
 2. Add the new version's entry to the [changelog](CHANGELOG.md).
-3. Commit the above changes like `git commit -m 'Version 1.2.3'`.
-4. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+3. Update the documentation via `bundle exec rake docs:update_version`.
+4. Commit the above changes like `git commit -m 'Version 1.2.3'`.
+5. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+6. Publish the updated documentation like `GIT_USER=some_user USE_SSH=true bundle exec rake docs:publish`.
 
 ## Contributing