uncomment 3.0.0

A CLI tool to remove comments from code using tree-sitter for accurate parsing
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

# Uncomment Configuration: Adding Custom Languages
#
# uncomment ships with 49 built-in languages. Any of the 306 languages
# supported by tree-sitter-language-pack can be added here.
# Grammars are downloaded automatically on first use.
#
# See: https://github.com/kreuzberg-dev/tree-sitter-language-pack

[global]
remove_todos = false
remove_fixme = false
remove_docs = false
preserve_patterns = ["IMPORTANT", "NOTE", "WARNING"]
use_default_ignores = true
respect_gitignore = true

# ===== ADDITIONAL LANGUAGES =====
# These are NOT built-in but are available via tree-sitter-language-pack.
# Just define name, extensions, and comment_nodes.

# ----- Hare -----
[languages.hare]
name = "Hare"
extensions = ["ha"]
comment_nodes = ["comment"]
preserve_patterns = ["TODO", "FIXME"]

# ----- Crystal -----
[languages.crystal]
name = "Crystal"
extensions = ["cr"]
comment_nodes = ["comment"]
preserve_patterns = ["TODO", "FIXME", "ameba:"]

# ----- D -----
[languages.d]
name = "D"
extensions = ["d"]
comment_nodes = ["comment", "block_comment"]
doc_comment_nodes = ["block_comment"]
preserve_patterns = ["TODO", "FIXME"]

# ----- Racket -----
[languages.racket]
name = "Racket"
extensions = ["rkt", "rktl"]
comment_nodes = ["comment", "block_comment"]
preserve_patterns = ["TODO", "FIXME"]

# ----- Solidity -----
[languages.solidity]
name = "Solidity"
extensions = ["sol"]
comment_nodes = ["comment"]
doc_comment_nodes = ["comment"]
preserve_patterns = ["TODO", "FIXME", "slither-disable"]

# ----- Mojo -----
[languages.mojo]
name = "Mojo"
extensions = ["mojo"]
comment_nodes = ["comment"]
preserve_patterns = ["TODO", "FIXME"]

# ===== OVERRIDE BUILT-IN LANGUAGES =====
# You can also override settings for built-in languages.

[languages.python]
name = "Python"
extensions = ["py", "pyw", "pyi"]
comment_nodes = ["comment"]
doc_comment_nodes = ["string"]
preserve_patterns = ["mypy:", "type:", "noqa:", "pragma:", "pylint:"]
remove_docs = true

# ===== PATTERN-BASED RULES =====

[patterns."vendor/**/*"]
remove_todos = false
remove_fixme = false
remove_docs = false

[patterns."**/*.generated.*"]
remove_docs = true
remove_todos = true
remove_fixme = true
preserve_patterns = []