Merge pull request #1011 from ninoseki/v7.1.3

V7.1.3
ninoseki · Jan 13, 2024 · 61a293f · 61a293f
2 parents 1f8b6da + 016d597
commit 61a293f
Show file tree

Hide file tree

Showing 7 changed files with 233 additions and 213 deletions.
diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml
@@ -34,6 +34,25 @@ jobs:
         run: npm install
       - name: Run tests
         run: npm run test:unit -- --run
+  lint:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./frontend
+    strategy:
+      matrix:
+        node-version:
+          - 20
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+          cache-dependency-path: frontend/package-lock.json
+      - name: Install npm dependencies
+        run: npm install
       - name: Run type-check
         run: npm run type-check
       - name: Run ESLint

diff --git a/docs/archtecture.md b/docs/archtecture.md
@@ -2,10 +2,10 @@
 
 Mihari uses following components:
 
-- [rails/thor](https://github.com/rails/thor) for building the CLI application
-- [ruby-grape/grape](https://github.com/ruby-grape/grape), [rack/rack](https://github.com/rack/rack) and [puma/puma](https://github.com/puma/puma) for building and running the web application
-- [sidekiq/sidekiq](https://github.com/sidekiq/sidekiq) for (optional) background processing
-- [vuejs](https://github.com/vuejs/) for building the frontend SPA
+- [rails/thor](https://github.com/rails/thor) for building the CLI application.
+- [ruby-grape/grape](https://github.com/ruby-grape/grape), [rack/rack](https://github.com/rack/rack) and [puma/puma](https://github.com/puma/puma) for building and running the web application.
+- [sidekiq/sidekiq](https://github.com/sidekiq/sidekiq) for (optional) background processing.
+- [vuejs](https://github.com/vuejs/) for building the frontend SPA.
 
 ## Basic
 

diff --git a/docs/diagrams.md b/docs/diagrams.md
@@ -1,6 +1,6 @@
 # Diagrams
 
-## ActiveModel Class Diagram
+## Active Record Class Diagram
 
 ```mermaid
 classDiagram

diff --git a/docs/usage.md b/docs/usage.md
@@ -125,26 +125,27 @@ Usage:
   mihari web
 
 Options:
-      [--port=N]                   # Hostname to listen on
+      [--port=N]                   # Port to listen on
                                    # Default: 9292
-      [--host=HOST]                # Port to listen on
+      [--host=HOST]                # Hostname to listen on
                                    # Default: localhost
       [--threads=THREADS]          # min:max threads to use
                                    # Default: 0:5
-      [--verbose], [--no-verbose]  # Report each request
-                                   # Default: true
+      [--verbose], [--no-verbose]  # Don't report each request
+                                   # Default: false
       [--worker-timeout=N]         # Worker timeout value (in seconds)
                                    # Default: 60
       [--open], [--no-open]        # Whether to open the app in browser or not
                                    # Default: true
       [--env=ENV]                  # Environment
                                    # Default: production
+  -d, [--debug], [--no-debug]      # Set up debug mode
 ```
 
 !!! tip
 
     The built-in web app offers API to interact with Mihari.
-    The API docs are available on `/redoc-static.html`
+    The API docs are available on `/redoc-static.html`.
 
 ### `mihari sidekiq`
 
@@ -170,7 +171,7 @@ Mihari provides listing/search feature via CLI & API.
 
 Search query supports `AND`, `OR`, `:`, `=`, `!=`, `<`, `<=`, `>`, `>=`, `NOT` and `()`.
 
-Searchable fields are
+Searchable fields are:
 
 | Type       | Searchable fields                                                                                                                                                                                                            |
 | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |