Allow config and temp directories to be configured independently. #760
Conversation
| @@ -23,9 +24,9 @@ class ApiDetails | |||
|
|
|||
| private array $lastKnownFileContentHashes = []; | |||
|
|
|||
| public function __construct(DocumentationConfig $config = null, bool $preserveUserChanges = true, string $docsName = 'scribe') | |||
| public function __construct(DocumentationConfig $config = null, bool $preserveUserChanges = true, CacheConfiguration $docsName) | |||
There was a problem hiding this comment.
Can you fix this? (The other occurrence(s) too).
There was a problem hiding this comment.
I like the goal here, but I think the API can be improved. I thnk there are quite a few naming mismatches, which make it harder to follow ($configObject implies this is the general Scribe config, but it's a very limited subset of the configuration; scribeConfig implies a config object, but it's a file, etc). Additionally, lines like new CacheConfiguration($configName, $configName, true) are not very expressive.
| @@ -24,12 +28,12 @@ public static function fromApp( | |||
| GenerateDocumentation $command, | |||
| RouteMatcherInterface $routeMatcher, | |||
| bool $preserveUserChanges, | |||
| string $docsName = 'scribe' | |||
| CacheConfiguration $docsName | |||
There was a problem hiding this comment.
This seems like mismatching parameter names? Name $docsName and type CacheConfiguration (also in the other places in this file)
| Storage::disk('local')->put("{$this->docsName}/collection.json", $collection); | ||
| $collectionPath = Storage::disk('local')->path("$this->docsName/collection.json"); | ||
| Storage::disk('local')->put($this->docsName->getScribeConfigFile() . "/collection.json", $collection); | ||
| $collectionPath = Storage::disk('local')->path($this->docsName->getScribeConfigFile() . "/collection.json"); |
There was a problem hiding this comment.
If we're doing this, perhaps we should move away from concatenation, and just make it a resolver (a la Laravel's storage_path(...))? Somethig like:
Storage::disk('local')->path($this->paths->outputFile("/collection.json"));
|
I will split this into two separate PRs |
Whats changed?
scribe.php(or custom php config file) independently of the temp directory.docker-composesetup to allow others to quickly run the test suite on their local machines without needing to install the test stack onto their environment.How do I run the tests in the new docker container?
clear && docker-compose up -d && docker logs -f scribe_app_1and the tests are run and results printed into your terminal!