1
|
|
|
<?php |
2
|
|
|
/** |
3
|
|
|
* Copyright © Vaimo Group. All rights reserved. |
4
|
|
|
* See LICENSE_VAIMO.txt for license details. |
5
|
|
|
*/ |
6
|
|
|
namespace Vaimo\ComposerChangelogs\Commands; |
7
|
|
|
|
8
|
|
|
use Symfony\Component\Console\Input\InputInterface; |
9
|
|
|
use Symfony\Component\Console\Output\OutputInterface; |
10
|
|
|
use Vaimo\ComposerChangelogs\Resolvers; |
11
|
|
|
|
12
|
|
|
use Vaimo\ComposerChangelogs\Factories; |
13
|
|
|
|
14
|
|
|
class GenerateCommand extends \Composer\Command\BaseCommand |
15
|
|
|
{ |
16
|
|
|
protected function configure() |
17
|
|
|
{ |
18
|
|
|
$this->setName('changelog:generate'); |
19
|
|
|
|
20
|
|
|
$this->setDescription('Generates documentation output from changelog source'); |
21
|
|
|
|
22
|
|
|
$this->addArgument( |
23
|
|
|
'name', |
24
|
|
|
\Symfony\Component\Console\Input\InputArgument::OPTIONAL, |
25
|
|
|
'Targeted package name. Default: root package' |
26
|
|
|
); |
27
|
|
|
|
28
|
|
|
$this->addOption( |
29
|
|
|
'--from-source', |
30
|
|
|
null, |
31
|
|
|
\Symfony\Component\Console\Input\InputOption::VALUE_NONE, |
32
|
|
|
'Extract configuration from vendor package instead of using global installation data' |
33
|
|
|
); |
34
|
|
|
|
35
|
|
|
$this->addOption( |
36
|
|
|
'--url', |
37
|
|
|
null, |
38
|
|
|
\Symfony\Component\Console\Input\InputOption::VALUE_OPTIONAL, |
39
|
|
|
'Repository URL to use for generating version-bound links for sources and comparisons' |
40
|
|
|
); |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
protected function execute(InputInterface $input, OutputInterface $output) |
44
|
|
|
{ |
45
|
|
|
$packageName = $input->getArgument('name'); |
46
|
|
|
|
47
|
|
|
$fromSource = $input->getOption('from-source'); |
48
|
|
|
$repositoryUrl = $input->getOption('url'); |
49
|
|
|
|
50
|
|
|
$composerRuntime = $this->getComposer(); |
|
|
|
|
51
|
|
|
|
52
|
|
|
$composerCtxFactory = new \Vaimo\ComposerChangelogs\Factories\ComposerContextFactory( |
53
|
|
|
$composerRuntime |
54
|
|
|
); |
55
|
|
|
|
56
|
|
|
$composerCtx = $composerCtxFactory->create(); |
57
|
|
|
|
58
|
|
|
$chLogRepoFactory = new Factories\ChangelogRepositoryFactory($composerCtx, $output); |
59
|
|
|
$chLogRepo = $chLogRepoFactory->create($fromSource); |
60
|
|
|
|
61
|
|
|
$changelog = $chLogRepo->getByPackageName( |
62
|
|
|
$packageName, |
63
|
|
|
$output->getVerbosity() |
64
|
|
|
); |
65
|
|
|
|
66
|
|
|
if ($changelog === null) { |
67
|
|
|
return 1; |
68
|
|
|
} |
69
|
|
|
|
70
|
|
|
$confResolverFactory = new Factories\Changelog\ConfigResolverFactory($composerCtx); |
71
|
|
|
|
72
|
|
|
$confResolver = $confResolverFactory->create($fromSource); |
73
|
|
|
|
74
|
|
|
$package = $changelog->getOwner(); |
75
|
|
|
|
76
|
|
|
$output->writeln( |
77
|
|
|
sprintf('Generating changelog output for <info>%s</info>', $package->getName()) |
78
|
|
|
); |
79
|
|
|
|
80
|
|
|
$infoResolver = new Resolvers\PackageInfoResolver( |
81
|
|
|
$composerRuntime->getInstallationManager() |
82
|
|
|
); |
83
|
|
|
|
84
|
|
|
$featureFlags = $confResolver->getFeatureFlags($package); |
85
|
|
|
|
86
|
|
|
$urlResolver = $this->createUrlResolver($repositoryUrl, $featureFlags); |
87
|
|
|
|
88
|
|
|
$docsGenerator = new \Vaimo\ComposerChangelogs\Generators\DocumentationGenerator( |
89
|
|
|
$confResolver, |
90
|
|
|
$infoResolver, |
91
|
|
|
$urlResolver |
92
|
|
|
); |
93
|
|
|
|
94
|
|
|
try { |
95
|
|
|
$docsGenerator->generate($package, $changelog->getReleases()); |
96
|
|
|
} catch (\Vaimo\ComposerChangelogs\Exceptions\GeneratorException $exception) { |
97
|
|
|
$output->writeln( |
98
|
|
|
sprintf('<error>%s</error>', $exception->getMessage()) |
99
|
|
|
); |
100
|
|
|
|
101
|
|
|
return 1; |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
$output->writeln('<info>Done</info>'); |
105
|
|
|
|
106
|
|
|
return 0; |
107
|
|
|
} |
108
|
|
|
|
109
|
|
|
private function createUrlResolver($repositoryUrl, array $featureFlags) |
110
|
|
|
{ |
111
|
|
|
if ($repositoryUrl !== null || !$featureFlags['links']) { |
112
|
|
|
return new Resolvers\Url\CustomSourceResolver($repositoryUrl); |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
$composerRuntime = $this->getComposer(); |
|
|
|
|
116
|
|
|
|
117
|
|
|
$infoResolver = new Resolvers\PackageInfoResolver( |
118
|
|
|
$composerRuntime->getInstallationManager() |
119
|
|
|
); |
120
|
|
|
|
121
|
|
|
return new Resolvers\Url\RemoteSourceResolver($infoResolver); |
122
|
|
|
} |
123
|
|
|
} |
124
|
|
|
|
This function has been deprecated. The supplier of the function has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the function will be removed and what other function to use instead.