Merge pull request #19 from BuildCLI/develop

Develop to main

Author: omatheusmesmo

.vitepress/config.mts

@@ -100,28 +100,45 @@ function sidebarFAQ(): DefaultTheme.SidebarItem[] {
 function sidebarCommands(): DefaultTheme.SidebarItem[] {
     return [
         {
-            text: 'Autocomplete',
-            link: 'autocomplete',
+            text: 'About',
+            link: 'about',
         },
         {
-            text: 'Project',
-            link: 'project',
+            text: 'AI',
+            link: 'ai',
         },
         {
-            text: 'About',
-            link: 'about',
+            text: 'Autocomplete',
+            link: 'autocomplete',
         },
         {
-            text: 'Version',
-            link: 'version',
+            text: 'Changelog',
+            link: 'changelog',
+        },
+        {
+            text: 'Config',
+            link: 'config',
         },
         {
             text: 'Doctor',
             link: 'doctor',
         },
+        
         {
-            text: 'Changelog',
-            link: 'changelog',
+            text: 'Hook',
+            link: 'hook',
+        },
+        {
+            text: 'Project',
+            link: 'project',
+        },
+        {
+            text: 'Run',
+            link: 'run',
+        },
+        {
+            text: 'Version',
+            link: 'version',
         },
     ];
 }

src/commands/ai.md

@@ -0,0 +1,61 @@
+
+# `ai code`
+
+## Description
+
+Command to use ai features.
+
+## Usage
+
+```bash
+buildcli ai code [subcommand] [options] [path]
+```
+
+## Subcommands
+
+| Subcommand      | Description                                 |
+|-----------------|---------------------------------------------|
+| `comment, c`    | Comments out the selected code.                           |
+| `document, docs`    | Generates documentation for the project code.                           |
+| `test, t`    | Automatically generates unit tests for source code files using AI. Scans specified files or directories, identifies source files based on provided extensions, and utilizes an AI-powered service to generate corresponding test code. Supports interactive confirmation or auto-acceptance of generated tests.                           |
+
+
+## Options
+
+| Option          | Description                                         |
+|-----------------|-----------------------------------------------------|
+| `-c, --context`    | Overwrite the default AI prompt.         |
+| `--ext, --extensions`    | java, kt, scala, groovy.         |
+
+
+## Examples
+
+### Example 1
+
+Generates code review via the terminal with a custom prompt.
+
+```bash
+buildcli ai code comment src/main/java/org/myproject --context "Make a quick code review"
+```
+
+### Example 2
+
+Documents all project code files with Javadocs.
+
+```bash
+buildcli ai code docs src/main/java/org/myproject
+```
+
+### Example 3
+
+Automatically generates unit tests for source code files using AI.
+
+```bash
+buildcli ai code test src/main/java/org/myproject
+```
+
+
+## See Also
+
+- [autocomplete](autocomplete.md)
+- [about](about.md)

src/commands/config.md

@@ -0,0 +1,80 @@
+# `config`
+
+## Description
+Analyzes the environment to ensure all necessary tools and
+                      dependencies are available and functioning correctly.
+                      Provides subcommands for diagnosing issues and applying
+                      fixes, ensuring smooth execution of other commands.
+
+## Usage
+
+```bash
+buildcli config [options] [subcommands]
+```
+
+## Subcommands
+
+| Option             | Description                                                                                                               |
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `set`, `s`  | Set configuration properties for BuildCLI. |
+| `clear`, `c`   | Clear config file                                                    |
+| `init`, `i`, `create`  | Initializes a new configuration context for BuildCLI. |
+| `print`, `p`, `show`,`list`   | Prints the current configuration.                                                    |
+| `remove`, `rm`, `r`  | Removes specified configuration properties from BuildCLI. |
+
+
+## Options
+
+| Option             | Description                                                                                                               |
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `--global`, `-g`  | Release version to label the generated changelog (e.g., 1.2.3). If not specified, use the latest Git tag or 'Unreleased'. |
+| `--local`, `-l`   | Output format. Supported: markdown, html and json. (default: markdown)                                                    |
+
+
+## Examples
+
+### Example 1
+
+Set local configuration properties for BuildCLI.
+
+```bash
+buildcli -l init
+```
+
+### Example 2
+
+Defines AI vendor as Ollama.
+
+```bash
+buildcli -g set buildcli.ai.vendor=ollama
+```
+
+### Example 3
+
+Print BuildCLI configurations
+
+```bash
+buildcli print
+```
+
+### Example 4
+
+Removes specified configuration properties from BuildCLI.
+
+```bash
+buildcli remove set buildcli.ai.vendor=ollama
+```
+
+### Example 5
+
+Clear config file
+
+```bash
+buildcli clear
+```
+
+## See Also
+
+- [doctor](doctor.md)
+- [project](project.md)
+- [autocomplete](autocomplete.md)

src/commands/hook.md

@@ -0,0 +1,53 @@
+# `hook`
+
+## Description
+Manage hooks. Hooks are commands that are executed before or after a specific command.
+
+## Usage
+
+```bash
+buildcli hook [subcommands] <args>
+```
+
+## Subcommands
+
+| Option             | Description                                                                                                               |
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `add`  | Add a hook to a command. Args: `[before/after] "[command]" "[hookCommand]"`|
+| `remove`   | Remove a hook from a command. Args: `[before/after] "[command]"`                                                    |
+| `list`  | Remove a hook from a command. No args are needed. |
+
+
+
+## Examples
+
+### Example 1
+
+This will execute 'project clean' before 'project build'.
+You can use `b` as an alias for `before` and a for `after`.
+
+```bash
+buildcli hook add b "project build" "project
+```
+
+### Example 2
+
+This will remove any command that run after 'project build'
+
+```bash
+buildcli hook remove a "project build"
+```
+
+### Example 3
+
+This will display all registered hooks and their associated commands.
+
+```bash
+buildcli list
+```
+
+## See Also
+
+- [ai](ai.md)
+<!-- - [plugin](plugin.md) -->
+- [config](config.md)

src/commands/project.md

@@ -24,7 +24,6 @@ buildcli project [subcommand] [options] [arguments]
 | `init, i`       | Initializes a new project.                  |
 | `cleanup, clean`| Cleans up the project.                      |
 | `update, up`    | Updates the project.                        |
-| `document-code, docs` | Documents the project code.           |
 
 ## Options
 

src/commands/run.md

@@ -0,0 +1,47 @@
+# `run`
+
+## Description
+Run projects or features related to docker 
+
+## Usage
+
+```bash
+buildcli run [<file-or-dir>] [<args>...] [SUBCOMMAND]
+```
+
+## Parameters
+
+| Option             | Description                                                                                                               |
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `[<file-or-dir>]`  | The file or directory to run. If a directory, it will package and run the project.|
+| `[<args>...]`   | Arguments to pass to the program.        |
+
+## Subcommands
+
+| Option             | Description                                                                                                               |
+|--------------------|---------------------------------------------------------------------------------------------------------------------------|
+| `dockerfile`, `docker`, `d`   | Builds and runs a Docker image for the project. Builds the Docker image and starts the container, exposing port 8080.|
+
+## Examples
+
+### Example 1
+
+This will execute `Hello.java` file.
+```bash
+buildcli run Hello.java
+```
+
+### Example 2
+
+This will the docker file named "yourdockerfile"
+
+```bash
+buildcli run docker -n "yourdockerfile"
+```
+
+
+## See Also
+
+- [ai](ai.md)
+<!-- - [plugin](plugin.md)-->
+- [config](config.md) 

src/installation.md

@@ -25,10 +25,10 @@ if not exist "%USERPROFILE%\bin" mkdir "%USERPROFILE%\bin"
 copy /Y cli\target\buildcli.jar "%USERPROFILE%\bin\buildcli.jar"
 (
  echo @echo off
- echo java --enable-preview --add-modules jdk.incubator.vector -jar "%%USERPROFILE%%\bin\buildcli.jar"
+ echo java --enable-preview --add-modules jdk.incubator.vector -jar "%USERPROFILE%\bin\buildcli.jar %*"
 ) > "%USERPROFILE%\bin\buildcli.bat"
 echo %PATH% | findstr /I "%USERPROFILE%\bin" >nul || (
- setx PATH "%PATH%;%USERPROFILE%\bin"
+ setx PATH "%%PATH%%;%USERPROFILE%\bin"
 )
 endlocal
 ```