WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content
This repository was archived by the owner on Dec 10, 2025. It is now read-only.

Commit 0dad27a

Browse files
committed
Update tree structure to reflect current state of project
1 parent d9a7f9a commit 0dad27a

File tree

1 file changed

+84
-75
lines changed

1 file changed

+84
-75
lines changed

audit-cli/README.md

Lines changed: 84 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -936,81 +936,90 @@ since features may be added or removed across versions.
936936

937937
```
938938
audit-cli/
939-
├── main.go # CLI entry point
940-
├── commands/ # Command implementations
941-
│ ├── extract/ # Extract parent command
942-
│ │ ├── extract.go # Parent command definition
943-
│ │ ├── code-examples/ # Code examples subcommand
944-
│ │ │ ├── code_examples.go # Command logic
945-
│ │ │ ├── code_examples_test.go # Tests
946-
│ │ │ ├── parser.go # RST directive parsing
947-
│ │ │ ├── writer.go # File writing logic
948-
│ │ │ ├── report.go # Report generation
949-
│ │ │ ├── types.go # Type definitions
950-
│ │ │ └── language.go # Language normalization
951-
│ │ └── procedures/ # Procedures extraction subcommand
952-
│ │ ├── procedures.go # Command logic
953-
│ │ ├── parser.go # Procedure parsing and filtering
954-
│ │ ├── writer.go # RST file writing
955-
│ │ └── types.go # Type definitions
956-
│ ├── search/ # Search parent command
957-
│ │ ├── search.go # Parent command definition
958-
│ │ └── find-string/ # Find string subcommand
959-
│ │ ├── find_string.go # Command logic
960-
│ │ ├── types.go # Type definitions
961-
│ │ └── report.go # Report generation
962-
│ ├── analyze/ # Analyze parent command
963-
│ │ ├── analyze.go # Parent command definition
964-
│ │ ├── includes/ # Includes analysis subcommand
965-
│ │ │ ├── includes.go # Command logic
966-
│ │ │ ├── analyzer.go # Include tree building
967-
│ │ │ ├── output.go # Output formatting
968-
│ │ │ └── types.go # Type definitions
969-
│ │ ├── procedures/ # Procedures analysis subcommand
970-
│ │ │ ├── procedures.go # Command logic
971-
│ │ │ └── output.go # Output formatting
972-
│ │ └── usage/ # Usage analysis subcommand
973-
│ │ ├── usage.go # Command logic
974-
│ │ ├── usage_test.go # Tests
975-
│ │ ├── analyzer.go # Reference finding logic
976-
│ │ ├── output.go # Output formatting
977-
│ │ └── types.go # Type definitions
978-
│ └── compare/ # Compare parent command
979-
│ ├── compare.go # Parent command definition
980-
│ └── file-contents/ # File contents comparison subcommand
981-
│ ├── file_contents.go # Command logic
982-
│ ├── file_contents_test.go # Tests
983-
│ ├── comparer.go # Comparison logic
984-
│ ├── differ.go # Diff generation
985-
│ ├── output.go # Output formatting
986-
│ ├── types.go # Type definitions
987-
│ └── version_resolver.go # Version path resolution
988-
├── internal/ # Internal packages
989-
│ ├── pathresolver/ # Path resolution utilities
990-
│ │ ├── pathresolver.go # Core path resolution
991-
│ │ ├── pathresolver_test.go # Tests
992-
│ │ ├── source_finder.go # Source directory detection
993-
│ │ ├── version_resolver.go # Version path resolution
994-
│ │ └── types.go # Type definitions
995-
│ └── rst/ # RST parsing utilities
996-
│ ├── parser.go # Generic parsing with includes
997-
│ ├── include_resolver.go # Include directive resolution
998-
│ ├── directive_parser.go # Directive parsing
999-
│ ├── procedure_parser.go # Procedure parsing (core logic)
1000-
│ └── file_utils.go # File utilities
1001-
└── testdata/ # Test fixtures
1002-
├── input-files/ # Test RST files
1003-
│ └── source/ # Source directory (required)
1004-
│ ├── *.rst # Test files
1005-
│ ├── includes/ # Included RST files
1006-
│ └── code-examples/ # Code files for literalinclude
1007-
├── expected-output/ # Expected extraction results
1008-
└── compare/ # Compare command test data
1009-
├── product/ # Version structure tests
1010-
│ ├── manual/ # Manual version
1011-
│ ├── upcoming/ # Upcoming version
1012-
│ └── v8.0/ # v8.0 version
1013-
└── *.txt # Direct comparison tests
939+
├── main.go # CLI entry point
940+
├── commands/ # Command implementations
941+
│ ├── extract/ # Extract parent command
942+
│ │ ├── extract.go # Parent command definition
943+
│ │ ├── code-examples/ # Code examples subcommand
944+
│ │ │ ├── code_examples.go # Command logic
945+
│ │ │ ├── code_examples_test.go # Tests
946+
│ │ │ ├── parser.go # RST directive parsing
947+
│ │ │ ├── writer.go # File writing logic
948+
│ │ │ ├── report.go # Report generation
949+
│ │ │ ├── types.go # Type definitions
950+
│ │ │ └── language.go # Language normalization
951+
│ │ └── procedures/ # Procedures extraction subcommand
952+
│ │ ├── procedures.go # Command logic
953+
│ │ ├── procedures_test.go # Tests
954+
│ │ ├── parser.go # Filename generation and filtering
955+
│ │ ├── writer.go # RST file writing
956+
│ │ └── types.go # Type definitions
957+
│ ├── search/ # Search parent command
958+
│ │ ├── search.go # Parent command definition
959+
│ │ └── find-string/ # Find string subcommand
960+
│ │ ├── find_string.go # Command logic
961+
│ │ ├── types.go # Type definitions
962+
│ │ └── report.go # Report generation
963+
│ ├── analyze/ # Analyze parent command
964+
│ │ ├── analyze.go # Parent command definition
965+
│ │ ├── includes/ # Includes analysis subcommand
966+
│ │ │ ├── includes.go # Command logic
967+
│ │ │ ├── analyzer.go # Include tree building
968+
│ │ │ ├── output.go # Output formatting
969+
│ │ │ └── types.go # Type definitions
970+
│ │ ├── procedures/ # Procedures analysis subcommand
971+
│ │ │ ├── procedures.go # Command logic
972+
│ │ │ ├── procedures_test.go # Tests
973+
│ │ │ ├── analyzer.go # Procedure analysis logic
974+
│ │ │ ├── output.go # Output formatting
975+
│ │ │ └── types.go # Type definitions
976+
│ │ └── usage/ # Usage analysis subcommand
977+
│ │ ├── usage.go # Command logic
978+
│ │ ├── usage_test.go # Tests
979+
│ │ ├── analyzer.go # Reference finding logic
980+
│ │ ├── output.go # Output formatting
981+
│ │ └── types.go # Type definitions
982+
│ └── compare/ # Compare parent command
983+
│ ├── compare.go # Parent command definition
984+
│ └── file-contents/ # File contents comparison subcommand
985+
│ ├── file_contents.go # Command logic
986+
│ ├── file_contents_test.go # Tests
987+
│ ├── comparer.go # Comparison logic
988+
│ ├── differ.go # Diff generation
989+
│ ├── output.go # Output formatting
990+
│ ├── types.go # Type definitions
991+
│ └── version_resolver.go # Version path resolution
992+
├── internal/ # Internal packages
993+
│ ├── pathresolver/ # Path resolution utilities
994+
│ │ ├── pathresolver.go # Core path resolution
995+
│ │ ├── pathresolver_test.go # Tests
996+
│ │ ├── source_finder.go # Source directory detection
997+
│ │ ├── version_resolver.go # Version path resolution
998+
│ │ └── types.go # Type definitions
999+
│ └── rst/ # RST parsing utilities
1000+
│ ├── parser.go # Generic parsing with includes
1001+
│ ├── include_resolver.go # Include directive resolution
1002+
│ ├── directive_parser.go # Directive parsing
1003+
│ ├── directive_regex.go # Directive regex patterns
1004+
│ ├── parse_procedures.go # Procedure parsing (core logic)
1005+
│ ├── parse_procedures_test.go # Procedure parsing tests
1006+
│ ├── get_procedure_variations.go # Variation extraction logic
1007+
│ ├── get_procedure_variations_test.go # Variation tests
1008+
│ ├── procedure_types.go # Procedure type definitions
1009+
│ └── file_utils.go # File utilities
1010+
└── testdata/ # Test fixtures
1011+
├── input-files/ # Test RST files
1012+
│ └── source/ # Source directory (required)
1013+
│ ├── *.rst # Test files
1014+
│ ├── includes/ # Included RST files
1015+
│ └── code-examples/ # Code files for literalinclude
1016+
├── expected-output/ # Expected extraction results
1017+
└── compare/ # Compare command test data
1018+
├── product/ # Version structure tests
1019+
│ ├── manual/ # Manual version
1020+
│ ├── upcoming/ # Upcoming version
1021+
│ └── v8.0/ # v8.0 version
1022+
└── *.txt # Direct comparison tests
10141023
```
10151024

10161025
### Adding New Commands

0 commit comments

Comments
 (0)