Codebase
Navigate the Codebase using the tree view. Use the filters to highlight where various files are grouped to aid understanding.
Getting Started Commands
Project Structure
Below is a short description of the key directories of the project to aid you when understanding where key files are located.
.github/ - This directory contains GitHub-specific configuration files, such as issue templates and workflows.
.github/ISSUE_TEMPLATE/ - Contains templates for creating new issues on GitHub.
.github/workflows/ - Holds configuration files for GitHub Actions workflows.
.vscode/ - This directory contains Visual Studio Code settings and extensions for the project.
assets/ - This directory contains various assets used by the project, such as images and other files.
assets/logo/ - Contains the project's logo.
samples/ - This directory contains example projects demonstrating the usage of Intellenum.
samples/Intellenum.Examples/ - Contains various example projects demonstrating different aspects of Intellenum, such as serialization, conversion, syntax examples, types, typical scenarios, and more.
samples/WebApplication/ - Contains a sample web application that uses Intellenum.
src/ - This directory contains the source code of the Intellenum library.
src/Benchmarks/ - Contains benchmark tests for the Intellenum library.
src/bin/, src/obj/ - Contain compiled binary and object files, respectively.
src/Intellenum.CodeFixers/ - Contains code fixers for the Intellenum library.
src/Intellenum.SharedTypes/ - Contains shared types used across the Intellenum library.
src/Intellenum/ - Contains the main source code for the Intellenum library. This directory is further divided into subdirectories for diagnostics, extensions, generators, member building, properties, rules, static constructor building, templates, and more.
tests/ - This directory contains test projects for the Intellenum library.
tests/AnalyzerTests/ - Contains unit tests for the Intellenum analyzer.
tests/ConsumerTests/ - Contains tests for consuming the Intellenum library.
tests/Intellenum.Tests/ - Contains additional tests for the Intellenum library.
tests/Shared/ - Contains shared test files.
tests/SnapshotTests/ - Contains snapshot tests for the Intellenum library.
tests/SnapshotTests/snapshots/ - Contains snapshot test results.
tests/Testbench/ - Contains a test bench for the Intellenum library.
Entrypoints
Below are files we identified as entrypoints for to the codebase. This is where the application starts and a good place to start when learning.
Path: /samples/Intellenum.Examples/Program.cs - This file contains the entry point for example usage of the Intellenum library. It demonstrates how to use the library in practical scenarios, providing a guide for developers on how to implement the library in their own projects.
Path: /samples/WebApplication/Program.cs - This file contains the entry point for a web application that utilizes the Intellenum library. It likely sets up the application, configures the server, and integrates the Intellenum library to provide specific functionality within the web application.
Path: /src/Benchmarks/Program.cs - This file contains the entry point for benchmarking tests of the Intellenum library. It likely initializes and runs benchmark tests to measure the performance of various functions or features within the library.
Path: /tests/Testbench/Program.cs - This file contains the entry point for testing the Intellenum library. It likely initializes test cases, runs tests, and verifies the correctness of the library's functions and features. This file is crucial for ensuring the quality and reliability of the library.
