chore(lib): fully refactor the library for v3

.github/dependabot.yml

@@ -9,7 +9,6 @@ updates:
   labels:
   - dependencies
   - rust
-  target-branch: 'v3'  # TODO: change me after merging v3
 - package-ecosystem: github-actions
   directory: /
   schedule:
@@ -19,4 +18,3 @@ updates:
   labels:
   - ci
   - dependencies
-  target-branch: 'v3'  # TODO: change me after merging v3

.github/pull_request_template.md

@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD025 -->
 <!-- If your PR fixes an open issue, use `Closes #999` to link your PR
 with the issue. #999 stands for the issue number you are fixing -->
 

.github/workflows/changelog.yml

@@ -8,8 +8,8 @@ on:
 jobs:
   check-changelog:
     name: Check Changelog Action
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-    - uses: tarides/changelog-check-action@v2
+    - uses: tarides/changelog-check-action@v3
       with:
         changelog: CHANGELOG.md

.github/workflows/coverage.yml

@@ -1,22 +1,44 @@
 name: Code Coverage
 
-on: [push]
+on:
+  push:
+    branches:
+    - main
+  pull_request:
 jobs:
   test:
     name: Coverage
     runs-on: ubuntu-latest
-    container:
-      image: xd009642/tarpaulin:develop-nightly
-      options: --security-opt seccomp=unconfined
+    services:
+      languagetool:
+        image: erikvl87/languagetool:latest
+        ports:
+        - 8010:8010
+        env:
+          langtool_maxTextLength: 1500
+          Java_Xmx: 2g
+    env:
+      LANGUAGETOOL_HOSTNAME: http://localhost
+      LANGUAGETOOL_PORT: 8010
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
+
+    - name: Install nightly toolchain
+      uses: dtolnay/rust-toolchain@nightly
+
+    - name: Cache dependencies
+      uses: Swatinem/rust-cache@v2
+
+    - name: Install cargo-tarpaulin
+      uses: taiki-e/install-action@cargo-tarpaulin
 
     - name: Generate code coverage
       run: |
         cargo +nightly tarpaulin --verbose --all-features --workspace --timeout 120 --out Xml
 
     - name: Upload to codecov.io
-      uses: codecov/codecov-action@v2
+      uses: codecov/codecov-action@v5
       with:
+        token: ${{ secrets.CODECOV_TOKEN }}
         fail_ci_if_error: true

.github/workflows/languagetool.yml

@@ -1,18 +1,20 @@
+name: LanguageTool
+
 on:
   pull_request:
-    path: |
-      "README.md"
   workflow_dispatch:
 
-name: LanguageTool check
-
 jobs:
   languagetool_check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: reviewdog/action-languagetool@v1
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Check and report
+      uses: reviewdog/action-languagetool@v1
       with:
         reporter: github-pr-review
-        patterns: README.md
+        patterns: '*.md src/**.rs'
         level: warning
+        disabled_rules: WHITESPACE_RULE,EN_UNPAIRED_QUOTES,EN_QUOTES,DASH_RULE,WORD_CONTAINS_UNDERSCORE,UPPERCASE_SENTENCE_START,ARROWS,COMMA_PARENTHESIS_WHITESPACE,UNLIKELY_OPENING_PUNCTUATION,SENTENCE_WHITESPACE,CURRENCY,EN_UNPAIRED_BRACKETS,PHRASE_REPETITION,PUNCTUATION_PARAGRAPH_END,METRIC_UNITS_EN_US,ENGLISH_WORD_REPEAT_BEGINNING_RULE

.github/workflows/lint.yml

@@ -0,0 +1,54 @@
+# Lint code and (optionally) apply fixes
+name: Lint code
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+  schedule:
+  - cron: 0 0 * * 1 # Every monday
+  workflow_dispatch:
+
+jobs:
+  auto-update:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'schedule' || github.event_name == 'workflow_dispatch' }}
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install pre-commit
+      run: pip install pre-commit
+
+    - name: Run autoupdate
+      run: pre-commit autoupdate
+
+    - name: Create a pull request with updated versions
+      uses: peter-evans/create-pull-request@v6
+      with:
+        branch: update/pre-commit-hooks
+        title: 'chore(deps): update pre-commit hooks'
+        commit-message: 'chore(deps): update pre-commit hooks'
+  pre-commit:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'schedule' }}
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Install Rust nightly
+      uses: dtolnay/rust-toolchain@nightly
+      with:
+        components: clippy,rustfmt
+
+    - name: Run pre-commit hooks
+      uses: pre-commit/action@v3.0.1
+
+    - name: Apply fixes when present
+      uses: pre-commit-ci/lite-action@v1.1.0
+      if: always()
+      with:
+        msg: 'chore(fmt): auto fixes from pre-commit hooks'

.github/workflows/CI.yml → .github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/v')
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Install stable toolchain
       uses: actions-rs/toolchain@v1
@@ -24,16 +24,15 @@ jobs:
         toolchain: stable
         override: true
 
-    - run: cargo publish --features full --token ${CRATES_TOKEN}
-      env:
-        CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
+    - name: Publish on crates.io
+      run: cargo publish --features full --token ${{ secrets.CRATES_TOKEN }}
   check-publish:
     name: Check Publish
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/v') != true
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Install stable toolchain
       uses: actions-rs/toolchain@v1
@@ -42,6 +41,5 @@ jobs:
         toolchain: stable
         override: true
 
-    - run: cargo publish --features cli --token ${CRATES_TOKEN} --dry-run -v
-      env:
-        CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
+    - name: Check if can publish on crates.io
+      run: cargo publish --features cli --token ${{ secrets.CRATES_TOKEN }} --dry-run -v

.github/workflows/release.yml

@@ -73,7 +73,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
     - name: Install Rust
       uses: actions-rs/toolchain@v1
       with:

.github/workflows/rustbench.yml

@@ -28,10 +28,10 @@ jobs:
       LANGUAGETOOL_HOSTNAME: http://localhost
       LANGUAGETOOL_PORT: 8010
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Setup rust toolchain, cache and cargo-codspeed binary
-      uses: moonrepo/setup-rust@v0
+      uses: moonrepo/setup-rust@v1
       with:
         channel: stable
         cache-target: release

.github/workflows/rustcheck.yml

@@ -11,6 +11,14 @@ jobs:
   cargo_check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: taiki-e/install-action@cargo-hack
-    - run: cargo hack check --feature-powerset --no-dev-deps
+    - run: >
+        cargo hack check
+        --feature-powerset
+        --no-dev-deps
+        --clean-per-run
+        --group-features cli-complete,docker
+        --group-features typst,html,markdown
+        --mutually-exclusive-features native-tls,native-tls-vendored
+        --exclude-features snapshots

.github/workflows/rustdoc.yml

@@ -1,7 +1,7 @@
 on:
   pull_request:
     paths:
-    - src/lib/**.rs
+    - src/**.rs
     - Cargo.toml
   workflow_dispatch:
 
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install nightly toolchain
       uses: dtolnay/rust-toolchain@nightly

.github/workflows/rustlib.yml

@@ -1,7 +1,7 @@
 on:
   pull_request:
     paths:
-    - src/lib/**.rs
+    - '**.rs'
     - .github/workflows/rustlib.yml
     - Cargo.toml
   workflow_dispatch:
@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install nightly toolchain
       uses: dtolnay/rust-toolchain@nightly
@@ -30,19 +30,25 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        tag: [latest, '5.5', '5.6', '5.7', '5.8', '5.9', '6.0', '6.1']
+        tag: [latest, '5.5', '5.6', '5.7', '5.8', '5.9', '6.0', '6.1', '6.2', '6.3', '6.4', '6.5']
+        features: ['']
+        include:
+        - tag: latest
+          features: --all-features
     runs-on: ubuntu-latest
     services:
       languagetool:
         image: erikvl87/languagetool:${{ matrix.tag }}
         ports:
         - 8010:8010
+        env:
+          langtool_maxTextLength: 1500
     env:
       LANGUAGETOOL_HOSTNAME: http://localhost
       LANGUAGETOOL_PORT: 8010
     steps:
     - name: Checkout sources
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Install stable toolchain
       uses: dtolnay/rust-toolchain@stable
@@ -51,4 +57,4 @@ jobs:
       uses: Swatinem/rust-cache@v2
 
     - run: curl -LsSf https://get.nexte.st/latest/linux | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
-    - run: cargo nextest run --all-features
+    - run: cargo nextest run ${{ matrix.features }} --no-capture

.github/workflows/rustmsrv.yml

@@ -11,7 +11,7 @@ jobs:
   msrv_check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Install stable toolchain
       uses: dtolnay/rust-toolchain@stable
@@ -25,3 +25,7 @@ jobs:
 
     - name: Check MSRV
       run: cargo msrv verify -- cargo check --all-features
+
+    - name: Find MSRV if above fail
+      if: failure()
+      run: cargo msrv find -- cargo check --all-features