Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ These instructions guide GitHub Copilot to generate code that aligns with our pr
///
/// # Examples
/// ```
/// use pkcore::your_module::YourFunction;
/// use pkcore::your_module::YourStruct;
/// let result = your_function(42);
/// assert_eq!(result, expected_value);
/// ```
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ jobs:
rust: [beta, stable, 1.85.0]
include:
- rust: nightly
rustflags: --cfg thiserror_nightly_testing
timeout-minutes: 45
steps:
- uses: actions/checkout@v6
Expand Down
6 changes: 1 addition & 5 deletions .github/workflows/audit.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
name: Security audit
on:
schedule: # Every Sunday at 1 AM
schedule: # Every Sunday at 1 AM
- cron: '0 1 * * 0'
push:
paths:
- '**/Cargo.toml'
- '**/Cargo.lock'

jobs:
security_audit:
Expand Down
246 changes: 45 additions & 201 deletions .rustfmt.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,47 +2,35 @@
# r u s t f m t - C O N F I G
# ==================================================================================
#
# Version: 0.7.1
# Author : Robbepop <robbepop@web.de>
# Original: Robbepop <robbepop@web.de>
# Updated to remove options no longer supported by rustfmt stable (1.9.0+).
#
# A predefined .rustfmt.toml file with all configuration options and their
# associated description, possible values and default values for use in other
# projects.
#
# This should actually automatically be shipped with cargo fmt or rustfmt itself!
# Only `max_width = 100` is active. Uncomment others to customize.
# Run `rustfmt --print-config=default <any-file.rs>` to see all current defaults.
# ----------------------------------------------------------------------------------

# Use verbose output.
# Default: false
# verbose =

# Do not reformat out of line modules.
# Default: false
# skip_children =

# Lines to format; this is not supported in rustfmt.toml,
# and can only be specified via the --file-lines option.
# file_lines =

# Maximum width of each line.
# Default: 100
# max_width =

# Ideal width of each line.
# Default: 80
max_width = 100

# Number of spaces per tab.
# Default: 4
# tab_spaces =
# tab_spaces =

# Maximum width of the args of a function call before
# falling back to vertical formatting.
# Use tab characters for indentation, spaces for alignment.
# Default: false
# hard_tabs =

# Maximum width of the args of a function call before falling back to vertical formatting.
# Default: 60
# fn_call_width =

# Maximum width in the body of a struct lit before falling back to vertical formatting.
# Default: 16
# Maximum width in the body of a struct literal before falling back to vertical formatting.
# Default: 18
# struct_lit_width =

# Maximum width in the body of a struct variant before falling back to vertical formatting.
Expand All @@ -54,171 +42,68 @@ max_width = 100
# force_explicit_abi =

# Unix or Windows line endings.
# Values: Windows | Unix | Native
# Default: Unix
# Values: Auto | Windows | Unix | Native
# Default: Auto
# newline_style =

# Brace style for functions.
# Brace style for functions, structs, and enums.
# (Previously split into fn_brace_style and item_brace_style.)
# Values: AlwaysNextLine | PreferSameLine | SameLineWhere
# Default: SameLineWhere
# fn_brace_style =
# brace_style =

# Brace style for structs and enums.
# Values: AlwaysNextLine | PreferSameLine | SameLineWhere
# Default: SameLineWhere
# item_brace_style =

# Brace style for control flow construct.
# Brace style for control flow constructs.
# Values: AlwaysSameLine | ClosingNextLine | AlwaysNextLine
# Default: AlwaysSameLine
# control_brace_style =

# Put empty-body implementations on a single line.
# Put empty-body implementations and functions on a single line.
# (Previously impl_empty_single_line / fn_empty_single_line.)
# Default: true
# impl_empty_single_line =

# Put empty-body functions on a single line.
# Default: true
# fn fn_empty_single_line =
# empty_item_single_line =

# Put single-expression functions on a single line.
# Default: false
# fn_single_line =

# Location of return type in function declaration.
# Values: WithArgs | WithWhereClause
# Default: WithArgs
# fn_return_indent =

# If function argument parenthesis goes on a newline.
# Default: true
# fn_args_paren_newline =

# Argument density in functions.
# Values: Compressed | Tall | CompressedIfEmpty | Vertical
# Layout of function parameters.
# (Previously fn_args_layout / fn_args_density.)
# Values: Compressed | Tall | Vertical
# Default: Tall
# fn_args_density =

# Layout of function arguments.
# Values: Visual | Block | BlockAlways
# Default: Visual
# fn_args_layout =

# Indent on function arguments.
# Values: Inherit | Tabbed | Visual
# Default: Visual
# fn_arg_indent =
# fn_params_layout =

# Determines if '+' or '=' are wrapped in spaces in the punctuation of types.
# Values: Compressed | Wide
# Default: Wide
# type_punctuation_density =

# Density of a where clause.
# Values: Compressed | Tall | CompressedIfEmpty | Vertical
# Default: CompressedIfEmpty
# where_density =

# Indentation of a where clause.
# Values: Inherit | Tabbed | Visual
# Default: Tabbed
# where_indent =

# Element layout inside a where clause.
# Values: Vertical | Horizontal | HorizontalVertical | Mixed
# Default: Vertical
# where_layout =

# Indentation style of a where predicate.
# Values: Inherit | Tabbed | Visual
# Default: Visual
# where_pred_indent =

# Put a trailing comma on where clauses.
# Default: false
# where_trailing_comma =

# Indentation of generics.
# Values: Inherit | Tabbed | Visual
# Default: Visual
# generics_indent =

# If there is a trailing comma on structs.
# Trailing comma behavior for structs, enums, and struct literals.
# (Previously struct_trailing_comma / struct_lit_trailing_comma / enum_trailing_comma.)
# Values: Always | Never | Vertical
# Default: Vertical
# struct_trailing_comma =
# trailing_comma =

# If there is a trailing comma on literal structs.
# Values: Always | Never | Vertical
# Default: Vertical
# struct_lit_trailing_comma =

# Style of struct definition.
# Values: Visual | Block
# Default: Block
# struct_lit_style =

# Multiline style on literal structs.
# Values: PreferSingle | ForceMulti
# Default: PreferSingle
# struct_lit_multiline_style =

# Put a trailing comma on enum declarations.
# Default: true
# enum_trailing_comma =

# Report all, none or unnumbered occurrences of TODO in source file comments.
# Values: Always | Unnumbered | Never
# Default: Never
# report_todo =

# Report all, none or unnumbered occurrences of FIXME in source file comments.
# Values: Always | Unnumbered | Never
# Default: Never
# report_fixme =

# Indent on chain base.
# Values: Inherit | Tabbed | Visual
# Default: Tabbed
# chain_base_indent =

# Indentation of chain.
# Values: Inherit | Tabbed | Visual
# Default: Tabbed
# chain_indent =
# Put a trailing comma after a block based match arm.
# Default: false
# match_block_trailing_comma =

# Allow last call in method chain to break the line.
# Wrap multiline match arms in blocks.
# (Previously wrap_match_arms.)
# Default: true
# chains_overflow_last =
# match_arm_blocks =

# Reorder import statements alphabetically.
# Default: false
# Default: true
# reorder_imports =

# Reorder lists of names in import statements alphabetically.
# Default: false
# reorder_imported_names =

# Maximum line length for single line if-else expressions.
# A value of zero means always break if-else expressions.
# Default: 50
# single_line_if_else_max_width =

# Format string literals where necessary.
# Default: true
# format_strings =

# Always format string literals.
# Default: false
# force_format_strings =

# Retain some formatting characteristics from the source code.
# Default: true
# take_source_hints =

# Use tab characters for indentation, spaces for alignment.
# Default: false
# hard_tabs =
# format_strings =

# Break comments to fit on the line.
# Default: false
Expand All @@ -228,65 +113,24 @@ max_width = 100
# Default: false
# normalize_comments =

# Wrap multiline match arms in blocks.
# Default: true
# wrap_match_arms =

# Put a trailing comma after a block based match arm (non-block arms are not affected).
# Default: false
# match_block_trailing_comma =

# Put a trailing comma after a wildcard arm.
# Default: true
# match_wildcard_trailing_comma =

# How many lines a closure must have before it is block indented.
# -1 means never use block indent.
# Type: <signed integer>
# Default: 5
# closure_block_indent_threshold =

# Leave a space before the colon in a type annotation.
# Default: false
# space_before_type_annotation =

# Leave a space after the colon in a type annotation.
# Default: true
# space_after_type_annotation_colon =

# Leave a space before the colon in a trait or lifetime bound.
# Default: false
# space_before_bound =

# Leave a space after the colon in a trait or lifetime bound.
# Default: true
# space_after_bound_colon =

# Put spaces around the .. and ... range operators.
# Put spaces around the .. and ... range operators.
# Default: false
# spaces_around_ranges =

# Put spaces within non-empty generic arguments.
# Leave a space before the colon in type annotations and trait/lifetime bounds.
# (Previously space_before_type_annotation / space_before_bound.)
# Default: false
# spaces_within_angle_brackets =
# space_before_colon =

# Put spaces within non-empty square brackets.
# Default: false
# spaces_within_square_brackets =

# Put spaces within non-empty parentheses.
# Default: false
# spaces_within_parens =
# Leave a space after the colon in type annotations and trait/lifetime bounds.
# (Previously space_after_type_annotation_colon / space_after_bound_colon.)
# Default: true
# space_after_colon =

# Replace uses of the try! macro by the ? shorthand.
# Default: false
# use_try_shorthand =

# What Write Mode to use when none is supplied: Replace, Overwrite, Display, Diff, Coverage.
# Values: Replace | Overwrite | Display | Diff | Coverage | Plain | Checkstyle
# Default: Replace
# write_mode =

# Replace strings of _ wildcards by a single .. in tuple patterns.
# Default: false
# condense_wildcard_suffices =
# condense_wildcard_suffixes =
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ help:
@echo " make docs - Create docs and open in browser (macOS/Linux)"
@echo ""
@echo "Tooling:"
@echo " make install-tools - Install cargo-deny and cargo-udeps"
@echo " make install-tools - Install cargo-deny, cargo-udeps, and cargo-watch"
@echo " make watch - Run check/test in watch mode"
@echo " make install-watch - Install cargo-watch"
@echo ""
Expand Down Expand Up @@ -117,6 +117,7 @@ install-tools:
@echo "Installing development tools..."
cargo install cargo-deny
cargo install cargo-udeps
cargo install cargo-watch
@echo ""
@echo "✓ Tools installed!"
@echo ""
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ The default `make` runs the following tasks:
* `cargo build`
* `cargo test`
* `cargo clippy` with `clippy::pedantic` lint settings
* `cargo deny` checks
* `cargo doc --no-deps`

To open the generated docs in your browser:
Expand Down
Loading