@@ -15,13 +15,13 @@ |
||
15 | 15 | public function handle() |
16 | 16 | { |
17 | 17 | $sourceOutputPath = 'resources/docs/source'; |
18 | - if (! is_dir($sourceOutputPath)) { |
|
19 | - $this->error('There is no existing documentation available at '.$sourceOutputPath.'.'); |
|
18 | + if (!is_dir($sourceOutputPath)) { |
|
19 | + $this->error('There is no existing documentation available at ' . $sourceOutputPath . '.'); |
|
20 | 20 | |
21 | 21 | return false; |
22 | 22 | } |
23 | 23 | |
24 | - $this->info('Rebuilding API documentation from '.$sourceOutputPath.'/index.md'); |
|
24 | + $this->info('Rebuilding API documentation from ' . $sourceOutputPath . '/index.md'); |
|
25 | 25 | |
26 | 26 | $writer = new Writer($this, new DocumentationConfig(config('apidoc'))); |
27 | 27 | $writer->writeHtmlDocs(); |
@@ -91,8 +91,8 @@ discard block |
||
91 | 91 | */ |
92 | 92 | public function writeMarkdownAndSourceFiles(Collection $parsedRoutes) |
93 | 93 | { |
94 | - $targetFile = $this->sourceOutputPath.'/source/index.md'; |
|
95 | - $compareFile = $this->sourceOutputPath.'/source/.compare.md'; |
|
94 | + $targetFile = $this->sourceOutputPath . '/source/index.md'; |
|
95 | + $compareFile = $this->sourceOutputPath . '/source/.compare.md'; |
|
96 | 96 | |
97 | 97 | $infoText = view('apidoc::partials.info') |
98 | 98 | ->with('outputPath', 'docs') |
@@ -114,16 +114,16 @@ discard block |
||
114 | 114 | $generatedDocumentation = file_get_contents($targetFile); |
115 | 115 | $compareDocumentation = file_get_contents($compareFile); |
116 | 116 | |
117 | - $parsedRouteOutput->transform(function (Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
118 | - return $routeGroup->transform(function (array $route) use ($generatedDocumentation, $compareDocumentation) { |
|
119 | - if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $existingRouteDoc)) { |
|
120 | - $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]); |
|
117 | + $parsedRouteOutput->transform(function(Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
118 | + return $routeGroup->transform(function(array $route) use ($generatedDocumentation, $compareDocumentation) { |
|
119 | + if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $existingRouteDoc)) { |
|
120 | + $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]); |
|
121 | 121 | if ($routeDocumentationChanged === false || $this->forceIt) { |
122 | 122 | if ($routeDocumentationChanged) { |
123 | - $this->output->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']); |
|
123 | + $this->output->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']); |
|
124 | 124 | } |
125 | 125 | } else { |
126 | - $this->output->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']); |
|
126 | + $this->output->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']); |
|
127 | 127 | $route['modified_output'] = $existingRouteDoc[0]; |
128 | 128 | } |
129 | 129 | } |
@@ -146,9 +146,9 @@ discard block |
||
146 | 146 | ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection) |
147 | 147 | ->with('parsedRoutes', $parsedRouteOutput); |
148 | 148 | |
149 | - $this->output->info('Writing index.md and source files to: '.$this->sourceOutputPath); |
|
149 | + $this->output->info('Writing index.md and source files to: ' . $this->sourceOutputPath); |
|
150 | 150 | |
151 | - if (! is_dir($this->sourceOutputPath)) { |
|
151 | + if (!is_dir($this->sourceOutputPath)) { |
|
152 | 152 | $documentarian = new Documentarian(); |
153 | 153 | $documentarian->create($this->sourceOutputPath); |
154 | 154 | } |
@@ -169,19 +169,19 @@ discard block |
||
169 | 169 | |
170 | 170 | file_put_contents($compareFile, $compareMarkdown); |
171 | 171 | |
172 | - $this->output->info('Wrote index.md and source files to: '.$this->sourceOutputPath); |
|
172 | + $this->output->info('Wrote index.md and source files to: ' . $this->sourceOutputPath); |
|
173 | 173 | } |
174 | 174 | |
175 | 175 | public function generateMarkdownOutputForEachRoute(Collection $parsedRoutes, array $settings): Collection |
176 | 176 | { |
177 | - $parsedRouteOutput = $parsedRoutes->map(function (Collection $routeGroup) use ($settings) { |
|
178 | - return $routeGroup->map(function (array $route) use ($settings) { |
|
179 | - if (count($route['cleanBodyParameters']) && ! isset($route['headers']['Content-Type'])) { |
|
177 | + $parsedRouteOutput = $parsedRoutes->map(function(Collection $routeGroup) use ($settings) { |
|
178 | + return $routeGroup->map(function(array $route) use ($settings) { |
|
179 | + if (count($route['cleanBodyParameters']) && !isset($route['headers']['Content-Type'])) { |
|
180 | 180 | // Set content type if the user forgot to set it |
181 | 181 | $route['headers']['Content-Type'] = 'application/json'; |
182 | 182 | } |
183 | 183 | |
184 | - $hasRequestOptions = ! empty($route['headers']) || ! empty($route['cleanQueryParameters']) || ! empty($route['cleanBodyParameters']); |
|
184 | + $hasRequestOptions = !empty($route['headers']) || !empty($route['cleanQueryParameters']) || !empty($route['cleanBodyParameters']); |
|
185 | 185 | $route['output'] = (string) view('apidoc::partials.route') |
186 | 186 | ->with('hasRequestOptions', $hasRequestOptions) |
187 | 187 | ->with('route', $route) |
@@ -230,18 +230,18 @@ discard block |
||
230 | 230 | |
231 | 231 | protected function getMarkdownToPrepend(): string |
232 | 232 | { |
233 | - $prependFile = $this->sourceOutputPath.'/source/prepend.md'; |
|
233 | + $prependFile = $this->sourceOutputPath . '/source/prepend.md'; |
|
234 | 234 | $prependFileContents = file_exists($prependFile) |
235 | - ? file_get_contents($prependFile)."\n" : ''; |
|
235 | + ? file_get_contents($prependFile) . "\n" : ''; |
|
236 | 236 | |
237 | 237 | return $prependFileContents; |
238 | 238 | } |
239 | 239 | |
240 | 240 | protected function getMarkdownToAppend(): string |
241 | 241 | { |
242 | - $appendFile = $this->sourceOutputPath.'/source/append.md'; |
|
242 | + $appendFile = $this->sourceOutputPath . '/source/append.md'; |
|
243 | 243 | $appendFileContents = file_exists($appendFile) |
244 | - ? "\n".file_get_contents($appendFile) : ''; |
|
244 | + ? "\n" . file_get_contents($appendFile) : ''; |
|
245 | 245 | |
246 | 246 | return $appendFileContents; |
247 | 247 | } |
@@ -249,7 +249,7 @@ discard block |
||
249 | 249 | protected function copyAssetsFromSourceFolderToPublicFolder(): void |
250 | 250 | { |
251 | 251 | $publicPath = 'public/docs'; |
252 | - if (! is_dir($publicPath)) { |
|
252 | + if (!is_dir($publicPath)) { |
|
253 | 253 | mkdir($publicPath, 0777, true); |
254 | 254 | mkdir("{$publicPath}/css"); |
255 | 255 | mkdir("{$publicPath}/js"); |
@@ -272,7 +272,7 @@ discard block |
||
272 | 272 | rename("{$this->sourceOutputPath}/index.html", "{$this->outputPath}/index.html"); |
273 | 273 | } else { |
274 | 274 | // Move output to resources/views |
275 | - if (! is_dir($this->outputPath)) { |
|
275 | + if (!is_dir($this->outputPath)) { |
|
276 | 276 | mkdir($this->outputPath); |
277 | 277 | } |
278 | 278 | rename("{$this->sourceOutputPath}/index.html", "$this->outputPath/index.blade.php"); |