Skip to content

DevlinBowman/lua-doc-iter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lua-doc-iter

This is a simple singlue use, mostly vibe coded tool. built using lua 5.5

Usage

lua main.lua -doc [-map ] [flags]

Default Behavior

No flags:

  • doc only:

    • scans tokens
    • prints counts + syntax validation
  • map only:

    • prints structured map contents
  • doc + map:

    • scans tokens
    • shows resolved values
    • validates syntax

Flags

-sub Substitute template values only. Output = raw text with tokens resolved. No numbering, no structure changes.

-addr Inject address tags. Output uses (A:...) markers.

-addr_raw Structural numbering without substitution. Output: - keeps markdown headers (#) - applies numbering (e.g. 19.0, A., etc.) - applies [FORMAT] rules

-strip Removes address tags only.

-compile Full pipeline: 1. substitute 2. normalize structure 3. apply numbering 4. apply [FORMAT]

Output: - no address tags - no markdown headers (#) - final contract format

Map File

Map file is plain text, section-based:

[DATE] [OWNER] [LOGGER] [AGENT] [STRINGS] [PERMIT] [FORMAT]

Used for:

  • resolving template tokens
  • controlling output formatting

FORMAT section

Controls rendering behavior:

NoParagraphNumbers: Section Name NoSectionNumbers: CompactSubHeaders: Section Name

Rules:

  • keys are case-insensitive
  • section names matched loosely (normalized)
  • multiple entries allowed per key

Output

-out Write result to file. Otherwise prints to stdout.

About

A simple tool for contract iteration with custom formatted markdown files.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages