Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 1.38 KB

README.md

File metadata and controls

68 lines (48 loc) · 1.38 KB
Raw

Scantron

Organize all of your files under a directory and its subdirectories into a JSON object with a key of each unique file type

Oh – and it's insanely fast

⚠️ This project is in a usable state but still under construction

Usage

Display output to terminal for current directory

scantron

Pass in a folder

scantron -p <PATH_TO_FOLDER>

Run in quiet mode and generate a scantron.json file in your current directory

scantron -d

Example JSON Output

{
  "py": [
    "some/path/to/a/file.py",
    "another/path/to/a/file.py"
  ],

  "ts": [
    "oh/look/a/typescript/file.ts",
    "another/one.ts"
  ],

  "cpp": [
    "why/is/a/c/plus/plus/file/here.cpp"
  ]

  "go": [
    "golang/is/nice.go",
    "more/people/should/learn/go.go",
    "go/should/be/in/university/cirricula.go",
    "i/still/kind/of/like/rust/better.go"
  ]
}

Potential Use Cases

  • You can use the generated scantron.json file in your CI/CD pipeline for custom DAST scans or other vulnerability checks
  • Keep an organized, running file of all file types that exist in your codebase
  • Complex file management tracking purposes

TODO

  • Move CLI logic to separate file
  • Add other useful flags / subcommands
  • Benchmarking for speed / potential for multithreading

Inspired by this repo