Add ability to setup basepath via --basepath / -d in CLI

[samsonasik]

Per @gsteel at

• Install StructArmed laminas/internal-tooling#22

This PR adds ability to setup base path via --basepath in cli, eg:

analyze --basepath=../../

that mean, if we have project directory, eg:

src/
test
composer.json
├── tools
│   ├── structarmed
│   │   ├── composer.json
│   │   ├── composer.lock
│   │   ├── structarmed.php
│   │   └── vendor

and then, I want to run

cd tools/structarmed
vendor/bin/structarmed analyze --basepath=../../

eg, when the rule is instanceof ComposerJsonRuleInterface, it will scan ../../composer.json then by definiton of autoload/autoload-dev, it can read defined ../../composer.json definition, eg: src under autoload, and test under autoload in ../../composer.json

This also ensure, eg layer:

    ->layer('Config', 'src/ConfigProvider.php')
    ->layer('Exception', 'src/Exception')

that src/ConfigProvider.php is ../../src/ConfigProvider as new basepath is ../../ per cli command.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[samsonasik]

@gsteel the new feature ready :), tested and verified on laminas-i18n repo:

I will merge it tomorrow and then create StructArmed 0.19.0 release, just let me know if there is something you concern ;)

/cc @froschdesign

[gsteel]

I think it's more common to consider this a "Working Directory", i.e. where you do the work.

A common switch is -d like composer install -d ./somewhere-else with the assumption that the current working directory is . when unspecified.

So, if I run tools/structarmed/vendor/bin/structarmed --config=tools/structarmed/structarmed.php, I'd expect it to figure out that composer should be at ${PWD}/composer.json.

On the other hand, if I cd to the tools dir, I'd expect:

cd tools/structarmed
vendor/bin/structarmed -d ../../

to do the same thing, i.e. detect config in either CWD, or Working Dir and composer.json in working dir.

Hope I'm making sense!

[samsonasik]

@gsteel The direct run from root already read root as expected, see this screenshot:

---

and also I add the -d alias for --basepath: eb1c5f8

Should be ready now 👍

[gsteel]

Nice! Thanks @samsonasik - I should have read the initial patch more thoroughly!

[samsonasik]

Thank you @gsteel @froschdesign for the review.

It just merged and released 0.19.0 for it https://github.com/boundwize/structarmed/releases/tag/0.19.0