Merge pull request #29 from imLymei/dev

Dev

Author: imLymei

CONTRIBUTING.md

@@ -4,31 +4,41 @@ Welcome to the project! We're glad you're here and interested in contributing. B
 
 ## How to Contribute
 
+### Repository Structure
+
+This repository uses a automated version release using the mains 3 branches:
+
+- **master**: Contains the code on the actual `@latest` package channel.
+- **beta**: Contains the code on the actual `@beta` package channel.
+- **dev**: Contains the code of actual development, every `BREAKING CHANGE` and `feat` commit must be done on this branch.
+
+### Step by Step
+
 1. **Fork the repository:** Click on the "Fork" button on the top right corner of the repository's page, then clone your fork locally.
 
-2. **Create a new branch:** Make your changes in a new branch created from the `main` branch. Choose a descriptive name for your branch related to the issue or feature you're working on.
+2. **Create a new branch:** Make your changes in a new branch created from the `dev` branch or `main` for `fix` or others specific situations. Choose a descriptive name for your branch related to the issue or feature you're working on.
 
 3. **Make your changes:** Implement the changes or additions you'd like to contribute. Please follow any existing coding style and conventions.
 
 4. **Test your changes:** Ensure that your changes do not break existing functionality. If you're adding new features, include tests to cover your code.
 
-5. **Commit your changes:** Make meaningful and atomic commits. Please provide a clear and descriptive commit message for each commit.
+5. **Commit your changes:** Make meaningful and atomic commits. Please provide a [clear and descriptive commit message](https://www.conventionalcommits.org/en/v1.0.0/#summary) for each commit.
 
 6. **Push your changes:** Once your changes are ready, push your branch to your fork of the repository.
 
 7. **Create a Pull Request (PR):** Go back to the original repository and navigate to the Pull Requests tab. Click on "New Pull Request" and choose your branch as the compare branch. Fill out the PR template with relevant information and details about your changes.
 
 8. **Review and address feedback:** Be open to feedback and iterate on your changes if necessary. Respond promptly to any comments or requests for changes from the maintainers.
 
-9. **Merge your PR:** Once your PR has been approved and all checks have passed, a maintainer will merge your changes into the main branch. Congratulations on your contribution!
+9. **Merge your PR:** Once your PR has been approved and all checks have passed, a maintainer will merge your changes into the respective branch. Congratulations on your contribution!
 
 ## Code of Conduct
 
 Please note that this project is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
 
 ## Contributor License Agreement (CLA)
 
-By contributing to this project, you agree to license your contributions under the [project's license](LICENSE.md).
+By contributing to this project, you agree to license your contributions under the [project's license](LICENSE).
 
 ## Help and Support
 

README.md

@@ -1,6 +1,6 @@
-# Foji
+# Foji ⚒️
 
-Foji is a command-line interface (CLI) tool designed to help you automate and manage your coding tasks. It allows you to run custom codes and handle custom parameters.
+Foji is a powerful command-line interface (CLI) tool crafted to streamline and automate long or repetitive commands in your daily workflow. With Foji, you can define and execute custom commands, integrate custom parameters, and simplify complex processes, reducing the need to repeatedly type lengthy commands.
 
 ## Features
 
@@ -16,19 +16,21 @@ Foji is a command-line interface (CLI) tool designed to help you automate and ma
 - [x] Configuration can be downloaded from cloud
 - [x] Local configuration can be synced from cloud
 
-## Installation
+## System Dependencies
+
+Foji makes use of [Node.js](https://nodejs.org/) package manager to be installed.
 
-Before installing Foji, make sure you have [Node.js](https://nodejs.org/) installed on your machine.
+## Installation
 
-To install Foji globally, run the following command:
+To install Foji run the following command:
 
 ```shell
 npm i foji -g
 ```
 
 ## Usage
 
-Foji saves your commands and your configuration url at it's configuration file (`~/.config/foji.json`). You can access the `.config` directory using `foji config` or open the file directly using `foji config -f` command.
+Foji saves your commands and your configurations at it's configuration file (`~/.config/foji.json`). You can access the `.config` directory using `foji config` or open the file directly using `foji config -f` command.
 
 ### Running a Command
 
@@ -37,13 +39,14 @@ To run a `command` just use:
 ```shell
 foji [command name] [...command args]
 ```
+
 Simple as that.
 
 If you don't provide a valid command name Foji will list all available commands, it includes default commands (eg.: `add`, `remove` and `sync`) and your own commands.
 
 ### Skipping a Argument
 
-You also can skip a (optional) argument using "_":
+You also can skip a (optional) argument using "\_":
 
 ```shell
 foji [command name] [argument one] _ [argument three]
@@ -81,10 +84,10 @@ All `commands` can have four types of `arguments`:
 
 3. Optional arguments with default values:
 
-- Similar to optional arguments, but if not provided, they will add a default value. `<options??--ts --tailwind --src>`
+- Similar to optional arguments, but if not provided, they will add a default value. `<options ?? --ts --tailwind --src>`
 
 ```json
-"command":"echo <requiredArgumentOne> <optionalArgumentOne??My Default Value>"
+"command":"echo <requiredArgumentOne> <optionalArgumentOne ?? My Default Value>"
 ```
 
 4. Ternaries:
@@ -97,18 +100,6 @@ All `commands` can have four types of `arguments`:
 
 Note that all `Required arguments` must be provided **BEFORE** any of the other arguments
 
-incorrect:
-
-```json
-"command": "do command <argOne?> <argTwo>"
-```
-
-correct:
-
-```json
-"command": "do command <argOne> <argTwo?>"
-```
-
 ### Remove a Command
 
 To remove a `command` you can use the `remove` command

src/commands/index.ts

@@ -23,6 +23,7 @@ const program = new Command()
   .argument('[command]', 'Command that you want to run')
   .argument('[args...]', 'Arguments for the command')
   .option('-d, --debug', 'Enable debugging features', false)
+  .passThroughOptions(true)
   .action(async (commandName?: string, args?: string[]) => {
     const userConfig = getConfig();
     const configCommands = userConfig.commands;

src/lib/utils.ts

@@ -15,6 +15,7 @@ type CommandArg = {
   isOptional?: boolean;
   defaultValue?: string;
   alternativeValue?: string;
+  isSpread?: boolean;
 };
 
 export const USER_DIRECTORY = os.homedir();
@@ -111,13 +112,14 @@ export function formatCommand(
 
   let allowRequired = true;
 
-  const commandArguments: CommandArg[] = commandArgs.map((arg) => {
+  const commandArguments: CommandArg[] = commandArgs.map((arg, index) => {
     const object: CommandArg = { name: '' };
 
     const hasDefaultValue = arg.includes('??');
     const hasElse = !hasDefaultValue && arg.includes(':');
     const isTernary = !hasDefaultValue && hasElse && arg.includes('?');
     const isOptional = !hasDefaultValue && !hasElse && arg.includes('?');
+    const isSpread = arg.includes('...');
 
     // TODO - make linting function
 
@@ -141,6 +143,16 @@ export function formatCommand(
       object.name = name;
       object.isOptional = true;
 
+      allowRequired = false;
+    } else if (isSpread) {
+      if (index !== commandArgs.length - 1)
+        error('You can only use a spread argument at the last position');
+
+      const name = arg.replace('...', '').trim();
+      object.name = name;
+      object.isOptional = true;
+      object.isSpread = true;
+
       allowRequired = false;
     } else {
       if (!allowRequired)
@@ -164,7 +176,10 @@ export function formatCommand(
 
   for (let index = 0; index < commandArguments.length; index++) {
     const arg = commandArguments[index];
-    let argValue = arg.alternativeValue
+
+    let argValue = arg.isSpread
+      ? args.slice(index).join(' ')
+      : arg.alternativeValue
       ? args[index]
         ? arg.defaultValue
         : arg.alternativeValue