Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Store documentation file on a configurable directory #152

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

hans-thomas
Copy link
Contributor

@hans-thomas hans-thomas commented Dec 13, 2024

Hi, it adds the ability to store the generated documentation file in a configurable directory.

TODO list:

  • Local and Storage drivers should have new config, named directory with the default value documentations
  • the production_path config for Local and Storage drivers should be renamed to base_file_name with the default value documentation (without .json extension)
  • documentation file extension should be automatically extended by the .json extension
  • Local driver should check if directory exists and create it if not (on documentation saving)
  • Storage driver should create storage directory only for non Cloud drivers (on documentation saving)
  • Config version should be increased to force developers republish package config

@DenTray
Copy link
Collaborator

DenTray commented Dec 16, 2024

@hans-thomas I've updated task description, please add required changes accordingly the new task description (please feel free to open few PRs if you can divide task for small subtasks without breaking the package work)

@DenTray
Copy link
Collaborator

DenTray commented Dec 16, 2024

@hans-thomas please do not use autoclosing issues as we need to test task before closing

throw new MissedProductionFilePathException();
}
}

public function saveData(): void
{
$this->disk->put($this->prodFilePath, json_encode($this->getTmpData()));
$this->disk->put($this->baseFileName, json_encode($this->getTmpData()));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Storage driver should create storage directory only for non Cloud drivers (on documentation saving)

I believe the Filesystem class will take care of it.

@hans-thomas
Copy link
Contributor Author

Hi @DenTray, would you please review this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants