SlatherOrg / slather

Generate test coverage reports for Xcode projects & hook it into CI.
MIT License
1.56k stars 238 forks source link

cli documentation is incomplete #489

Open alejandro-colomar opened 3 years ago

alejandro-colomar commented 3 years ago

Hi,

I'm working in porting some code, from a Fastfile to a Makefile, so I need to use command line (shell) calls. However, your README isn't complete in which options does the executable accept, and it doesn't accept --help, nor is there a man page.

Could you write some complete manual on how to use the executable directly?

Thanks,

Alex

alejandro-colomar commented 3 years ago

I had

    slather(
        jenkins:        true,
        scheme:         'AAA',
        build_directory:    'BBB',
        output_directory:   'CCC',
        workspace:      'DDD',
        proj:           'EEE',
        llvm_cov:       true,
        use_bundle_exec:    true
    )

and tried using

    slather coverage -s --scheme AAA \
        --build-directory BBB \
        --output-directory CCC \
        --workspace DDD \
        --llvm-cov --use-bundle-exec --jenkins \
        EEE;

but got this error:

slather coverage -s --scheme AAA \
        --build-directory BBB \
        --output-directory CCC \
        --workspace DDD \
        --llvm-cov --use-bundle-exec --jenkins \
        EEE;
ERROR: Unrecognised option '--use-bundle-exec'

How should I fix it?

alejandro-colomar commented 3 years ago

Ahh, I found that it's for running using bundle. Anyway, I think some documentation for cli would help, so we don't have to guess.