chore(taplo): add .taplo.toml, standardize the terminology in the documentation, and optimize the paths in the CI (#346)

Signed-off-by: Shigure Kurosaki <[email protected]>

Author: kurosakishigure

.github/CODE-OF-CONDUCT.md

@@ -23,7 +23,7 @@ Examples of unacceptable behavior include:
 - The use of sexualized language or imagery, and sexual attention or advances of any kind.
 - Trolling, insulting or derogatory comments, and personal or political attacks.
 - Public or private harassment.
-- Publishing others’ private information, such as a physical or email address, without their explicit permission.
+- Publishing others' private information, such as a physical or email address, without their explicit permission.
 - Other conduct which could reasonably be considered inappropriate in a professional setting.
 
 ## Enforcement Responsibilities

.github/workflows/ci.yml

@@ -7,10 +7,10 @@ on:
       - 'src/**'
       - 'tests/**'
       - 'examples/nextjs/.next/server/app/articles/*.html'
+      - '.config/ast-grep/**/*.yml'
       - 'Cargo.toml'
       - 'Cargo.lock'
       - '.rustfmt.toml'
-      - '.config/ast-grep/**/*.yml'
       - 'sgconfig.yml'
       - '.editorconfig'
 jobs:

.github/workflows/md-analyzer.yml

@@ -5,12 +5,12 @@ on:
       - '.github/**/*.md'
       - 'examples/**/README.md'
       - 'README.md'
+      - '.config/vale/styles/**/*.yml'
+      - '.config/vale/styles/config/vocabularies/**/*.txt'
       - '.prettierrc.toml'
       - '.markdownlint.yml'
       - '.markdownlint-cli2.yaml'
       - '.vale.ini'
-      - '.config/vale/styles/**/*.yml'
-      - '.config/vale/styles/config/vocabularies/**/*.txt'
       - '.editorconfig'
 jobs:
   alex:

.github/workflows/toml-analyzer.yml

@@ -2,16 +2,10 @@ name: TOML Analyzer
 on:
   pull_request:
     paths:
+      - '*.toml'
       - 'examples/**/katharsis.config.toml'
       - 'src/cmd/katharsis.config.toml'
       - 'tests/katharsis.config.toml'
-      - '.prettierrc.toml'
-      - 'Cargo.toml'
-      - 'deny.toml'
-      - 'rust-toolchain.toml'
-      - '.rustfmt.toml'
-      - '.editorconfig'
-      - '.typos.toml'
 jobs:
   taplo:
     name: taplo
@@ -28,8 +22,8 @@ jobs:
       - name: Run taplo fmt
         run: |
           shopt -s globstar
-          taplo fmt examples/**/katharsis.config.toml src/cmd/katharsis.config.toml tests/katharsis.config.toml .prettierrc.toml Cargo.toml deny.toml rust-toolchain.toml .rustfmt.toml --check
+          taplo fmt --check
       - name: Run taplo check
         run: |
           shopt -s globstar
-          taplo check examples/**/katharsis.config.toml src/cmd/katharsis.config.toml tests/katharsis.config.toml .prettierrc.toml Cargo.toml deny.toml rust-toolchain.toml .rustfmt.toml
+          taplo check

.github/workflows/typos.yml

@@ -2,10 +2,10 @@ name: Typos
 on:
   pull_request:
     paths:
-      - '.typos.toml'
       - 'etc/**'
       - 'src/**'
       - 'tests/**'
+      - '.typos.toml'
 jobs:
   typos:
     runs-on: ubuntu-latest

.github/workflows/yaml-analyzer.yml

@@ -2,11 +2,9 @@ name: YAML Analyzer
 on:
   pull_request:
     paths:
+      - '*.yml'
       - '.github/**/*.yml'
       - '.config/**/*.yml'
-      - 'sgconfig.yml'
-      - '.yamllint.yml'
-      - '.markdownlint.yml'
       - '.prettierrc.toml'
       - '.markdownlint-cli2.yaml'
       - '.editorconfig'

.taplo.toml

@@ -0,0 +1,10 @@
+include = [
+  "*.toml",
+  "examples/**/katharsis.config.toml",
+  "src/cmd/katharsis.config.toml",
+  "tests/katharsis.config.toml",
+]
+
+[formatting]
+align_comments = false
+allowed_blank_lines = 1

README.md

@@ -109,7 +109,7 @@ Run the following command to create a default `rss.xml`:
 katharsis
 ```
 
-## Overview
+## General
 
 ### Commands
 
@@ -118,22 +118,22 @@ katharsis
 | init    | Generates a `katharsis.config.toml` file in the current directory. |
 | help    | Displays help information.                                         |
 
-### Parameters
+### Arguments
 
-| Parameter | Description                                             |
-| --------- | ------------------------------------------------------- |
-| -c        | Specifies a `katharsis.config.toml` file as the config. |
-| -h        | Displays help information.                              |
-| -V        | Displays the current version of Katharsis.              |
+| Argument | Description                                             |
+| -------- | ------------------------------------------------------- |
+| -c       | Specifies a `katharsis.config.toml` file as the config. |
+| -h       | Displays help information.                              |
+| -V       | Displays the current version of Katharsis.              |
 
 > [!NOTE]
-> If you do not specify the `-c` parameter, the `katharsis.config.toml` file in the current directory will be used by default.
+> If you do not specify the `-c` argument, the `katharsis.config.toml` file in the current directory will be used by default.
 
-### Fields
+### Properties
 
 You can refer to the [RSS 2.0 at Harvard Law](https://cyber.harvard.edu/rss/rss.html) for more detailed documentation.
 
-| Field           | Description                        |
+| Property        | Description                        |
 | --------------- | ---------------------------------- |
 | rss.title       | The title of the website.          |
 | rss.description | A description of the website.      |
@@ -145,11 +145,11 @@ You can refer to the [RSS 2.0 at Harvard Law](https://cyber.harvard.edu/rss/rss.
 
 > [!NOTE]
 >
-> - The `rss.site_url` field should not include a trailing slash (for example, `https://example.com` rather than `https://example.com/`).
-> - The `rss.image` field is relative to the `rss.site_url`, for example, `favicon.png` corresponds to `https://example.com/favicon.png`.
-> - The `rss.output` field specifies the path relative to the working directory (for example, `rss.xml` corresponds to `./rss.xml`).
+> - The `rss.site_url` property should not include a trailing slash (for example, `https://example.com` rather than `https://example.com/`).
+> - The `rss.image` property is relative to the `rss.site_url`, for example, `favicon.png` corresponds to `https://example.com/favicon.png`.
+> - The `rss.output` property specifies the path relative to the working directory (for example, `rss.xml` corresponds to `./rss.xml`).
 
-| Field               | Description                                                |
+| Property            | Description                                                |
 | ------------------- | ---------------------------------------------------------- |
 | article.title       | The tag containing the article's title.                    |
 | article.description | The tag or attribute containing the article's description. |
@@ -163,9 +163,9 @@ You can refer to the [RSS 2.0 at Harvard Law](https://cyber.harvard.edu/rss/rss.
 
 > [!NOTE]
 >
-> - The `article.input` field corresponds to the file stem (`*`), which is the same as the article's URL slug.
-> - The `article.date` field's tag must include a [datetime](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/time) attribute, and the attribute value must follow the `%Y-%m-%d` format.
-> - The `article.image` field’s folder name (`**`) must match the article's URL slug.
+> - The `article.input` property corresponds to the file stem (`*`), which is the same as the article's URL slug.
+> - The `article.date` property's tag must include a [datetime](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/time) attribute, and the attribute value must follow the `%Y-%m-%d` format.
+> - The `article.image` property's folder name (`**`) must match the article's URL slug.
 
 ## API Docs
 

examples/nextjs/katharsis.config.toml

@@ -1,4 +1,4 @@
-# Fields Overview: https://github.com/arghena/katharsis/blob/canary/README.md#fields
+# Documentation: https://github.com/arghena/katharsis/blob/canary/README.md#properties
 
 [rss]
 title = "The React Framework for the Web"

src/arg/handle.rs

@@ -160,7 +160,7 @@ fn channel_builder(rss: Rss, items: Vec<Item>) -> Channel {
         .build()
 }
 
-/// Build the RSS feed based on the fields in the config file, and return the parsed [`Channel`].
+/// Build the RSS feed based on the properties in the config file, and return the parsed [`Channel`].
 ///
 /// # Examples
 ///
@@ -181,7 +181,7 @@ fn channel_builder(rss: Rss, items: Vec<Item>) -> Channel {
 ///
 /// # Errors
 ///
-/// - When the file’s existence cannot be verified.
+/// - When the file's existence cannot be verified.
 /// - When the file does not exist.
 /// - When the file cannot be read.
 /// - When the TOML file cannot be deserialized.