• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

devonfw / IDEasy / 26101908636

19 May 2026 01:55PM UTC coverage: 70.982% (+0.003%) from 70.979%
26101908636

Pull #1859

github

web-flow
Merge cf4a7f717 into b4eeee25f
Pull Request #1859: #1392: Smart completions

4472 of 6964 branches covered (64.22%)

Branch coverage included in aggregate %.

11521 of 15567 relevant lines covered (74.01%)

3.14 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.21
cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManagerImpl.java
1
package com.devonfw.tools.ide.commandlet;
2

3
import java.util.Collection;
4
import java.util.Collections;
5
import java.util.HashMap;
6
import java.util.Iterator;
7
import java.util.List;
8
import java.util.Map;
9
import java.util.NoSuchElementException;
10

11
import org.slf4j.Logger;
12
import org.slf4j.LoggerFactory;
13

14
import com.devonfw.tools.ide.cli.CliArgument;
15
import com.devonfw.tools.ide.cli.CliArguments;
16
import com.devonfw.tools.ide.completion.CompletionCandidateCollector;
17
import com.devonfw.tools.ide.context.IdeContext;
18
import com.devonfw.tools.ide.git.repository.RepositoryCommandlet;
19
import com.devonfw.tools.ide.property.KeywordProperty;
20
import com.devonfw.tools.ide.property.Property;
21
import com.devonfw.tools.ide.tool.androidstudio.AndroidStudio;
22
import com.devonfw.tools.ide.tool.aws.Aws;
23
import com.devonfw.tools.ide.tool.az.Azure;
24
import com.devonfw.tools.ide.tool.cdk.Cdk;
25
import com.devonfw.tools.ide.tool.claude.Claude;
26
import com.devonfw.tools.ide.tool.copilot.Copilot;
27
import com.devonfw.tools.ide.tool.corepack.Corepack;
28
import com.devonfw.tools.ide.tool.docker.Docker;
29
import com.devonfw.tools.ide.tool.dotnet.DotNet;
30
import com.devonfw.tools.ide.tool.eclipse.Eclipse;
31
import com.devonfw.tools.ide.tool.gcviewer.GcViewer;
32
import com.devonfw.tools.ide.tool.gh.Gh;
33
import com.devonfw.tools.ide.tool.go.Go;
34
import com.devonfw.tools.ide.tool.graalvm.GraalVm;
35
import com.devonfw.tools.ide.tool.gradle.Gradle;
36
import com.devonfw.tools.ide.tool.gui.Gui;
37
import com.devonfw.tools.ide.tool.helm.Helm;
38
import com.devonfw.tools.ide.tool.intellij.Intellij;
39
import com.devonfw.tools.ide.tool.jasypt.Jasypt;
40
import com.devonfw.tools.ide.tool.java.Java;
41
import com.devonfw.tools.ide.tool.jmc.Jmc;
42
import com.devonfw.tools.ide.tool.kotlinc.Kotlinc;
43
import com.devonfw.tools.ide.tool.kotlinc.KotlincNative;
44
import com.devonfw.tools.ide.tool.kubectl.KubeCtl;
45
import com.devonfw.tools.ide.tool.lazydocker.LazyDocker;
46
import com.devonfw.tools.ide.tool.mvn.Mvn;
47
import com.devonfw.tools.ide.tool.nest.Nest;
48
import com.devonfw.tools.ide.tool.ng.Ng;
49
import com.devonfw.tools.ide.tool.node.Node;
50
import com.devonfw.tools.ide.tool.npm.Npm;
51
import com.devonfw.tools.ide.tool.oc.Oc;
52
import com.devonfw.tools.ide.tool.pgadmin.PgAdmin;
53
import com.devonfw.tools.ide.tool.pip.Pip;
54
import com.devonfw.tools.ide.tool.pycharm.Pycharm;
55
import com.devonfw.tools.ide.tool.python.Python;
56
import com.devonfw.tools.ide.tool.quarkus.Quarkus;
57
import com.devonfw.tools.ide.tool.sonar.Sonar;
58
import com.devonfw.tools.ide.tool.spring.Spring;
59
import com.devonfw.tools.ide.tool.squirrelsql.SquirrelSql;
60
import com.devonfw.tools.ide.tool.terraform.Terraform;
61
import com.devonfw.tools.ide.tool.tomcat.Tomcat;
62
import com.devonfw.tools.ide.tool.uv.Uv;
63
import com.devonfw.tools.ide.tool.vscode.Vscode;
64
import com.devonfw.tools.ide.tool.yarn.Yarn;
65

66
/**
67
 * Implementation of {@link CommandletManager}.
68
 */
69
public class CommandletManagerImpl implements CommandletManager {
70

71
  private static final Logger LOG = LoggerFactory.getLogger(CommandletManagerImpl.class);
4✔
72

73
  private final IdeContext context;
74

75
  private final Map<Class<? extends Commandlet>, Commandlet> commandletTypeMap;
76

77
  private final Map<String, Commandlet> commandletNameMap;
78

79
  private final Map<String, Commandlet> firstKeywordMap;
80

81
  private final Collection<Commandlet> commandlets;
82

83
  /**
84
   * The constructor.
85
   *
86
   * @param context the {@link IdeContext}.
87
   */
88
  public CommandletManagerImpl(IdeContext context) {
89

90
    super();
2✔
91
    this.context = context;
3✔
92
    this.commandletTypeMap = new HashMap<>();
5✔
93
    this.commandletNameMap = new HashMap<>();
5✔
94
    this.firstKeywordMap = new HashMap<>();
5✔
95
    this.commandlets = Collections.unmodifiableCollection(this.commandletTypeMap.values());
6✔
96
    add(new HelpCommandlet(context));
6✔
97
    add(new EnvironmentCommandlet(context));
6✔
98
    add(new CompleteCommandlet(context));
6✔
99
    add(new ShellCommandlet(context));
6✔
100
    add(new InstallCommandlet(context));
6✔
101
    add(new VersionSetCommandlet(context));
6✔
102
    add(new VersionGetCommandlet(context));
6✔
103
    add(new VersionListCommandlet(context));
6✔
104
    add(new EditionGetCommandlet(context));
6✔
105
    add(new EditionSetCommandlet(context));
6✔
106
    add(new EditionListCommandlet(context));
6✔
107
    add(new VersionCommandlet(context));
6✔
108
    add(new StatusCommandlet(context));
6✔
109
    add(new RepositoryCommandlet(context));
6✔
110
    add(new UninstallCommandlet(context));
6✔
111
    add(new UpdateCommandlet(context));
6✔
112
    add(new UpgradeSettingsCommandlet(context));
6✔
113
    add(new CreateCommandlet(context));
6✔
114
    add(new BuildCommandlet(context));
6✔
115
    add(new InstallPluginCommandlet(context));
6✔
116
    add(new UninstallPluginCommandlet(context));
6✔
117
    add(new UpgradeCommandlet(context));
6✔
118
    add(new TruststoreCommandlet(context));
6✔
119
    add(new Gh(context));
6✔
120
    add(new Helm(context));
6✔
121
    add(new Java(context));
6✔
122
    add(new Ng(context));
6✔
123
    add(new Node(context));
6✔
124
    add(new Npm(context));
6✔
125
    add(new Mvn(context));
6✔
126
    add(new GcViewer(context));
6✔
127
    add(new Gradle(context));
6✔
128
    add(new Eclipse(context));
6✔
129
    add(new Terraform(context));
6✔
130
    add(new Oc(context));
6✔
131
    add(new Quarkus(context));
6✔
132
    add(new Kotlinc(context));
6✔
133
    add(new KotlincNative(context));
6✔
134
    add(new KubeCtl(context));
6✔
135
    add(new Tomcat(context));
6✔
136
    add(new Vscode(context));
6✔
137
    add(new Azure(context));
6✔
138
    add(new Aws(context));
6✔
139
    add(new Jmc(context));
6✔
140
    add(new DotNet(context));
6✔
141
    add(new Intellij(context));
6✔
142
    add(new Jasypt(context));
6✔
143
    add(new Docker(context));
6✔
144
    add(new Sonar(context));
6✔
145
    add(new AndroidStudio(context));
6✔
146
    add(new GraalVm(context));
6✔
147
    add(new PgAdmin(context));
6✔
148
    add(new LazyDocker(context));
6✔
149
    add(new Python(context));
6✔
150
    add(new Pycharm(context));
6✔
151
    add(new Spring(context));
6✔
152
    add(new Uv(context));
6✔
153
    add(new Yarn(context));
6✔
154
    add(new Copilot(context));
6✔
155
    add(new Corepack(context));
6✔
156
    add(new Pip(context));
6✔
157
    add(new Go(context));
6✔
158
    add(new Gui(context));
6✔
159
    add(new SquirrelSql(context));
6✔
160
    add(new Nest(context));
6✔
161
    add(new Cdk(context));
6✔
162
    add(new Claude(context));
6✔
163
  }
1✔
164

165
  /**
166
   * @param commandlet the {@link Commandlet} to add.
167
   */
168
  protected void add(Commandlet commandlet) {
169

170
    boolean hasRequiredProperty = false;
2✔
171
    List<Property<?>> properties = commandlet.getProperties();
3✔
172
    int propertyCount = properties.size();
3✔
173
    KeywordProperty keyword = commandlet.getFirstKeyword();
3✔
174
    if (keyword != null) {
2!
175
      String name = keyword.getName();
3✔
176
      registerKeyword(name, commandlet);
4✔
177

178
      String alias = keyword.getAlias();
3✔
179
      if (alias != null) {
2✔
180
        registerKeyword(alias, commandlet);
4✔
181
      }
182
    }
183
    for (int i = 0; i < propertyCount; i++) {
5!
184
      Property<?> property = properties.get(i);
5✔
185
      if (property.isRequired()) {
3!
186
        hasRequiredProperty = true;
2✔
187
        break;
1✔
188
      }
189
    }
190
    if (!hasRequiredProperty) {
2!
191
      throw new IllegalStateException("Commandlet " + commandlet + " must have at least one mandatory property!");
×
192
    }
193
    this.commandletTypeMap.put(commandlet.getClass(), commandlet);
7✔
194
    Commandlet duplicate = this.commandletNameMap.put(commandlet.getName(), commandlet);
8✔
195
    if (duplicate != null) {
2!
196
      throw new IllegalStateException("Commandlet " + commandlet + " has the same name as " + duplicate);
×
197
    }
198
  }
1✔
199

200
  private void registerKeyword(String keyword, Commandlet commandlet) {
201

202
    Commandlet duplicate = this.firstKeywordMap.putIfAbsent(keyword, commandlet);
7✔
203
    if (duplicate != null) {
2!
204
      LOG.debug("Duplicate keyword {} already used by {} so it cannot be associated also with {}", keyword, duplicate, commandlet);
×
205
    }
206
  }
1✔
207

208
  @Override
209
  public Collection<Commandlet> getCommandlets() {
210

211
    return this.commandlets;
3✔
212
  }
213

214
  @Override
215
  public <C extends Commandlet> C getCommandlet(Class<C> commandletType) {
216

217
    Commandlet commandlet = this.commandletTypeMap.get(commandletType);
6✔
218
    if (commandlet == null) {
2!
219
      throw new IllegalStateException("Commandlet for type " + commandletType + " is not registered!");
×
220
    }
221
    return commandletType.cast(commandlet);
5✔
222
  }
223

224
  @Override
225
  public Commandlet getCommandlet(String name) {
226

227
    return this.commandletNameMap.get(name);
6✔
228
  }
229

230
  @Override
231
  public Commandlet getCommandletByFirstKeyword(String keyword) {
232

233
    return this.firstKeywordMap.get(keyword);
6✔
234
  }
235

236
  @Override
237
  public void collectCompletionCandidates(CliArguments arguments,
238
                                          CompletionCandidateCollector collector) {
239
    CliArgument current = arguments.current();
3✔
240
    if (current.isStart()) {
3✔
241
      arguments.next();
3✔
242
      current = arguments.current();
3✔
243
    }
244
    if (current.isEnd()) {
3!
245
      return;
×
246
    }
247

248
    for (Commandlet cmd : this.getCommandlets()) {
11✔
249
      if (this.context.isTest() || !cmd.isIdeHomeRequired() || this.context.getIdeHome() != null) {
4!
250
        KeywordProperty firstKeyword = cmd.getFirstKeyword();
3✔
251
        if (firstKeyword != null && !firstKeyword.isPlaceholder()) {
5!
252
          firstKeyword.apply(arguments, this.context, cmd, collector);
8✔
253
        }
254
      }
255
    }
1✔
256
  }
1✔
257

258
  @Override
259
  public Iterator<Commandlet> findCommandlet(CliArguments arguments, CompletionCandidateCollector collector) {
260

261
    CliArgument current = arguments.current();
3✔
262
    if (current.isStart()) {
3✔
263
      arguments.next();
3✔
264
      current = arguments.current();
3✔
265
    }
266
    if (current.isEnd()) {
3✔
267
      return Collections.emptyIterator();
2✔
268
    }
269
    String keyword = current.get();
3✔
270
    Commandlet commandlet = getCommandletByFirstKeyword(keyword);
4✔
271
    if ((commandlet == null) && (collector == null)) {
4!
272
      return Collections.emptyIterator();
2✔
273
    }
274
    return new CommandletFinder(commandlet, arguments.copy(), collector);
9✔
275
  }
276

277
  private final class CommandletFinder implements Iterator<Commandlet> {
1✔
278

279
    private final Commandlet firstCandidate;
280

281
    private final Iterator<Commandlet> commandletIterator;
282

283
    private final CliArguments arguments;
284

285
    private final CompletionCandidateCollector collector;
286

287
    private Commandlet next;
288

289
    private CommandletFinder(Commandlet firstCandidate, CliArguments arguments, CompletionCandidateCollector collector) {
8✔
290

291
      this.firstCandidate = firstCandidate;
3✔
292
      this.commandletIterator = getCommandlets().iterator();
5✔
293
      this.arguments = arguments;
3✔
294
      this.collector = collector;
3✔
295
      if (isSuitable(firstCandidate)) {
4!
296
        this.next = firstCandidate;
4✔
297
      } else {
298
        this.next = findNext();
×
299
      }
300
    }
1✔
301

302
    @Override
303
    public boolean hasNext() {
304

305
      return this.next != null;
7✔
306
    }
307

308
    @Override
309
    public Commandlet next() {
310

311
      if (this.next == null) {
3!
312
        throw new NoSuchElementException();
×
313
      }
314
      Commandlet result = this.next;
3✔
315
      this.next = findNext();
4✔
316
      return result;
2✔
317
    }
318

319
    private boolean isSuitable(Commandlet commandlet) {
320

321
      return (commandlet != null) && (!commandlet.isIdeHomeRequired() || (context.getIdeHome() != null));
8!
322
    }
323

324
    private Commandlet findNext() {
325

326
      while (this.commandletIterator.hasNext()) {
4✔
327
        Commandlet cmd = this.commandletIterator.next();
5✔
328
        if ((cmd != this.firstCandidate) && isSuitable(cmd)) {
8!
329
          List<Property<?>> properties = cmd.getProperties();
3✔
330
          // validation should already be done in add method and could be removed here...
331
          if (properties.isEmpty()) {
3!
332
            assert false : cmd.getClass().getSimpleName() + " has no properties!";
×
333
          } else {
334
            Property<?> property = properties.getFirst();
4✔
335
            if (property instanceof KeywordProperty) {
3!
336
              boolean matches = property.apply(arguments.copy(), context, cmd, this.collector);
12✔
337
              if (matches) {
2!
338
                return cmd;
×
339
              }
340
            } else {
1✔
341
              assert false : cmd.getClass().getSimpleName() + " is invalid as first property must be keyword property but is " + property;
×
342
            }
343
          }
344
        }
345
      }
1✔
346
      return null;
2✔
347
    }
348
  }
349
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc