The software system is the scope of analysis in Sonargraph . This chapter describes the model used by Sonargraph to represent a software system based on your code components and elements in order to fulfill different goals regarding the analysis.
- 1. Motivation for Code Quality
- 2. Getting Started
- 3. Licensing
- 4. Initial Configuration
- 4.1. Installation and Updates
- 4.2. Help
- 4.3. Editor Preferences
- 4.4. License Server Preferences
- 4.5. Proxy Preferences
- 4.6. Update Site Preferences
- 4.7. C/C++ Compiler Definitions
- 4.8. Search Path Configuration
- 4.9. C/C++ Parser Daemon Configurations
- 4.10. C# Configuration
- 4.11. Python Configuration
- 5. Getting Familiar with the Sonargraph System Model
- 6. Creating a System
- 7. Adding Content to a System
- 7.1. Creating or Importing a Java Module
- 7.1.1. Importing Java Modules Using an Eclipse Workspace
- 7.1.2. Import Modules using the Sonargraph Gradle Plugin
- 7.1.3. Import Modules using the Sonargraph Maven Plugin
- 7.1.4. Importing Java Modules Using a Bazel Workspace
- 7.1.5. Import Modules Using the Build Unit(s) Importer
- 7.1.6. Creating a Java Module Manually
- 7.2. Creating or Importing a C++ Module
- 7.3. Creating or Importing a C# Module
- 7.1. Creating or Importing a Java Module
- 8.
Interacting with a System
- 8.1. User Interface Components
- 8.2. Common Interaction Patterns
- 8.3. Sonargraph Workbench
- 8.4. Getting a Quick Impression
- 8.5. Navigating through the System Components
- 8.6. Exploring the System Namespaces
- 8.7. Managing the System Files
- 8.8. Managing the Workspace
- 8.9. Analyzer Execution Level
- 8.10. Analyzing Cycles
- 8.11. Exploring the System
- 8.12. Searching Elements
- 8.13. Detecting Duplicate Code
- 8.14. Examining the Source Code
- 8.15. Examining Metrics Results
- 8.16. Analyzing C++ Include Dependencies
- 8.17. Creating a Report
- 9. Handling Detected Issues
- 10. Simulating Refactorings
- 11.
Defining an Architecture
- 11.1. Models, Components and Artifacts
- 11.2. Interfaces and Connectors
- 11.3. Reusing Architecture Aspects
- 11.4. Extending Aspect Based Artifacts
- 11.5. Extending Interfaces or Connectors
- 11.6. Adding Transitive or Deprecated Connections
- 11.7. Restricting Dependency Types
- 11.8. Connecting Complex Artifacts
- 11.9. Introducing Connection Schemes
- 11.10. Artifact Classes
- 11.11. How to Organize your Code
- 11.12. Designing Generic Architectures Using Templates
- 11.13. Best Practices
- 11.14. Architecture DSL Language Specification
- 12. Visualizing Architecture Aspects
- 13. Interactive Restructuring and Code Organization
- 14. Examining Changes
- 15. Defining Quality Gates
- 16. Extending the Static Analysis
- 17. Using Additional Plugins
- 18. Investigating Microservice Dependencies
- 19. Build Server Integration
- 20. IDE Integration
- 21. Metric Definitions
- 22. How to Resolve Issues
- 23. FAQ
- 24. References
- 25. Trademark Attributions, Library License Texts, and Source Code
- 26. Legal Notice
- Glossary
- 1.
Walk Through Tutorial (Java)
- 1.1. Workspace Definition
- 1.2. Basic Analysis
- 1.3. Advanced Analysis
- 1.4. Architecture: Artifacts, Aspects Files and Standard Connections
- 1.5. Architecture: Explicit Interfaces and Connectors
- 1.6. Architecture: Advanced Connections
- 1.7. Architecture: Advanced Aspect Files
- 1.8. Architecture: Referencing external Artifacts in Aspect Files
- 1.9. Headless Check with Sonargraph-Build
- 1.10. Check at Development Time with Sonargraph Eclipse Integration
- 2. Tutorial - Java
- 3. Tutorial - C#
- 4. Tutorial - C++
- 5. Sonargraph Script API Documentation
- Index