@wiztivi/dana-cli 0.0.6 → 0.0.8

package/README.md

@@ -0,0 +1,47 @@
+![Dana Logo](tools/templates/app-template/images/dana.png)
+
+# Dana-cli
+
+Dana is a JavaScript framework built for TV apps.
+It aims at enabling the creation of natively performant TV applications on all currently available TV platforms.
+Code once, deploy across all major platforms (Samsung Tizen, LG WebOS, Android TV, AppleTV, Xbox...) using a single codebase.
+
+This cli is a companion tool made to help you boostrap an application with Dana.
+
+## Requirements
+
+To be able to use the dana-cli, you will need:
+
+- Node > 20,
+- an account on [Dana Cloud Service](https://app.public.dana-framework.com/)
+
+## Getting started
+
+First you'll need to use your account to authenticate to Dana Cloud Service platform:
+
+```bash
+npx @wiztivi/dana-cli auth login
+```
+
+This should open a browser and ask for your account credentials.
+
+Then you can create a simple template of your application by running the following command:
+
+```bash
+npx @wiztivi/dana-cli create-app <project-name>
+```
+
+## Usage
+
+Use the CLI to:
+
+- create a new app project
+- add device(s) easily to deploy your project on more platforms: `npx @wiztivi/dana-cli add-device`,
+- add built-in components to your project: eg `npx @wiztivi/dana-cli add-menu`
+- get autocompletion script for dana commands: `npx @wiztivi/dana-cli completion <shell>`
+
+To get all available options and more information:`npx @wiztivi/dana-cli help`
+
+## Screenshots
+
+![VOD Screen 1](images/vodScreen1.png)

package/dana_completion.sh

@@ -11,13 +11,13 @@ dana_commands=(
 'add-scrollView'
 'add-screen'
 'auth'
+'create-app'
 )
 
 # Shared subcommand declarations
 login_sub="login"
 logout_sub="logout"
 status_sub="status"
-
 # Shared option declarations
 direction_opts="-d --direction"
 navigation_opts="-n --navigation"
@@ -26,12 +26,13 @@ margin_opts="-m --itemMargin"
 custom_opts="-cm --custom"
 item_view_opts="-i --itemView"
 org_opts="-o --org"
+device_opts="-d --device"
+tutorial_opts="-t, --tutorial"
 
 # Shared option values
 direction_values="h v"
 navigation_values="fixed lmr lr paginated"
 org_values="preprod"
-
 # Detect shell and load appropriate completion
 if [ -n "$BASH_VERSION" ]; then
     # Bash completion
@@ -40,7 +41,6 @@ if [ -n "$BASH_VERSION" ]; then
        local cur prev opts
        cur="${COMP_WORDS[COMP_CWORD]}"
        prev="${COMP_WORDS[COMP_CWORD-1]}"
-
        # Complete option values
        case "$prev" in
          -d|--direction)
@@ -56,13 +56,11 @@ if [ -n "$BASH_VERSION" ]; then
            return 0
            ;;
        esac
-
        # If we're completing the first argument (command)
        if [[ $COMP_CWORD -eq 1 ]]; then
          COMPREPLY=($(compgen -W "${dana_commands[*]}" -- "$cur"))
          return 0
        fi
-
        # If we're completing options for specific commands
        local cmd="${COMP_WORDS[1]}"
        case "$cmd" in
@@ -86,14 +84,16 @@ if [ -n "$BASH_VERSION" ]; then
             fi
             COMPREPLY=($(compgen -W "$opts" -- "$cur"))
             ;;
+         create-app)
+           opts="$device_opts $tutorial_opts"
+           COMPREPLY=($(compgen -W "$opts" -- "$cur"))
+           ;;
          *)
            COMPREPLY=()
            ;;
        esac
     }
-
     complete -F _dana dana
-
 elif [ -n "$ZSH_VERSION" ]; then
     # Zsh completion
     _dana() {
@@ -104,7 +104,6 @@ elif [ -n "$ZSH_VERSION" ]; then
         compadd -a commands
         return
       fi
-
       # Complete option values
       local prev=${words[CURRENT-1]}
       case "$prev" in
@@ -125,7 +124,6 @@ elif [ -n "$ZSH_VERSION" ]; then
           return
           ;;
       esac
-
       # Complete options for commands
       local cmd=${words[2]}
       case "$cmd" in
@@ -145,6 +143,8 @@ elif [ -n "$ZSH_VERSION" ]; then
             compadd -- ${=org_opts}
           fi
           ;;
+        create-app)
+          compadd -- ${device_opts} $={tutorial_opts}
       esac
     }
 

package/dist/commands/addDevice/add-device.js

@@ -24,6 +24,7 @@ import translation from "../../common/translation/translation.js";
 import { CredentialsHelper } from "../authentication/helper/CredentialsHelper.js";
 const addDevice = async () => {
     prompts.intro(`Add device(s) to ${path.basename(process.cwd())} !`);
+    const spinner = prompts.spinner();
     const data = {};
     try {
         data.directory = "./";
@@ -49,6 +50,7 @@ const addDevice = async () => {
         process.exit(DEVICE_ERROR);
     }
     try {
+        spinner.start(translation["task.installation.start"]);
         await CreateAppHelper.installation([
             {
                 title: "Update package.json",
@@ -74,14 +76,15 @@ const addDevice = async () => {
                 title: "Execute devices config",
                 task: async () => UpdateFileHelper.setDevicesConfig(data),
             },
-        ]);
+        ], spinner);
     }
     catch (e) {
-        AddDeviceHelper.cleanOnError();
+        spinner.stop();
         const message = e instanceof Error ? e.message : e;
         prompts.outro(colors.red(`${translation["error.common.start.message"]} ${message}`));
         process.exit(DEVICE_ERROR);
     }
+    spinner.stop(translation["task.installation.end"]);
     prompts.outro("Everything is ready ! Don't forget to commit your change.");
     return;
 };

package/dist/common/helpers/UpdateFileHelper.d.ts

@@ -1,4 +1,9 @@
 import { Config } from "../types/helperTypes.js";
+interface TemplateFile {
+    fromPath: string;
+    config: Record<string, string>;
+    toPath: string;
+}
 declare class UpdateFileHelper {
     /**
      * Update app.Config files with mandatory Data
@@ -36,5 +41,6 @@ declare class UpdateFileHelper {
         directory: string;
         name: string;
     }) => Promise<string>;
+    static readonly getConfigFileOutput: (directory: string) => TemplateFile[];
 }
 export default UpdateFileHelper;

package/dist/common/helpers/UpdateFileHelper.js

@@ -104,13 +104,9 @@ class UpdateFileHelper {
                 config: { appName },
                 toPath: path.join(directory, "tests", "unit", "app", `${appName}AppRoutes.js`),
             },
-            {
-                fromPath: path.join(directory, "gitignoreTemplate.hbs"),
-                config: {},
-                toPath: path.join(directory, `.gitignore`),
-            },
         ];
-        for (const file of filesToUpdate) {
+        const finalListToUpdate = filesToUpdate.concat(UpdateFileHelper.getConfigFileOutput(directory));
+        for (const file of finalListToUpdate) {
             const updatedContent = templateGenerator(file.fromPath, file.config);
             fs.writeFileSync(file.toPath, updatedContent);
             fs.unlink(file.fromPath, (err) => {
@@ -120,5 +116,17 @@ class UpdateFileHelper {
         }
         return Promise.resolve("Files templated");
     };
+    static getConfigFileOutput = function (directory) {
+        const configFiles = ["gitignoreTemplate.hbs", "editorConfigTemplate.hbs", "eslintrc.jsonTemplate.hbs"];
+        const filesToUpdate = [];
+        for (const configFile of configFiles) {
+            filesToUpdate.push({
+                fromPath: path.join(directory, configFile),
+                config: {},
+                toPath: path.join(directory, `.${configFile.replace("Template.hbs", "")}`),
+            });
+        }
+        return filesToUpdate;
+    };
 }
 export default UpdateFileHelper;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@wiztivi/dana-cli",
-    "version": "0.0.6",
+    "version": "0.0.8",
     "description": "Dana create app CLI",
     "type": "module",
     "exports": "./dist/index.js",
@@ -14,17 +14,21 @@
         "lint": "eslint src tests",
         "test": "vitest",
         "test:coverage": "vitest run --coverage",
-        "build": "rimraf ./dist tsconfig.tsbuildinfo && tsc --build && cp dana_completion.sh dist/",
-        "ci": "npm run build && npm run lint && npm run test:coverage"
+        "build": "npm run _clean:dist && tsc --build && npm run _add_files:dist",
+        "build:watch": "npm run _clean:dist && tsc --build --watch",
+        "ci": "npm run build && npm run lint && npm run test:coverage",
+        "_add_files:dist": "cp ../../README.md .",
+        "_clean:dist": "rimraf ./dist tsconfig.tsbuildinfo"
     },
     "files": [
         "dist",
-        "dana_completion.sh"
+        "dana_completion.sh",
+        "README.md"
     ],
     "dependencies": {
         "@aws-sdk/client-codeartifact": "^3.859.0",
         "@clack/prompts": "0.10.0",
-        "@wiztivi/dana-templates": "^0.0.6",
+        "@wiztivi/dana-templates": "^0.0.8",
         "child_process": "1.0.x",
         "command-exists": "1.2.9",
         "commander": "11.1.x",

package/dist/dana_completion.sh

@@ -1,153 +0,0 @@
-#!/usr/bin/env sh
-
-# Unified completion script for dana CLI
-# Detects shell and loads appropriate completion
-
-# Shared command list
-dana_commands=(
-'add-device'
-'add-menu'
-'add-rail'
-'add-scrollView'
-'add-screen'
-'auth'
-)
-
-# Shared subcommand declarations
-login_sub="login"
-logout_sub="logout"
-status_sub="status"
-
-# Shared option declarations
-direction_opts="-d --direction"
-navigation_opts="-n --navigation"
-cyclic_opts="-c --cyclic"
-margin_opts="-m --itemMargin"
-custom_opts="-cm --custom"
-item_view_opts="-i --itemView"
-org_opts="-o --org"
-
-# Shared option values
-direction_values="h v"
-navigation_values="fixed lmr lr paginated"
-org_values="preprod"
-
-# Detect shell and load appropriate completion
-if [ -n "$BASH_VERSION" ]; then
-    # Bash completion
-    _dana()
-    {
-       local cur prev opts
-       cur="${COMP_WORDS[COMP_CWORD]}"
-       prev="${COMP_WORDS[COMP_CWORD-1]}"
-
-       # Complete option values
-       case "$prev" in
-         -d|--direction)
-           COMPREPLY=($(compgen -W "$direction_values" -- "$cur"))
-           return 0
-           ;;
-         -n|--navigation)
-           COMPREPLY=($(compgen -W "$navigation_values" -- "$cur"))
-           return 0
-           ;;
-         -o|--org)
-           COMPREPLY=($(compgen -W "$org_values" -- "$cur"))
-           return 0
-           ;;
-       esac
-
-       # If we're completing the first argument (command)
-       if [[ $COMP_CWORD -eq 1 ]]; then
-         COMPREPLY=($(compgen -W "${dana_commands[*]}" -- "$cur"))
-         return 0
-       fi
-
-       # If we're completing options for specific commands
-       local cmd="${COMP_WORDS[1]}"
-       case "$cmd" in
-         add-rail)
-           opts="$navigation_opts $cyclic_opts $direction_opts $custom_opts $item_view_opts"
-           COMPREPLY=($(compgen -W "$opts" -- "$cur"))
-           ;;
-         add-menu)
-           opts="$direction_opts $margin_opts $custom_opts $item_view_opts"
-           COMPREPLY=($(compgen -W "$opts" -- "$cur"))
-           ;;
-         add-scrollView)
-           opts="$custom_opts $item_view_opts $margin_opts"
-           COMPREPLY=($(compgen -W "$opts" -- "$cur"))
-           ;;
-         auth)
-            if [[ $COMP_CWORD -eq 2 ]]; then
-              opts="$login_sub $logout_sub $status_sub"
-            else
-              opts="$org_opts"
-            fi
-            COMPREPLY=($(compgen -W "$opts" -- "$cur"))
-            ;;
-         *)
-           COMPREPLY=()
-           ;;
-       esac
-    }
-
-    complete -F _dana dana
-
-elif [ -n "$ZSH_VERSION" ]; then
-    # Zsh completion
-    _dana() {
-      # Main commands
-      if (( CURRENT == 2 )); then
-        local -a commands
-        commands=(${dana_commands[@]})
-        compadd -a commands
-        return
-      fi
-
-      # Complete option values
-      local prev=${words[CURRENT-1]}
-      case "$prev" in
-        -d|--direction)
-          compadd -- ${=direction_values}
-          return
-          ;;
-        -n|--navigation)
-          compadd -- ${=navigation_values}
-          return
-          ;;
-        -o|--org)
-          compadd -- ${=org_values}
-          return
-          ;;
-        login|logout|status)
-          compadd -- ${=org_opts}
-          return
-          ;;
-      esac
-
-      # Complete options for commands
-      local cmd=${words[2]}
-      case "$cmd" in
-        add-rail)
-          compadd -- ${=navigation_opts} ${=cyclic_opts} ${=direction_opts} ${=custom_opts} ${=item_view_opts}
-          ;;
-        add-menu)
-          compadd -- ${=direction_opts} ${=margin_opts} ${=custom_opts} ${=item_view_opts}
-          ;;
-        add-scrollView)
-          compadd -- ${=custom_opts} ${=item_view_opts} ${=margin_opts}
-          ;;
-        auth)
-          if (( CURRENT == 3 )); then
-            compadd -- ${=login_sub} ${=logout_sub} ${=status_sub}
-          else
-            compadd -- ${=org_opts}
-          fi
-          ;;
-      esac
-    }
-
-    # Register the completion
-    compdef _dana dana
-fi