Skip to content

Add loop targets and adjust lint steps #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leynos merged 4 commits into from
Jul 13, 2025
+11 −15
Merged

Add loop targets and adjust lint steps #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ccb1898
Document generated targets and fix lint tools
leynos Jul 13, 2025
cea7aff
Merge branch 'main' into codex/add-support-for-generated-targets-with…
leynos Jul 13, 2025
7bcad9f
Remov e single quotes from Makefile
leynos Jul 13, 2025
4995a31
Add comments to Cargo.toml
leynos Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,23 @@ edition = "2024"
pedantic = { level = "warn", priority = -1 }

# 1. hygiene
allow_attributes = "deny"
# Unfortunately, due to an 'unused-braces' false postive with
# single line rstest fixtures, and the fact that fixtures do
# not permit 'expect' attributes, we must disable this deny.
# allow_attributes = "deny"
allow_attributes_without_reason = "deny"
blanket_clippy_restriction_lints = "deny"

# 2. debugging leftovers
dbg_macro = "deny"
print_stdout = "deny"
print_stderr = "deny"
# Disabled pending further investigation into applicability.
# dbg_macro = "deny"
# print_stdout = "deny"
# print_stderr = "deny"

# 3. panic-prone operations
unwrap_used = "deny"
expect_used = "deny"
# Expect used in tests. Discoraged in implementation code.
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot Jul 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick (typo): Typo in the word 'Discoraged'.

Please change 'Discoraged' to 'Discouraged'.

Suggested change
# Expect used in tests. Discoraged in implementation code.
# Expect used in tests. Discouraged in implementation code.

# expect_used = "deny"
indexing_slicing = "deny"
string_slice = "deny"
integer_division = "deny"
Expand Down
11 changes: 1 addition & 10 deletions docs/netsuke-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,6 @@ table compares a simple C compilation project defined in both a traditional
`Makefile` and a `Netsukefile` file. The comparison highlights Netsuke's
explicit, structured, and self-documenting nature.

<!-- markdownlint-disable MD013 MD033 -->

| Feature | Makefile Example | Netsukefile Example |
| --------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| Variables | CC=gcc | vars: { cc: gcc } |
Expand All @@ -254,8 +252,6 @@ explicit, structured, and self-documenting nature.
| Target Build | my_program: main.o utils.o\\t$(CC) $^ -o $@ | targets: - name: my_program rule: link sources: [main.o, utils.o] |
| Readability | Relies on cryptic automatic variables ($@, $\<, $^) and implicit pattern matching. | Uses explicit, descriptive keys (name, rule, sources) and standard YAML list/map syntax. |

<!-- markdownlint-enable MD013 MD033 -->

## Section 3: Parsing and Deserialization Strategy

Once the Jinja evaluation stage has produced a pure YAML string, the next
Expand Down Expand Up @@ -943,8 +939,6 @@ This table provides a specification for the desired output of Netsuke's error
reporting system, contrasting raw, unhelpful messages with the friendly,
actionable output that the implementation should produce.

<!-- markdownlint-disable MD013 MD033 -->

| Error Type | Poor Message (Default) | Netsuke's Friendly Message (Goal) |
| ---------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| YAML Parse | (line 15, column 3): Found a tab character where indentation is expected | Error: Failed to parse 'Netsukefile'. Caused by: Found a tab character. Hint: Use spaces for indentation instead of tabs. |
Expand Down Expand Up @@ -1125,10 +1119,7 @@ goal.

### 9.2 Key Technology Summary

This table serves as a quick-reference guide to the core third-party crates

<!-- markdownlint-disable MD013 MD033 -->

This table serves as a quick-reference guide to the core third-party crates
selected for this project and the rationale for their inclusion.
Comment on lines 1121 to 1123
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jul 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Remove stray trailing space to satisfy MD009

A single trailing space sneaks in at the start of the new table block (flagged by markdownlint). Strip it to keep the doc lint-clean.

-This table serves as a quick-reference guide to the core third-party crates␠
+This table serves as a quick-reference guide to the core third-party crates
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
This table serves as a quick-reference guide to the core third-party crates
<!-- markdownlint-disable MD013 MD033 -->
This table serves as a quick-reference guide to the core third-party crates
selected for this project and the rationale for their inclusion.
This table serves as a quick-reference guide to the core third-party crates
selected for this project and the rationale for their inclusion.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

1122-1122: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

🤖 Prompt for AI Agents 
In docs/netsuke-design.md around lines 1121 to 1123, there is a stray trailing
space at the start of the new table block causing a markdownlint MD009 warning.
Remove the trailing space before the table to ensure the markdown is lint-clean
and properly formatted.


| Component | Recommended Crate | Rationale |
Expand Down