lucidshark 0.10.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lucidshark-0.10.0/LICENSE +201 -0
- lucidshark-0.10.0/PKG-INFO +334 -0
- lucidshark-0.10.0/README.md +297 -0
- lucidshark-0.10.0/pyproject.toml +203 -0
- lucidshark-0.10.0/setup.cfg +4 -0
- lucidshark-0.10.0/src/lucidshark/__init__.py +10 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/__init__.py +33 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/checksums.py +84 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/download.py +129 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/paths.py +160 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/platform.py +110 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/validation.py +148 -0
- lucidshark-0.10.0/src/lucidshark/bootstrap/versions.py +117 -0
- lucidshark-0.10.0/src/lucidshark/cli/__init__.py +70 -0
- lucidshark-0.10.0/src/lucidshark/cli/__main__.py +8 -0
- lucidshark-0.10.0/src/lucidshark/cli/arguments.py +551 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/__init__.py +64 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/doctor.py +475 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/help.py +71 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/init.py +1586 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/list_scanners.py +59 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/overview.py +408 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/scan.py +1330 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/serve.py +148 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/status.py +102 -0
- lucidshark-0.10.0/src/lucidshark/cli/commands/validate.py +95 -0
- lucidshark-0.10.0/src/lucidshark/cli/config_bridge.py +152 -0
- lucidshark-0.10.0/src/lucidshark/cli/exit_codes.py +17 -0
- lucidshark-0.10.0/src/lucidshark/cli/runner.py +343 -0
- lucidshark-0.10.0/src/lucidshark/config/__init__.py +33 -0
- lucidshark-0.10.0/src/lucidshark/config/ignore.py +212 -0
- lucidshark-0.10.0/src/lucidshark/config/loader.py +593 -0
- lucidshark-0.10.0/src/lucidshark/config/models.py +526 -0
- lucidshark-0.10.0/src/lucidshark/config/validation.py +1158 -0
- lucidshark-0.10.0/src/lucidshark/core/__init__.py +1 -0
- lucidshark-0.10.0/src/lucidshark/core/domain_runner.py +1711 -0
- lucidshark-0.10.0/src/lucidshark/core/filtering.py +65 -0
- lucidshark-0.10.0/src/lucidshark/core/git.py +386 -0
- lucidshark-0.10.0/src/lucidshark/core/ignore_issues.py +155 -0
- lucidshark-0.10.0/src/lucidshark/core/logging.py +49 -0
- lucidshark-0.10.0/src/lucidshark/core/models.py +408 -0
- lucidshark-0.10.0/src/lucidshark/core/paths.py +92 -0
- lucidshark-0.10.0/src/lucidshark/core/skip_handler.py +127 -0
- lucidshark-0.10.0/src/lucidshark/core/streaming.py +340 -0
- lucidshark-0.10.0/src/lucidshark/core/subprocess_runner.py +293 -0
- lucidshark-0.10.0/src/lucidshark/core/tool_validation.py +252 -0
- lucidshark-0.10.0/src/lucidshark/data/__init__.py +1 -0
- lucidshark-0.10.0/src/lucidshark/data/checkstyle-google.xml +473 -0
- lucidshark-0.10.0/src/lucidshark/data/help.md +2790 -0
- lucidshark-0.10.0/src/lucidshark/data/pmd-ruleset.xml +48 -0
- lucidshark-0.10.0/src/lucidshark/data/spotbugs-exclude.xml +109 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/__init__.py +1 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/c.yml +61 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/cpp.yml +61 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/csharp.yml +61 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/go.yml +61 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/java.yml +56 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/javascript.yml +62 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/kotlin.yml +61 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/php.yml +58 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/python.yml +66 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/ruby.yml +60 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/rust.yml +59 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/scala.yml +63 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/swift.yml +59 -0
- lucidshark-0.10.0/src/lucidshark/data/templates/typescript.yml +68 -0
- lucidshark-0.10.0/src/lucidshark/detection/__init__.py +21 -0
- lucidshark-0.10.0/src/lucidshark/detection/detector.py +200 -0
- lucidshark-0.10.0/src/lucidshark/detection/frameworks.py +650 -0
- lucidshark-0.10.0/src/lucidshark/detection/languages.py +570 -0
- lucidshark-0.10.0/src/lucidshark/detection/tools.py +307 -0
- lucidshark-0.10.0/src/lucidshark/generation/__init__.py +17 -0
- lucidshark-0.10.0/src/lucidshark/generation/config_generator.py +376 -0
- lucidshark-0.10.0/src/lucidshark/generation/package_installer.py +339 -0
- lucidshark-0.10.0/src/lucidshark/generation/template_composer.py +285 -0
- lucidshark-0.10.0/src/lucidshark/mcp/__init__.py +30 -0
- lucidshark-0.10.0/src/lucidshark/mcp/formatter.py +619 -0
- lucidshark-0.10.0/src/lucidshark/mcp/server.py +390 -0
- lucidshark-0.10.0/src/lucidshark/mcp/tools.py +2208 -0
- lucidshark-0.10.0/src/lucidshark/mcp/watcher.py +238 -0
- lucidshark-0.10.0/src/lucidshark/overview/__init__.py +17 -0
- lucidshark-0.10.0/src/lucidshark/overview/generator.py +570 -0
- lucidshark-0.10.0/src/lucidshark/overview/history.py +186 -0
- lucidshark-0.10.0/src/lucidshark/overview/models.py +244 -0
- lucidshark-0.10.0/src/lucidshark/pipeline/__init__.py +17 -0
- lucidshark-0.10.0/src/lucidshark/pipeline/executor.py +187 -0
- lucidshark-0.10.0/src/lucidshark/pipeline/parallel.py +181 -0
- lucidshark-0.10.0/src/lucidshark/plugins/__init__.py +40 -0
- lucidshark-0.10.0/src/lucidshark/plugins/c_utils.py +296 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/__init__.py +32 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/base.py +614 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/coverage_py.py +275 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/dotnet_coverage.py +216 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/gcov.py +186 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/go_cover.py +252 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/istanbul.py +207 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/jacoco.py +415 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/lcov.py +246 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/phpunit_coverage.py +193 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/scoverage.py +327 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/simplecov.py +245 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/swift_coverage.py +216 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/tarpaulin.py +205 -0
- lucidshark-0.10.0/src/lucidshark/plugins/coverage/vitest.py +124 -0
- lucidshark-0.10.0/src/lucidshark/plugins/cpp_utils.py +263 -0
- lucidshark-0.10.0/src/lucidshark/plugins/discovery.py +365 -0
- lucidshark-0.10.0/src/lucidshark/plugins/dotnet_utils.py +64 -0
- lucidshark-0.10.0/src/lucidshark/plugins/duplication/__init__.py +32 -0
- lucidshark-0.10.0/src/lucidshark/plugins/duplication/base.py +279 -0
- lucidshark-0.10.0/src/lucidshark/plugins/duplication/duplo.py +684 -0
- lucidshark-0.10.0/src/lucidshark/plugins/enrichers/__init__.py +61 -0
- lucidshark-0.10.0/src/lucidshark/plugins/enrichers/base.py +63 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/__init__.py +26 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/base.py +135 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/clang_format.py +222 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/dotnet_format.py +220 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/gofmt.py +173 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/ktlint_format.py +185 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/php_cs_fixer.py +248 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/prettier.py +210 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/rubocop_format.py +221 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/ruff_format.py +186 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/rustfmt.py +177 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/scalafmt.py +213 -0
- lucidshark-0.10.0/src/lucidshark/plugins/formatters/swiftformat.py +189 -0
- lucidshark-0.10.0/src/lucidshark/plugins/go_utils.py +272 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/__init__.py +26 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/base.py +220 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/biome.py +294 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/checkstyle.py +474 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/clang_tidy.py +375 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/clippy.py +404 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/dotnet_format.py +247 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/eslint.py +332 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/golangci_lint.py +394 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/ktlint.py +372 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/phpcs.py +272 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/pmd.py +483 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/rubocop.py +308 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/ruff.py +472 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/scalafix.py +342 -0
- lucidshark-0.10.0/src/lucidshark/plugins/linters/swiftlint.py +317 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/__init__.py +47 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/ai_reporter.py +159 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/base.py +30 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/json_reporter.py +101 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/sarif_reporter.py +310 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/summary_reporter.py +171 -0
- lucidshark-0.10.0/src/lucidshark/plugins/reporters/table_reporter.py +160 -0
- lucidshark-0.10.0/src/lucidshark/plugins/rust_utils.py +191 -0
- lucidshark-0.10.0/src/lucidshark/plugins/scanners/__init__.py +61 -0
- lucidshark-0.10.0/src/lucidshark/plugins/scanners/base.py +58 -0
- lucidshark-0.10.0/src/lucidshark/plugins/scanners/checkov.py +483 -0
- lucidshark-0.10.0/src/lucidshark/plugins/scanners/gosec.py +591 -0
- lucidshark-0.10.0/src/lucidshark/plugins/scanners/opengrep.py +464 -0
- lucidshark-0.10.0/src/lucidshark/plugins/scanners/trivy.py +512 -0
- lucidshark-0.10.0/src/lucidshark/plugins/swift_utils.py +78 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/__init__.py +27 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/base.py +431 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/cargo.py +434 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/ctest.py +497 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/dotnet_test.py +437 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/go_test.py +446 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/jest.py +185 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/karma.py +411 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/maven.py +533 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/mocha.py +468 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/phpunit.py +281 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/playwright.py +374 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/pytest.py +677 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/rspec.py +273 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/sbt.py +455 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/swift_test.py +272 -0
- lucidshark-0.10.0/src/lucidshark/plugins/test_runners/vitest.py +116 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/__init__.py +27 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/base.py +107 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/cargo_check.py +258 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/cppcheck.py +389 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/detekt.py +384 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/dotnet_build.py +242 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/go_vet.py +554 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/mypy.py +394 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/phpstan.py +257 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/pyright.py +325 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/scala_compile.py +305 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/sorbet.py +268 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/spotbugs.py +638 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/swift_compiler.py +185 -0
- lucidshark-0.10.0/src/lucidshark/plugins/type_checkers/typescript.py +262 -0
- lucidshark-0.10.0/src/lucidshark/plugins/utils.py +460 -0
- lucidshark-0.10.0/src/lucidshark/py.typed +0 -0
- lucidshark-0.10.0/src/lucidshark/updater.py +538 -0
- lucidshark-0.10.0/src/lucidshark.egg-info/PKG-INFO +334 -0
- lucidshark-0.10.0/src/lucidshark.egg-info/SOURCES.txt +196 -0
- lucidshark-0.10.0/src/lucidshark.egg-info/dependency_links.txt +1 -0
- lucidshark-0.10.0/src/lucidshark.egg-info/entry_points.txt +94 -0
- lucidshark-0.10.0/src/lucidshark.egg-info/requires.txt +9 -0
- lucidshark-0.10.0/src/lucidshark.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 Voldeq GmbH, Zollikofen, Switzerland
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: lucidshark
|
|
3
|
+
Version: 0.10.0
|
|
4
|
+
Summary: Unified code quality and security scanner for AI-assisted development: lint, types, SAST, SCA, tests, coverage.
|
|
5
|
+
Author: Toni Antunovic
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/toniantunovi/lucidshark
|
|
8
|
+
Project-URL: Repository, https://github.com/toniantunovi/lucidshark
|
|
9
|
+
Project-URL: Issues, https://github.com/toniantunovi/lucidshark/issues
|
|
10
|
+
Project-URL: Changelog, https://github.com/toniantunovi/lucidshark/blob/main/CHANGELOG.md
|
|
11
|
+
Keywords: code-quality,linter,security,sast,sca,static-analysis,mcp,model-context-protocol,ai,claude-code
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Operating System :: MacOS
|
|
16
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
17
|
+
Classifier: Programming Language :: Python :: 3
|
|
18
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Topic :: Security
|
|
23
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
24
|
+
Classifier: Topic :: Software Development :: Testing
|
|
25
|
+
Classifier: Typing :: Typed
|
|
26
|
+
Requires-Python: >=3.10
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
License-File: LICENSE
|
|
29
|
+
Requires-Dist: certifi>=2024.2.2
|
|
30
|
+
Requires-Dist: defusedxml>=0.7.1
|
|
31
|
+
Requires-Dist: mcp<2,>=1.25
|
|
32
|
+
Requires-Dist: pathspec>=0.12
|
|
33
|
+
Requires-Dist: PyYAML>=6.0
|
|
34
|
+
Requires-Dist: tomli>=2.0; python_version < "3.11"
|
|
35
|
+
Requires-Dist: watchdog>=4.0
|
|
36
|
+
Dynamic: license-file
|
|
37
|
+
|
|
38
|
+
## LucidShark
|
|
39
|
+
|
|
40
|
+
<!-- mcp-name: io.github.toniantunovi/lucidshark -->
|
|
41
|
+
|
|
42
|
+
[](https://github.com/toniantunovi/lucidshark/actions/workflows/ci.yml)
|
|
43
|
+
[](https://codecov.io/gh/toniantunovi/lucidshark)
|
|
44
|
+
[](https://github.com/toniantunovi/lucidshark/blob/main/LICENSE)
|
|
45
|
+
|
|
46
|
+
### Ship AI-generated code without the fear
|
|
47
|
+
```
|
|
48
|
+
AI writes code → LucidShark checks → AI fixes → repeat
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**The quality gate for agentic engineering.** As AI agents increasingly write production code, LucidShark ensures high standards through automated, comprehensive quality checks - no manual code review bottlenecks.
|
|
52
|
+
|
|
53
|
+
<p align="center">
|
|
54
|
+
<img src="docs/lucidshark-terminal.gif" alt="LucidShark Demo" width="1000">
|
|
55
|
+
</p>
|
|
56
|
+
|
|
57
|
+
## Why LucidShark
|
|
58
|
+
|
|
59
|
+
- **Local-first** - No server, no SaaS account. Runs on your machine and in CI with the same results.
|
|
60
|
+
|
|
61
|
+
- **Configuration-as-code** - `lucidshark.yml` lives in your repo. Same rules for everyone, changes go through code review.
|
|
62
|
+
|
|
63
|
+
- **AI-native** - MCP integration with Claude Code, Cursor and Windsurf, plus a lint hook for Aider. Structured feedback that AI agents can act on directly.
|
|
64
|
+
|
|
65
|
+
- **Unified pipeline** - Linting, type checking, formatting, security (SAST/SCA/IaC), tests, coverage, and duplication detection in one tool. Stop configuring 5+ separate tools.
|
|
66
|
+
|
|
67
|
+
- **Open source & extensible** - Apache 2.0 licensed. Add your own tools via the plugin system.
|
|
68
|
+
|
|
69
|
+
## Quick Start
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# 1. Install LucidShark
|
|
73
|
+
curl -fsSL https://raw.githubusercontent.com/toniantunovi/lucidshark/main/install.sh | bash
|
|
74
|
+
|
|
75
|
+
# 2. Configure Claude Code integration (add --cursor, --windsurf, --aider for other tools)
|
|
76
|
+
./lucidshark init
|
|
77
|
+
|
|
78
|
+
# 3. Restart your AI tool, then ask it:
|
|
79
|
+
# "Autoconfigure LucidShark for this project"
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
That's it! Your AI assistant will analyze your codebase, ask you a few questions, and generate the `lucidshark.yml` configuration.
|
|
83
|
+
|
|
84
|
+
### Installation Options
|
|
85
|
+
|
|
86
|
+
| Method | Command | Usage | Notes |
|
|
87
|
+
|--------|---------|-------|-------|
|
|
88
|
+
| **Install Script (Linux/macOS)** | `curl -fsSL .../install.sh \| bash` | `./lucidshark` | Recommended, installs to current directory |
|
|
89
|
+
| **Manual** | Download from [Releases](https://github.com/toniantunovi/lucidshark/releases) | `./lucidshark` | Pre-built binaries for Linux and macOS |
|
|
90
|
+
|
|
91
|
+
**Important:** LucidShark is distributed as a standalone binary. The installation creates a project-local `./lucidshark` file. Always use `./lucidshark` to ensure you're running the project-specific version.
|
|
92
|
+
|
|
93
|
+
### Verified Downloads
|
|
94
|
+
|
|
95
|
+
Nothing LucidShark installs runs unverified:
|
|
96
|
+
|
|
97
|
+
- **The LucidShark binary.** Every release publishes a `SHA256SUMS` file and a signed [build provenance attestation](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations). The install script checks the binary against `SHA256SUMS` before making it executable and aborts on mismatch. The self-updater does the same before staging an update, and checks the hash again before applying it. `SHA256SUMS` comes from the same release as the binary, so it catches corrupted or tampered transfers. The attestation is what proves a binary was built by this repository's release workflow. To verify a manual download:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
shasum -a 256 -c SHA256SUMS --ignore-missing # or: sha256sum -c SHA256SUMS --ignore-missing
|
|
101
|
+
gh attestation verify lucidshark-linux-amd64 --repo toniantunovi/lucidshark
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
- **Scanner and tool binaries** (Trivy, OpenGrep, Checkov, gosec, PMD, Checkstyle, SpotBugs, ktlint, detekt, duplo). Each download is checked against a SHA-256 pinned inside LucidShark for that exact version, asset and platform ([`checksums.py`](src/lucidshark/bootstrap/checksums.py)). A mismatch, or a URL with no pin, is refused before anything is written to disk. The pins are generated by [`scripts/update_tool_checksums.py`](scripts/update_tool_checksums.py), which cross-checks each hash against the digest GitHub recorded when the asset was uploaded.
|
|
105
|
+
|
|
106
|
+
### Running Scans
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
./lucidshark scan --all # Run all quality checks
|
|
110
|
+
./lucidshark scan --linting # Run specific domains
|
|
111
|
+
./lucidshark scan --linting --fix # Auto-fix linting issues
|
|
112
|
+
./lucidshark scan --all --dry-run # Preview what would be scanned
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Scan domains: `--linting`, `--type-checking`, `--formatting`, `--sast`, `--sca`, `--iac`, `--container`, `--testing`, `--coverage`, `--duplication`
|
|
116
|
+
|
|
117
|
+
### Incremental Scanning
|
|
118
|
+
|
|
119
|
+
By default, LucidShark scans only uncommitted changes (staged, unstaged, untracked files):
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
# Default: scan only changed files (no extra flags needed)
|
|
123
|
+
./lucidshark scan --linting --type-checking
|
|
124
|
+
|
|
125
|
+
# Full project scan
|
|
126
|
+
./lucidshark scan --all --all-files
|
|
127
|
+
|
|
128
|
+
# PR/CI: filter results to files changed since a branch
|
|
129
|
+
./lucidshark scan --all --base-branch origin/main
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
See [Incremental Scanning](docs/incremental-scanning.md) for threshold scopes, CI integration, and advanced usage.
|
|
133
|
+
|
|
134
|
+
**Note:** LucidShark runs in **strict mode** by default - all configured tools must run successfully. If a tool is missing, not applicable, or fails to execute, the scan fails with a HIGH severity issue and fix suggestions. Security tools (trivy, opengrep, gosec, checkov), duplo, PMD, Checkstyle, SpotBugs, ktlint, and detekt are downloaded automatically.
|
|
135
|
+
|
|
136
|
+
### Example Output
|
|
137
|
+
|
|
138
|
+
When issues are found:
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
$ ./lucidshark scan --linting --type-checking --sast
|
|
142
|
+
Total issues: 4
|
|
143
|
+
|
|
144
|
+
By severity:
|
|
145
|
+
HIGH: 1
|
|
146
|
+
MEDIUM: 2
|
|
147
|
+
LOW: 1
|
|
148
|
+
|
|
149
|
+
By scanner domain:
|
|
150
|
+
LINTING: 2
|
|
151
|
+
TYPE_CHECKING: 1
|
|
152
|
+
SAST: 1
|
|
153
|
+
|
|
154
|
+
Scan duration: 1243ms
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
When everything passes:
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
$ ./lucidshark scan --all
|
|
161
|
+
No issues found.
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
Use `--format table` for a detailed per-issue breakdown, or `--format json` for machine-readable output.
|
|
165
|
+
|
|
166
|
+
### Diagnostics
|
|
167
|
+
|
|
168
|
+
Check your LucidShark setup with the doctor command:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
./lucidshark doctor
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
This checks:
|
|
175
|
+
- Configuration file presence and validity
|
|
176
|
+
- Tool availability (security scanners, linters, type checkers)
|
|
177
|
+
- Python environment compatibility
|
|
178
|
+
- Git repository status
|
|
179
|
+
- MCP integration (Claude Code)
|
|
180
|
+
|
|
181
|
+
### AI Tool Setup
|
|
182
|
+
|
|
183
|
+
`init` configures Claude Code by default. Tool flags select other tools and combine freely; `--all-tools` configures all of them. `--dry-run`, `--force` and `--remove` apply to every selected tool, and shared files (`CLAUDE.md`, `CONVENTIONS.md`, `.aider.conf.yml`, MCP JSON files) are merged, never overwritten.
|
|
184
|
+
|
|
185
|
+
| Tool | Command | What it writes |
|
|
186
|
+
|------|---------|----------------|
|
|
187
|
+
| Claude Code | `./lucidshark init` | `.mcp.json`, `.claude/skills/lucidshark/SKILL.md`, `.claude/CLAUDE.md` section, `.claude/settings.json` hook |
|
|
188
|
+
| Cursor | `./lucidshark init --cursor` | `.cursor/mcp.json`, `.cursor/rules/lucidshark.mdc` (always applied) |
|
|
189
|
+
| Windsurf | `./lucidshark init --windsurf` | `.windsurf/rules/lucidshark.md` (`trigger: always_on`); prints the MCP snippet for `~/.codeium/windsurf/mcp_config.json`, since Windsurf keeps MCP servers in your home directory and `init` does not write there |
|
|
190
|
+
| Aider | `./lucidshark init --aider` | `.aider.conf.yml` keys `lint-cmd` (LucidShark on every edited file), `auto-lint`, `read: [CONVENTIONS.md]`, plus a `CONVENTIONS.md` section. Aider has no MCP support |
|
|
191
|
+
| All of the above | `./lucidshark init --all-tools` | |
|
|
192
|
+
|
|
193
|
+
Restart your AI tool after running `init` to activate.
|
|
194
|
+
|
|
195
|
+
Any other MCP client can run the server directly with `lucidshark serve --mcp .`. Or tell your agent:
|
|
196
|
+
|
|
197
|
+
> Add the LucidShark MCP server so you can test your own output before committing.
|
|
198
|
+
|
|
199
|
+
## Supported Languages
|
|
200
|
+
|
|
201
|
+
LucidShark supports 14 programming languages with full tool coverage:
|
|
202
|
+
|
|
203
|
+
| Languages | What's Included |
|
|
204
|
+
|-----------|-----------------|
|
|
205
|
+
| Python, TypeScript, JavaScript, Java, Kotlin, Rust, Go, C#, C, C++, Scala, Swift, Ruby, PHP | Linting, type checking, formatting, testing, coverage, security, duplication |
|
|
206
|
+
|
|
207
|
+
For detailed per-language tool coverage, configuration examples, and detection info, see the [Language Reference](docs/languages/README.md).
|
|
208
|
+
|
|
209
|
+
## What It Checks
|
|
210
|
+
|
|
211
|
+
| Domain | Tools | What It Catches |
|
|
212
|
+
|--------|-------|-----------------|
|
|
213
|
+
| **Linting** | Ruff, ESLint, Biome, Clippy, Checkstyle, PMD, ktlint, golangci-lint, dotnet format, clang-tidy, Scalafix, SwiftLint, RuboCop, phpcs | Style issues, code smells, bug detection |
|
|
214
|
+
| **Formatting** | Ruff Format, Prettier, ktlint, rustfmt, gofmt, dotnet format, clang-format, Scalafmt, SwiftFormat, RuboCop Format, PHP-CS-Fixer | Code formatting, whitespace style |
|
|
215
|
+
| **Type Checking** | mypy, Pyright, TypeScript (tsc), SpotBugs (managed), detekt, cargo check, go vet, dotnet build, cppcheck, scalac, Swift compiler, Sorbet, PHPStan | Type errors, static analysis bugs |
|
|
216
|
+
| **Security (SAST)** | OpenGrep, gosec (Go) | Code vulnerabilities |
|
|
217
|
+
| **Security (SCA)** | Trivy | Dependency vulnerabilities |
|
|
218
|
+
| **Security (IaC)** | Checkov | Infrastructure misconfigurations |
|
|
219
|
+
| **Security (Container)** | Trivy | Container image vulnerabilities |
|
|
220
|
+
| **Testing** | pytest, Jest, Vitest, Mocha, Karma (Angular), Playwright (E2E), Maven/Gradle (JUnit), cargo test, go test, dotnet test, CTest, sbt test, swift test, RSpec, PHPUnit | Test failures |
|
|
221
|
+
| **Coverage** | coverage.py, Istanbul, Vitest, JaCoCo, Tarpaulin, go cover, dotnet coverage, gcov/lcov, Scoverage, llvm-cov, SimpleCov, PHPUnit Clover | Coverage gaps |
|
|
222
|
+
| **Duplication** | Duplo | Code clones, duplicate blocks |
|
|
223
|
+
|
|
224
|
+
All results are normalized to a common format.
|
|
225
|
+
|
|
226
|
+
## Quality Overview
|
|
227
|
+
|
|
228
|
+
Track quality trends over time with a git-committed quality dashboard - no server or SaaS required.
|
|
229
|
+
|
|
230
|
+
```bash
|
|
231
|
+
./lucidshark scan --all --all-files && ./lucidshark overview --update
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
This creates `QUALITY.md` at your repo root showing:
|
|
235
|
+
- Health score (0-10) with visual bar
|
|
236
|
+
- Domain status table with trends
|
|
237
|
+
- Issues breakdown by severity
|
|
238
|
+
- Top files by issue count
|
|
239
|
+
- Test coverage and duplication metrics
|
|
240
|
+
- Historical trend chart
|
|
241
|
+
|
|
242
|
+
Add to your CI pipeline to auto-update on merge to main. See [docs/help.md](docs/help.md#lucidshark-overview) for configuration options.
|
|
243
|
+
|
|
244
|
+
## Configuration
|
|
245
|
+
|
|
246
|
+
LucidShark auto-detects your project. For custom settings, create `lucidshark.yml`:
|
|
247
|
+
|
|
248
|
+
```yaml
|
|
249
|
+
version: 1
|
|
250
|
+
pipeline:
|
|
251
|
+
linting:
|
|
252
|
+
enabled: true
|
|
253
|
+
tools: [{ name: ruff }]
|
|
254
|
+
type_checking:
|
|
255
|
+
enabled: true
|
|
256
|
+
tools: [{ name: mypy, strict: true }]
|
|
257
|
+
formatting:
|
|
258
|
+
enabled: true
|
|
259
|
+
tools: [{ name: ruff_format }]
|
|
260
|
+
security:
|
|
261
|
+
enabled: true
|
|
262
|
+
tools:
|
|
263
|
+
- { name: trivy, domains: [sca, container] }
|
|
264
|
+
- { name: opengrep, domains: [sast] }
|
|
265
|
+
- { name: gosec, domains: [sast] } # Go-specific SAST (auto-detected)
|
|
266
|
+
testing:
|
|
267
|
+
enabled: true
|
|
268
|
+
command: "make test" # Optional: custom command overrides plugin-based runner
|
|
269
|
+
post_command: "make clean" # Optional: runs after tests complete
|
|
270
|
+
tools: [{ name: pytest }]
|
|
271
|
+
coverage:
|
|
272
|
+
enabled: true
|
|
273
|
+
threshold: 80
|
|
274
|
+
tools: [{ name: coverage_py }]
|
|
275
|
+
duplication:
|
|
276
|
+
enabled: true
|
|
277
|
+
threshold: 10.0
|
|
278
|
+
fail_on:
|
|
279
|
+
linting: error
|
|
280
|
+
security: high
|
|
281
|
+
testing: any
|
|
282
|
+
ignore_issues:
|
|
283
|
+
- rule_id: CVE-2021-3807
|
|
284
|
+
reason: "Not exploitable in our context"
|
|
285
|
+
expires: 2026-06-01
|
|
286
|
+
exclude: ["**/node_modules/**", "**/.venv/**"]
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
See [docs/help.md](docs/help.md) for the full configuration reference.
|
|
290
|
+
|
|
291
|
+
## CLI Reference
|
|
292
|
+
|
|
293
|
+
| Command | Description |
|
|
294
|
+
|---------|-------------|
|
|
295
|
+
| `./lucidshark scan --all` | Run all quality checks |
|
|
296
|
+
| `./lucidshark scan --linting --fix` | Lint and auto-fix |
|
|
297
|
+
| `./lucidshark scan --formatting --fix` | Format and auto-fix |
|
|
298
|
+
| `./lucidshark overview --update` | Generate/update QUALITY.md |
|
|
299
|
+
| `./lucidshark init` | Configure AI tool integration (Claude Code by default; `--cursor`, `--windsurf`, `--aider`, `--all-tools`) |
|
|
300
|
+
| `./lucidshark doctor` | Check setup and environment health |
|
|
301
|
+
| `./lucidshark validate` | Validate `lucidshark.yml` |
|
|
302
|
+
|
|
303
|
+
For the full CLI reference, all scan flags, output formats, and exit codes, see [docs/help.md](docs/help.md).
|
|
304
|
+
|
|
305
|
+
## Development
|
|
306
|
+
|
|
307
|
+
To build LucidShark from source:
|
|
308
|
+
|
|
309
|
+
```bash
|
|
310
|
+
git clone https://github.com/toniantunovi/lucidshark.git
|
|
311
|
+
cd lucidshark
|
|
312
|
+
|
|
313
|
+
# Install Python dependencies
|
|
314
|
+
pip install -r requirements.txt -r requirements-dev.txt
|
|
315
|
+
|
|
316
|
+
# Build the binary
|
|
317
|
+
pyinstaller lucidshark.spec
|
|
318
|
+
|
|
319
|
+
# The binary will be in the dist/ directory
|
|
320
|
+
./dist/lucidshark --version
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
## Documentation
|
|
324
|
+
|
|
325
|
+
- [Supported Languages](docs/languages/README.md) - Per-language tool coverage, detection, and configuration
|
|
326
|
+
- [Incremental Scanning](docs/incremental-scanning.md) - PR-based filtering, threshold scopes, CI integration
|
|
327
|
+
- [Quality Overview](docs/help.md#lucidshark-overview) - Git-committed quality dashboard, trends, and CI integration
|
|
328
|
+
- [LLM Reference Documentation](docs/help.md) - For AI agents and detailed reference
|
|
329
|
+
- [Exclude Patterns & Issue Ignoring](docs/exclude-patterns.md) - File exclusions, per-domain excludes, and ignoring specific issues
|
|
330
|
+
- [Full Specification](docs/main.md)
|
|
331
|
+
|
|
332
|
+
## License
|
|
333
|
+
|
|
334
|
+
Apache 2.0
|