Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit 7be2d5d

Browse files
committed
refine command names
1 parent 62c35ac commit 7be2d5d

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

docs/modules/ROOT/pages/ai-guide.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `--preview` option of the `spring ai add` command generates the `README.md`
2323
Once you are satisfied with the generated README.md file, you can apply it to your code base using the following command:
2424

2525
```bash
26-
spring readme apply <Name of the readme file>
26+
spring guide apply <Name of the guide markdown file>
2727
```
2828

2929
For further improvements and accuracy, you can ChatGPT to rewrite the description using the --rewrite option:
@@ -87,7 +87,7 @@ spring ai add "JPA functionality" --preview
8787
This command creates the file https://github.com/spring-projects-experimental/spring-cli/blob/main/src/test/resources/ai/sample-output/README-ai-jpa-simple-description.md[README-ai-jpa.md].
8888
Remember, it doesn't modify your project, but it provides the opportunity to review the content and determine its suitability for your specific requirements.
8989

90-
If the generated instructions meet your needs, you can apply the changes to your code base by using the command `spring readme apply README-ai-jpa.md`.
90+
If the generated instructions meet your needs, you can apply the changes to your code base by using the command `spring guide apply README-ai-jpa.md`.
9191

9292
== Iterating to get what you want
9393

@@ -128,7 +128,7 @@ Once you are satisfied with the generated `README` file, apply the changes descr
128128

129129
[source, bash]
130130
----
131-
spring readme apply README-ai-jpa.md
131+
spring guide apply README-ai-jpa.md
132132
----
133133

134134

docs/modules/ROOT/pages/readme-command-guide.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ For example if there is a file named `README-ai-jpa.md` in the root of your proj
66

77
[source, bash]
88
----
9-
spring readme apply README-ai-jpa.md
9+
spring guide apply README-ai-jpa.md
1010
----
1111

1212
will apply the changes. You can keep track of what has changed by commiting your work using Git before applying the change.

src/main/java/org/springframework/cli/command/ReadmeCommands.java renamed to src/main/java/org/springframework/cli/command/GuideCommands.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@
2424
import org.springframework.shell.command.annotation.Command;
2525
import org.springframework.shell.command.annotation.Option;
2626

27-
@Command(command = "readme", group = "Readme")
28-
public class ReadmeCommands {
27+
@Command(command = "guide", group = "Guide")
28+
public class GuideCommands {
2929

3030
private final TerminalMessage terminalMessage;
3131

3232
private final OpenAiHandler openAiHandler;
3333

3434
@Autowired
35-
public ReadmeCommands(TerminalMessage terminalMessage) {
35+
public GuideCommands(TerminalMessage terminalMessage) {
3636
this.terminalMessage = terminalMessage;
3737
this.openAiHandler = new OpenAiHandler(new GenerateCodeAiService(this.terminalMessage));
3838
}
3939

40-
public ReadmeCommands(OpenAiHandler openAiHandler, TerminalMessage terminalMessage) {
40+
public GuideCommands(OpenAiHandler openAiHandler, TerminalMessage terminalMessage) {
4141
this.terminalMessage = terminalMessage;
4242
this.openAiHandler = openAiHandler;
4343
}

src/main/java/org/springframework/cli/command/InitializrCommands.java renamed to src/main/java/org/springframework/cli/command/InitializerCommands.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@
5757
*
5858
* @author Janne Valkealahti
5959
*/
60-
@Command(command = "initializr", group = "Initializr")
61-
public class InitializrCommands extends AbstractShellComponent {
60+
@Command(command = "initializer", group = "Initializer")
61+
public class InitializerCommands extends AbstractShellComponent {
6262

6363
private final static String PATH_NAME = "Path";
6464
private final static String PATH_ID = "path";
@@ -106,8 +106,8 @@ public class InitializrCommands extends AbstractShellComponent {
106106
private final SpringCliUserConfig springCliUserConfig;
107107
private final SpringCliProperties springCliProperties;
108108

109-
InitializrCommands(InitializrClientCache clientCache, ComponentFlow.Builder componentFlowBuilder,
110-
SpringCliUserConfig springCliUserConfig, SpringCliProperties springCliProperties) {
109+
InitializerCommands(InitializrClientCache clientCache, ComponentFlow.Builder componentFlowBuilder,
110+
SpringCliUserConfig springCliUserConfig, SpringCliProperties springCliProperties) {
111111
this.clientCache = clientCache;
112112
this.componentFlowBuilder = componentFlowBuilder;
113113
this.springCliUserConfig = springCliUserConfig;

src/main/java/org/springframework/cli/command/ProjectCatalogCommands.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
import org.springframework.util.ObjectUtils;
5151
import org.springframework.util.StringUtils;
5252

53-
@Command(command = "project-catalog", group = "Catalog")
53+
@Command(command = "project-catalog", group = "Project Catalog")
5454
public class ProjectCatalogCommands extends AbstractSpringCliCommands {
5555

5656
private static final Logger logger = LoggerFactory.getLogger(ProjectCatalogCommands.class);

0 commit comments

Comments
 (0)