Developer Tools

The documentation of each developer tool can also be found in the tool directory in the NOTES.md file.

• Overview
  • Loading the developer tools
  • Tools documentation
  • Tools common flags
  • Tools requirements
• asdf
• assertions
  • API documentation
  • Loading
  • Testing
  • Adding assertions to your source code
  • Automatically adding file and line context information to assertions
  • Suppressing assertion calls from source code
  • Redirecting assertion failure messages
  • Converting assertion failures into errors
• code_metrics
  • API documentation
  • Loading
  • Testing
  • Available metrics
  • Coupling metrics
  • Lack of cohesion metric
  • WMC metric
  • RFC metric
  • Cognitive complexity metric
  • Lines metric
  • Maintainability index metric
  • Halstead metric
  • UPN metric
  • Cyclomatic complexity metric
  • Usage
  • Excluding code from analysis
  • Defining new metrics
  • Third-party tools
  • Applying metrics to Prolog modules
  • Applying metrics to plain Prolog code
• dead_code_scanner
  • API documentation
  • Loading
  • Testing
  • Usage
  • Excluding code from analysis
  • Machine-readable summaries
  • Machine-readable preflight warnings
  • Finding classes and confidence
  • SARIF reports
  • Integration with the make tool
  • Caveats
  • Scanning Prolog modules
  • Scanning plain Prolog files
  • Known issues
• debug_messages
  • API documentation
  • Loading
  • Testing
  • Usage
• debugger
  • API documentation
  • Loading
  • Testing
  • Usage
  • Alternative debugger tools
  • Known issues
• diagrams
  • Requirements
  • API documentation
  • Loading
  • Testing
  • Supported diagrams
  • Graph elements
  • Supported graph languages
  • Customization
  • Linking diagrams
  • Creating diagrams for Prolog module applications
  • Creating diagrams for plain Prolog files
  • Other notes
• doclet
  • API documentation
  • Loading
  • Automating running doclets
  • Integration with the make tool
• help
  • Requirements
  • Customization
  • API documentation
  • Loading
  • Testing
  • Supported operating-systems
  • Usage
  • Known issues
• issue_creator
  • Requirements
  • Loading
  • Usage
  • Known issues
• lgtdoc
  • Requirements
  • API documentation
  • Loading
  • Testing
  • Documenting source code
  • Generating documentation
  • Documentation linter checks
• lgtunit
  • Main files
  • API documentation
  • Loading
  • Testing
  • Writing and running tests
  • Automating running tests
  • Parametric test objects
  • Test dialects
  • User-defined test dialects
  • QuickCheck
  • Skipping tests
  • Selecting tests
  • Checking test goal results
  • Testing local predicates
  • Testing non-deterministic predicates
  • Testing generators
  • Testing input/output predicates
  • Suppressing tested predicates output
  • Tests with timeout limits
  • Setup and cleanup goals
  • Test annotations
  • Test execution times and memory usage
  • Working with test data files
  • Flaky tests
  • Mocking
  • Debugging messages in tests
  • Debugging failed tests
  • Code coverage
  • Utility predicates
  • Exporting test results
  • Generating Allure reports
  • Exporting code coverage results
  • Automatically creating bug reports at issue trackers
  • Minimizing test results output
  • Help with warnings
  • Known issues
• linter
  • Main linter checks
  • Help on linter warnings
  • Extending the linter
  • Linting Prolog modules
  • Linting plain Prolog files
• linter_reporter
  • API documentation
  • Loading
  • Testing
  • Usage
  • Options
• make
  • API documentation
  • Help with warnings
  • Known issues
• mutation_testing
  • API documentation
  • Loading
  • Testing
  • Features
  • Default mutators
  • Usage
  • Limitations
  • Options
  • Sampling semantics
  • Defining new mutators
• packs
  • Requirements
  • API documentation
  • Loading
  • Testing
  • Usage
  • Programmatic query API
  • Registries and packs storage
  • Virtual environments
  • Lock files
  • Registry specification
  • Registry handling
  • Registry development
  • Pack specification
  • Encrypted packs
  • Signed packs
  • Pack URLs and Single Sign-On
  • Multiple pack versions
  • Pack dependencies
  • Pack portability
  • Pack development
  • Pack handling
  • Pack documentation
  • Pinning registries and packs
  • Testing packs
  • Security considerations
  • Best practices
  • Installing Prolog packs
  • Help with warnings
  • Known issues
• ports_profiler
  • API documentation
  • Loading
  • Testing
  • Compiling source files for port profiling
  • Generating profiling data
  • Printing profiling data reports
  • Interpreting profiling data
  • Profiling Prolog modules
  • Profiling plain Prolog code
  • Known issues
• profiler
  • Loading
  • Testing
  • Supported backend Prolog compilers
  • Compiling source code for profiling
• sarif
  • API documentation
  • Loading
  • Testing
  • Usage
• sbom
  • API documentation
  • Loading
  • Testing
  • Usage
  • Known issues
• tool_diagnostics
  • API documentation
  • Loading
  • Protocol overview
  • Term conventions
  • Usage
• tutor
  • API documentation
  • Loading
  • Usage
• wrapper
  • API documentation
  • Loading
  • Workflows
  • Customization
  • Current limitations