commented 0.1.0

If you want to comment a line for an unknown file type, this crate is what you want
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

[package]
name = "commented"
description = "If you want to comment a line for an unknown file type, this crate is what you want"
version = "0.1.0"
edition = "2024"
authors = ["Nik Revenco <pm@nikrev.com>"]
repository = "https://github.com/"
license = "MIT OR Apache-2.0"
keywords = ["comment"]
categories = []

[features]
glob = ["dep:globset"]

[workspace]
members = [".", "script"]
default-members = ["."]

[dependencies]
globset = { version = "0.4.16", optional = true }

# ============================
# 
#            Lints
#
# - strict set of lints for a
#   more consistent codebase
#
# - delegate as much as possible
#   to automated tooling 
# 
# ============================

[workspace.lints.rust]
# do not import if its already in scope
# e.g. `use std::option::Option::None`
redundant_imports = "warn"
# Documentation for all public items
missing_docs = "warn"
# `foo::bar::baz` => `bar::baz` if `bar` is in scope
unused_qualifications = "warn"
# detects rules of macros that weren't used
unused_macro_rules = "warn"
# lints against e.g. undefined meta variables
meta_variable_misuse = "warn"
# all types must `#[derive(Copy)]`
missing_copy_implementations = "warn"
# all types must `#[derive(Debug)]`
missing_debug_implementations = "warn"

[workspace.lints.clippy]
pedantic = { priority = -1, level = "warn" }

# --- more consistent ways of writing code
# 
# `if $a { Some($b) } else { None }` => `$a.then(|| $b)`
if_then_some_else_none = "warn"
# `use Trait` => `use Trait as _`
unused_trait_names = "warn"
# `foo.rs` => `foo/mod.rs`
self_named_module_files = "warn"
# omit `test_` prefix in tests: `fn test_foo` => `fn foo`
redundant_test_prefix = "warn"
# `123832i64` => `123832_i64`
unseparated_literal_suffix = "warn"
# `Foo { a: _, b: 0, .. }` => `Foo { b: 0, .. }`
# do not bind unused by `_` when pattern matching, bind by `..` instead
unneeded_field_pattern = "warn"
# `Err(x)?` => `return Err(x)`
try_err = "warn"
# `#[test] fn` must be in `#[cfg(test)]`
tests_outside_test_module = "warn"
# functions ending in `.and_then` could be better expressed as `?`
return_and_then = "warn"
# `match (A { a }) { A { a, .. } => () }` => `match (A { a: 5 }) { A { a } => () }`
rest_pat_in_fully_bound_structs = "warn"
# do not use differing names from the trait itself when implementing its method
renamed_function_params = "warn"
# `0x2345 & 0xF000 >> 12` => `0x2345 & (0xF000 >> 12)`
precedence_bits = "warn"
# omitting type annotations make code easier to modify
redundant_type_annotations = "warn"
# `assert!(r.is_ok())` => `r.unwrap()`
assertions_on_result_states = "warn"
# `fs::read_to_string` requires much less steps than `File::read_to_string`
verbose_file_reads = "warn"
# `use std::io::{self}` => `use std::io`
unnecessary_self_imports = "warn"
# do not lose type information about NonZero numbers
non_zero_suggestions = "warn"
# exit obscures flow of the program
exit = "warn"
# no need for a `SAFETY:` comment on safe code
unnecessary_safety_comment = "warn"
# each `unsafe` block must contain only 1 unsafe operation
multiple_unsafe_ops_per_block = "warn"
# ---

# --- explain more things
# 
# `#[allow]` => `#[allow, reason = "why"]`
allow_attributes_without_reason = "warn"
# `unsafe` blocks need a `SAFETY:` comment
undocumented_unsafe_blocks = "warn"
# `.unwrap()` => `.expect("why")`
unwrap_used = "warn"
# `arr[4]` => `arr.get(4).expect("why")`
indexing_slicing = "warn"
# `assert!(...)` => `assert!(..., "why")`
missing_assert_message = "warn"
# documentation for everything
missing_docs_in_private_items = "warn"
# `path_buf.push("foo")` => `... = PathBuf::new().join("foo")`
pathbuf_init_then_push = "warn"
# explicitly mark return type as `!` for infinite loop fns
infinite_loop = "warn"
# ---

# --- catch debug remnants
#
dbg_macro = "warn"
todo = "warn"
use_debug = "warn"
unimplemented = "warn"
# explicitly `#[allow]` functions to print to stdout
print_stdout = "warn" 
# explicitly `#[allow]` functions to print to stderr
print_stderr = "warn"
# ---

# --- prevent bugs
# new variants added by libraries become errors
# instead of being silently ignored
wildcard_enum_match_arm = "warn"
# if function and trait provide method of same name, it is confusing
same_name_method = "warn"
# `create_dir(...)` => `create_dir_all(...)`
# usually, failing when dir already exists is
# not what we want
create_dir = "warn"
# ---

# --- allowed lints
# 
# `$a * $b + $c` is slower and less precise than `$a.mul_add($b, $c)`
# but it is more readable, the gain in speed / precision
# will be negligible in most situations
suboptimal_flops = "allow"
# arbitrary limit imposes unnecessary
# restriction and can make code harder to follow
too_many_lines = "allow"
# if we need it const, make it const.
# no need to make everything that can be const, const
missing_const_for_fn = "allow"
# ---