Merge pull request #293 from sebastienrousseau/feat/ssg

feat(ssg): ✨ 0.0.30

.deepsource.toml

@@ -5,4 +5,4 @@ name = "rust"
 enabled = true
 
 [analyzers.meta]
-msrv = "stable"
+msrv = "stable"

.editorconfig

@@ -0,0 +1,29 @@
+# SPDX-License-Identifier: MIT
+
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+[*.rs]
+max_line_length = 80
+
+[*.md]
+# double whitespace at end of line
+# denotes a line break in Markdown
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.gitattributes

@@ -0,0 +1,9 @@
+# Auto detect text files and perform normalization
+*          text=auto eol=lf
+
+*.rs       text diff=rust eol=lf
+*.toml     text diff=toml eol=lf
+Cargo.lock text eol=lf
+
+*.sh       text eol=lf
+*.ps1      text eol=crlf

.github/CODE-OF-CONDUCT.md

@@ -1,62 +1,133 @@
-# Code of Conduct
+
+# Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-### Examples of Positive Behaviour
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
+Examples of unacceptable behavior include:
 
-### Examples of Unacceptable Behaviour
+* 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
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
-- The use of sexualized language or imagery and unwelcome sexual attention or advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as physical or electronic address, without explicit permission
-- Conduct which could reasonably be considered inappropriate in a professional setting
+## Enforcement Responsibilities
 
-## Our Responsibilities
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
-### Reporting
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
-Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at <[email protected]>.
+### 1. Correction
 
-### Procedures
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
-Upon receiving a report, the project team will review and investigate the allegations, taking the most appropriate action based on the severity of the issue, ranging from a warning to immediate removal from the project.
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
-### Appeal
+### 2. Warning
 
-If you disagree with a decision and wish to appeal, please contact [another entity or person on the project] who was not involved in the action you are appealing against to discuss your concerns.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
-### Conflicts of Interest
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
-In the event of any conflicts of interest in the enforcement of this code of conduct, the conflicted parties will recuse themselves from handling the report.
+### 3. Temporary Ban
 
-### Consequences
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
 
-Maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
 
-Updates
-Updates to this Code of Conduct will be announced via [Platform], so community members are always aware of any changes.
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the Contributor Covenant homepage,
-version 1.4, available at
-[version](http://contributor-covenant.org/version/1/4)
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

.github/workflows/coverage.yml

@@ -1,61 +1,32 @@
 name: 📶 Coverage
 
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-env:
-  CARGO_TERM_COLOR: always
+on: [push]
 
 jobs:
-  coverage:
-    name: Code Coverage
+  lint:
     runs-on: ubuntu-latest
-    env:
-      CARGO_INCREMENTAL: "0"
-      RUSTFLAGS: "-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests"
-      RUSTDOCFLAGS: "-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Cpanic=abort -Zpanic_abort_tests"
-
     steps:
-      # Checkout the repository
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      # Setup Rust nightly
       - name: Install Rust
         uses: actions-rs/toolchain@v1
-        id: toolchain
         with:
-          toolchain: nightly
+          toolchain: stable
           override: true
 
-      # Configure cache for Cargo
-      - name: Cache Cargo registry, index
-        uses: actions/cache@v4
-        id: cache-cargo
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/bin
-            ~/.cargo/git
-          key: linux-${{ steps.toolchain.outputs.rustc_hash }}-rust-cov-${{ hashFiles('**/Cargo.lock') }}
-
-      # Run tests with all features
-      - name: Test (cargo test)
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: "--workspace"
+      - name: Install Cargo Tarpaulin
+        run: cargo install cargo-tarpaulin
 
-      # Install grcov
-      - uses: actions-rs/[email protected]
-        id: coverage
+      - name: Run tests with coverage
+        run: cargo tarpaulin --out Lcov --all-features --no-fail-fast
+        env:
+          CARGO_INCREMENTAL: '0'
+          RUSTFLAGS: '-Ccodegen-units=1 -Clink-dead-code -Coverflow-checks=off'
+          RUSTDOCFLAGS: ''
 
-      # Upload to Codecov.io
-      - name: Upload to Codecov.io
+      - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
-          file: ${{ steps.coverage.outputs.report }}
+          file: lcov.info

.gitignore

@@ -2,12 +2,14 @@
 *.profraw
 *.log
 /.vscode/
+/backup_dir/
 /docs/
 /examples/public/
 /mysite/
 /output/
 /pdfs/
 /public/
+/serve/
 /target/
 build
 Icon?

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to `shokunin`
+# Contributing to `Shokunin Static Site Generator (SSG)`
 
-Welcome! We're thrilled that you're interested in contributing to the `shokunin` library. Whether you're looking to evangelize, submit feedback, or contribute code, we appreciate your involvement in making `shokunin` a better tool for everyone. Here's how you can get started.
+Welcome! We're thrilled that you're interested in contributing to the `Shokunin Static Site Generator (SSG)` library. Whether you're looking to evangelize, submit feedback, or contribute code, we appreciate your involvement in making `Shokunin Static Site Generator (SSG)` a better tool for everyone. Here's how you can get started.
 
 ## Evangelize