depflow 2.0.0 → 2.0.1

package/README.md

@@ -1,89 +1,100 @@
-# 🚀 Dependency Flow
+# 🚀 DepFlow (Dependency Flow)
 
-This project provides a lightweight, straightforward dependency manager that leverages Git repositories. It's designed for simplicity and efficiency, allowing you to manage project dependencies directly from their source repositories without the complexity of larger package managers.
+**DepFlow** is a lightweight, high-performance dependency manager that leverages Git repositories and NPM packages to orchestrate your project's infrastructure. Designed for the **NetFeez** ecosystem, it allows you to manage dependencies directly from their source without the overhead of traditional package managers.
 
-This tool is actively used in real-world projects, which ensures it is continuously improved and enhanced with practical features based on actual usage.
+Starting with **v2.0.0**, DepFlow introduces a schema-driven architecture that automatically configures your development environment, providing a seamless experience in editors like VSCode.
 
 ---
 
 # 💾 Installation
 
-Install the Dependency Manager globally using **npm**:
+Install DepFlow globally using **npm**:
 
 ```console
-npm install -g depflow
+npm install -g @netfeez/depflow
 ```
 
-> [!NOTE]
-> A global installation (`-g`) makes the `dep` command available from any directory in your terminal.
+> [!TIP]
+> Global installation makes the `dep` command available everywhere. For version 2.0.0, ensure you are using the `@netfeez` scope.
 
 ---
 
 # 💻 CLI Usage
 
-You can interact with the dependency flow in two ways:
-
-1.  **Interactive Mode**: Run `dep` without any arguments to open an interactive command-line interface.
-2.  **Direct Command**: Execute commands directly, for example: `dep list`.
+DepFlow offers a clean interface for managing your project's lifecycle:
 
 ### Commands
 
 | Command | Usage | Description |
 |---|---|---|
-| `list` | `dep list` | Lists all dependencies configured in `depFlow.json`. |
-| `add` | `dep add <repo_url> [name]` | Adds a new dependency to your configuration. |
-| `remove`| `dep remove <name_or_repo_url>` | Removes a dependency using its name or repository URL. |
-| `install`| `dep install [name...]`| Clones and sets up all dependencies, or specific ones. |
-| `uninstall`| `dep uninstall [name...]`| Removes the files of all, or specific, dependencies. |
+| `sync` | `dep sync` | **(New)** Synchronizes `tsconfig.json` paths and `importmap` based on your config. |
+| `install`| `dep install [name...]`| Clones, builds, and sets up all or specific dependencies. |
+| `list` | `dep list` | Lists all dependencies configured in your project. |
+| `add` | `dep add <repo_url> [name]` | Adds a new repository dependency to your configuration. |
+| `remove`| `dep remove <name>` | Removes a dependency from the configuration. |
+| `uninstall`| `dep uninstall [name...]`| Removes the local files of your dependencies. |
 
 ---
 
-# ⚙️ Configuration File (`depFlow.json`)
-
-All dependencies are defined in a `depFlow.json` file located in your project's root directory. This file contains a JSON array of dependency objects.
+# ⚙️ Configuration File (`depflow.json`)
 
-## Schema and Examples
+The configuration has evolved from a simple array to a powerful object schema.
 
-Here’s a look at the structure of a `depFlow.json` file:
+## New Schema Structure
 
 ```json
-[
-  {
-    "name": "my-library",
-    "repo": "https://github.com/user/my-library.git",
-    "branch": "main",
-    "builder": [ { "move": "libs/my-library"} ]
-  },
-  {
-    "name": "another-dependency",
-    "repo": "https://github.com/user/another.git",
-    "builder": [
-      { "run": "npm install" },
-      { "run": [
-        "npm run compile",
-        "npm run normalize"
-      ] }
-      {
-        "move": {
-          "out": {
-            "src/": "public/js/another-dep/",
-            "assets/css/": "public/css/"
-          }
+{
+    "flowFolder": ".depflow",
+    "tsconfig": "tsconfig.json",
+    "importmap": "importmap.json",
+    "dependencies": [
+        {
+            "name": "my-library",
+            "repo": "https://github.com/user/my-library.git",
+            "tag": "main",
+            "builder": [
+                { "run": "npm install", "maxTimeMs": 10000 },
+                { "move": { "build": "web/logic/.lib/my-lib" } }
+            ],
+            "resolver": [
+                {
+                    "alias": "my-lib",
+                    "target": {
+                        "local": "./web/logic/.lib/my-lib/index.js",
+                        "cdn": "https://cdn.com/my-lib.js"
+                    }
+                }
+            ]
         }
-      }
     ]
-  }
-]
+}
 ```
 
 ## Fields Explained
 
-*   **`name`** (string): A unique identifier for the dependency. If you don't provide one with the `add` command, a name will be generated from the repository URL.
-*   **`repo`** (string): The full HTTPS or SSH URL for the Git repository.
-*   **`branch`** (string, optional): The name of the branch you want to clone. If omitted, the repository's default branch is used.
-*   **`build`: an array to indicate a pipeline to build the repository.
-*   **`builder[].run`** (string | string[]): defines a command or list of commands.
-*   **`builder[].move`** (string | string[] | object, optional): Defines where the dependency's files should be placed.
-    *   **As a string**: The entire repository is cloned into this single path.
-    *   **As a string array**: The repository content is copied to each path in the array.
-    *   **As an object**: A map where keys are source paths within the repository and values are the destination paths in your project. You can use `'/'` as a key to refer to the repository's root.
+### Root Configuration
+* **`flowFolder`** (string): The directory where DepFlow stores internal data (default: `.depflow`).
+* **`tsconfig`** (string, optional): Path to your TypeScript config. When set, `dep sync` will automatically manage your `compilerOptions.paths`.
+* **`importmap`** (string, optional): Path to your importmap file. When set, `dep sync` keeps your browser imports up to date.
+* **`dependencies`** (array): Your list of Git-based dependencies.
+
+### Dependency Object
+* **`name`** (string): Unique identifier for the dependency.
+* **`repo`** (string): The Git repository URL.
+* **`tag`** (string, optional): **(New)** Specify a branch, tag, or commit hash (e.g., `main`, `v1.2.0`).
+* **`builder`**: A pipeline to build and organize the dependency files.
+  * **`run`** (string | string[]): Command(s) to execute (e.g., `npm run compile`).
+  * **`move`** (string | object): Defines where to place the built files.
+* **`resolver`**: **(Renamed)** Configuration for path mapping.
+  *  alias`**: The import alias (e.g., `my-lib`).
+  *   **`target`**: Can be a string path or an object defining `local` and `cdn` targets for hybrid environments.
+
+---
+
+# 🚀 Migration to v2.0.0
+
+To upgrade from v1:
+1.  Wrap your existing array into a `{"dependencies": [...]}` object.
+2.  Rename any `pathResolver` fields to `resolver`.
+3.  Add the `$schema` field to enable VSCode autocompletion and validation.
+4.  Run `dep sync` to initialize your environment.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "depflow",
   "description": "is a simple dependency manager based on github repositories",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "main": "build/cli/DepFlowCLI.js",
   "type": "module",
   "bin": {