Skip to content

House-keeping Improvements #792

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
InsertCreativityHere merged 3 commits into from
Jul 13, 2026
Merged

House-keeping Improvements #792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3914cb9
House-keeping improvements.
InsertCreativityHere Jul 10, 2026
cab765a
Linter fixes.
InsertCreativityHere Jul 10, 2026
c25612f
Fixed another lint in the tests.
InsertCreativityHere Jul 10, 2026
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
7 changes: 2 additions & 5 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ permissions:
contents: read

env:
WARNINGS_AS_ERRORS: yes

@InsertCreativityHere InsertCreativityHere Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This was apparently useless?
Maybe we had some custom logic using it in the past, but nothing in Rust checks or cares about this environment variable.

RUSTFLAGS: "-D warnings"
RUSTDOCFLAGS: "-D warnings"
CARGO_TERM_COLOR: always

jobs:
Expand All @@ -30,8 +31,6 @@ jobs:
run: cargo clippy --all-targets --no-deps -p slicec
- name: 📚 Generate Documentation
run: cargo doc --document-private-items --no-deps -p slicec
env:
RUSTDOCFLAGS: "-D warnings"
Comment on lines -33 to -34

@InsertCreativityHere InsertCreativityHere Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Better to set this for all jobs, instead of doing it for every single one.


slice-codec:
strategy:
Expand Down Expand Up @@ -64,8 +63,6 @@ jobs:
run: cargo clippy --all-targets --no-default-features $FEATURES --no-deps -p slice-codec
- name: 📚 Generate Documentation
run: cargo doc --document-private-items --no-deps --no-default-features $FEATURES -p slice-codec
env:
RUSTDOCFLAGS: "-D warnings"

format:
runs-on: ubuntu-latest
Expand Down
6 changes: 4 additions & 2 deletions .github/workflows/spellcheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
name: "Check spelling"

on:
pull_request:
push:
branches: ['main']
pull_request:
branches: ['main']

Comment on lines +5 to 8

@InsertCreativityHere InsertCreativityHere Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

For parity with our other workflow files.

permissions:
contents: read
Expand All @@ -15,4 +17,4 @@ jobs:
- uses: streetsidesoftware/cspell-action@v8
with:
files: |
**/*.{rs,md,json}
**/*.{rs,slice,md,json,yml,toml}

@InsertCreativityHere InsertCreativityHere Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Spell check everything!

4 changes: 0 additions & 4 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
# will have compiled files and executables
target/

# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
Cargo.lock
Comment on lines -5 to -7

@InsertCreativityHere InsertCreativityHere Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The Rust team has softened their stance about including the Cargo.lock file.
Including it gives us more reproducible builds but does some harm to the ecosystem since we won't be testing against the latest and greatest anymore.

By making sure to update our dependencies more often, this becomes a non-issue though.


# These are backup files generated by rustfmt
**/*.rs.bk

Expand Down
10 changes: 1 addition & 9 deletions .vscode/cspell.json
View file
Open in desktop

@InsertCreativityHere InsertCreativityHere Jul 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I went through and checked which of these words was actually still necessary, since we've pruned and removed alot of code from slicec after dropping Slice1 support.

Sure enough, many of them are no longer necessary.

Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,19 @@
"deduped",
"deque",
"downcasted",
"downcasting",
"encodable",
"grcov",
"Hashable",
"Hasher",
"icerpc",
"lalrpop",
"MSRV",
"nonoverlapping",
"nonterminal",
"peekable",
"repr",
"rfind",
"rsplit",
"RUSTDOCFLAGS",
"RUSTFLAGS",
"rustfmt",
"rustup",
"slicec",
Comment thread
InsertCreativityHere marked this conversation as resolved.
"structs",
"subtoken",
"subtokens",
"tokenizes",
"typealias",
"typeref",
Expand Down
Loading