spyne-cli 0.6.8 → 0.7.0

package/src/hello-world-app-source/webpack.config.js

@@ -1,178 +0,0 @@
-const path = require('path');
-const webpack = require('webpack');
-const MiniCssExtractPlugin = require('mini-css-extract-plugin');
-const HtmlWebpackPlugin = require('html-webpack-plugin');
-const CopyWebpackPlugin = require('copy-webpack-plugin');
-
-const _defaultAssetsDirName = "assets";
-const port = 8062;
-
-let mode;
-let _isProduction;
-let _buildType;
-
-// USE "/./" FOR ROOT DOMAIN OR "./" FOR RELATIVE DOMAIN PATHS"
-let _relativeRoot = "./"
-let _publicPath;
-let _assetsFolder;
-let _imgPath;
-
-module.exports = (env={mode:"development"})=> {
-
-  mode =           env.mode || 'development';
-  _isProduction =   env.build === true;
-  _buildType =      process.env.buildType;
-  _publicPath =     _isProduction ?  _relativeRoot : "/";
-  _assetsFolder =   _isProduction ? `${_defaultAssetsDirName}/` : "";
-  _imgPath =        `${_publicPath}${_assetsFolder}static/imgs/`;
-
-  const config = {
-    mode,
-
-    entry: {
-      index: './src/index.js'
-    },
-
-    output: {
-      filename: `${_assetsFolder}js/[name].js`,
-      publicPath: _publicPath,
-      clean: true
-    },
-
-    devtool:  _isProduction ? false : 'inline-cheap-source-map',
-
-    devServer: {
-      static: {
-        directory: 'src',
-      },
-      historyApiFallback: true,
-      port
-    },
-
-    plugins:  getWebpackPlugins(),
-
-    optimization: {
-      splitChunks: {
-        cacheGroups: {
-          common: {
-            test: /[\\/]node_modules[\\/]/,
-            name: "vendor",
-            chunks: 'all',
-          }
-        },
-      }
-    },
-
-    module: {
-      rules: [
-
-        {
-          test: /\.html$/,
-          loader: "html-loader",
-          options: {
-            minimize: false,
-            esModule: false,
-          }
-        },
-
-        {
-          test: /\.(sa|sc|c)ss$/,
-          use: [
-            _isProduction !== true ? 'style-loader' : MiniCssExtractPlugin.loader,
-            'css-loader',
-            {
-              loader: 'sass-loader', options: {
-                sourceMap: true
-              },
-            }
-          ]
-        },
-
-        {
-          test: /\.(ttf|woff|woff2)$/,
-          type: 'asset/resource',
-          generator: {
-            filename: `${_assetsFolder}static/fonts/[name][ext][query]`
-          }
-        },
-
-        {
-          test: /\.(png|jpe?g|gif|svg)$/i,
-          type: "asset"
-        },
-
-        {
-          test: /\.(json)$/,
-          type: 'javascript/auto',
-          use: [
-            {
-              loader: 'file-loader',
-              options: {
-                name: `${_assetsFolder}static/data/[name].[ext]`
-              },
-            }]
-        }
-
-      ]
-    },
-
-    resolve: {
-      alias: {
-        plugins: path.resolve(__dirname, 'src/plugins/'),
-        imgs: path.resolve(__dirname, 'src/static/imgs/'),
-        fonts: path.resolve(__dirname, 'src/static/fonts/'),
-        data: path.resolve(__dirname, '/./src/static/data/'),
-        css: path.resolve(__dirname, 'src/css/'),
-        core: path.resolve(__dirname, 'src/core/'),
-        traits: path.resolve(__dirname, 'src/app/traits/'),
-        channels: path.resolve(__dirname, 'src/app/channels/'),
-        components: path.resolve(__dirname, 'src/app/components/'),
-        node_modules: path.resolve(__dirname, 'node_modules/')
-
-      },
-
-      extensions: ['.js', '.css'],
-    }
-  };
-
-  return config;
-
-}
-
-
-const getWebpackPlugins = ()=> {
-
-  const miniCssPlugin = ()=> {
-    return new MiniCssExtractPlugin({
-      filename: `${_assetsFolder}/css/main.css`
-    });
-  }
-
-  const definePlugin = new webpack.DefinePlugin({
-    "IMG_PATH": JSON.stringify(_imgPath),
-    'NODE_ENV': JSON.stringify(process.env.NODE_ENV)
-  });
-
-  const htmlPlugin = new HtmlWebpackPlugin({
-    template: './src/index.tmpl.html',
-    minify: false
-  });
-
-  const getCopyPatternsPlugin = () => {
-    const patterns = [
-      {from: "./src/static/imgs", to: `${_assetsFolder}static/imgs`}
-    ]
-
-    if (_buildType === 'apache') {
-      patterns.push(
-          {from: "./apache-htaccess", to: ".htaccess", toType: "file"})
-    }
-
-    return new CopyWebpackPlugin({patterns})
-  }
-
-  return _isProduction ?
-      [htmlPlugin, definePlugin, miniCssPlugin, getCopyPatternsPlugin()] :
-      [htmlPlugin, definePlugin];
-
-}

package/src/spyne-app-create.js

@@ -1,209 +0,0 @@
-// SpyneAppCreator.js
-
-import c from 'ansi-colors';
-import { exec } from 'child_process';
-import fs from 'fs-extra';
-import path from 'path';
-import ora from 'ora';
-import cliCursor from 'cli-cursor';
-
-class SpyneAppCreator {
-  constructor(args) {
-    this.args = args;
-    this.createAppBool = this.checkCreateAppCommand();
-  }
-
-  // Method to check if 'create' command is used with 'appFolder' argument
-  checkCreateAppCommand() {
-    const createIndex = this.args.indexOf('create');
-    if (createIndex !== -1 && this.args[createIndex + 1]) {
-      this.appFolder = this.args[createIndex + 1];
-      this.parseOptions(createIndex + 2); // Start parsing options after 'appFolder'
-      return true;
-    }
-    return false;
-  }
-
-  // Method to parse additional command-line options
-  parseOptions(startIndex) {
-    this.options = {
-      templateName: 'starter-app', // Default template
-      skipInstall: false,
-      skipGit: false,
-    };
-
-    for (let i = startIndex; i < this.args.length; i++) {
-      const arg = this.args[i];
-      if (arg === '--template' && this.args[i + 1]) {
-        this.options.templateName = this.args[i + 1];
-        i++; // Skip the next argument since it's the value of --template
-      } else if (arg === '--no-install') {
-        this.options.skipInstall = true;
-      } else if (arg === '--skip-git') {
-        this.options.skipGit = true;
-      }
-    }
-  }
-
-  // Getter for createAppBool
-  get createAppBool() {
-    return this._createAppBool;
-  }
-
-  // Setter for createAppBool
-  set createAppBool(value) {
-    this._createAppBool = value;
-  }
-
-  // Method to initiate app creation
-  async createApp() {
-    const appFolder = this.appFolder;
-    const { templateName, skipInstall, skipGit } = this.options;
-    const repoUrl = this.getTemplateRepoUrl(templateName);
-    const appPath = path.resolve(process.cwd(), appFolder);
-
-    console.log(c.green(`\nCreating a new Spyne app in ${c.cyan(appPath)} using the "${c.cyan(templateName)}" template...\n`));
-
-    try {
-      // Hide the cursor
-      cliCursor.hide();
-
-      // Clone the repository
-      await this.cloneRepository(repoUrl, appFolder);
-
-      // Remove the .git directory
-      await fs.remove(path.join(appFolder, '.git'));
-
-      // Initialize a new Git repository if not skipped
-      if (!skipGit) {
-        await this.initGitRepo(appFolder);
-      }
-
-      // Install dependencies if not skipped
-      if (!skipInstall) {
-        await this.installDependencies(appFolder);
-      }
-
-      // Update package.json
-      await this.updatePackageJson(appFolder);
-
-      // Provide post-installation instructions
-      this.printSuccessMessage(appFolder, appPath, skipInstall);
-    } catch (error) {
-      console.error(c.red(`\nError: ${error.message}`));
-    } finally {
-      // Show the cursor again
-      cliCursor.show();
-    }
-  }
-
-  // Method to get the repository URL based on the template name
-  getTemplateRepoUrl(templateName) {
-    const templates = {
-      'starter-app': 'https://github.com/nybatista/starter-app-alpha.git',
-      // Add more templates here if needed
-    };
-    if (!templates[templateName]) {
-      throw new Error(`Template "${templateName}" not found.`);
-    }
-    return templates[templateName];
-  }
-
-  // Method to clone the repository with spinner
-  cloneRepository(repoUrl, appFolder) {
-    return new Promise((resolve, reject) => {
-      const spinner = ora(c.green('Cloning repository...')).start();
-
-      exec(`git clone --depth=1 ${repoUrl} ${appFolder}`, (error) => {
-        if (error) {
-          spinner.fail(c.red('Failed to clone repository.'));
-          reject(new Error(`Failed to clone repository: ${error.message}`));
-        } else {
-          spinner.succeed(c.green('Repository cloned successfully.'));
-          resolve();
-        }
-      });
-    });
-  }
-
-  // Method to initialize a new Git repository with spinner
-  initGitRepo(appFolder) {
-    return new Promise((resolve) => {
-      const spinner = ora(c.green('Initializing Git repository...')).start();
-
-      exec('git --version', (gitError) => {
-        if (gitError) {
-          spinner.warn(c.yellow('Git is not installed. Skipping Git initialization.'));
-          resolve();
-        } else {
-          exec('git init', { cwd: appFolder }, (initError) => {
-            if (initError) {
-              spinner.fail(c.red('Failed to initialize Git repository.'));
-            } else {
-              spinner.succeed(c.green('Git repository initialized.'));
-            }
-            resolve();
-          });
-        }
-      });
-    });
-  }
-
-  // Method to install dependencies with spinner
-  installDependencies(appFolder) {
-    return new Promise((resolve) => {
-      const spinner = ora(c.green('Installing dependencies...')).start();
-
-      exec('npm install', { cwd: appFolder }, (installError) => {
-        if (installError) {
-          spinner.fail(c.red('Failed to install dependencies.'));
-          resolve(); // Proceed even if installation fails
-        } else {
-          spinner.succeed(c.green('Dependencies installed successfully.'));
-          resolve();
-        }
-      });
-    });
-  }
-
-  // Method to update package.json with spinner
-  updatePackageJson(appFolder) {
-    return new Promise((resolve, reject) => {
-      const spinner = ora(c.green('Updating package.json...')).start();
-      const pkgPath = path.join(appFolder, 'package.json');
-
-      fs.readJson(pkgPath)
-      .then((pkg) => {
-        pkg.name = path.basename(appFolder);
-        return fs.writeJson(pkgPath, pkg, { spaces: 2 });
-      })
-      .then(() => {
-        spinner.succeed(c.green('package.json updated.'));
-        resolve();
-      })
-      .catch((err) => {
-        spinner.fail(c.red('Failed to update package.json.'));
-        reject(new Error(`Failed to update package.json: ${err.message}`));
-      });
-    });
-  }
-
-  // Method to print success message
-  printSuccessMessage(appFolder, appPath, skipInstall) {
-    console.log(c.green(`\nSuccess! Created ${c.cyan(appFolder)} at ${c.cyan(appPath)}\n`));
-    console.log('Inside that directory, you can run several commands:\n');
-    console.log(`  ${c.cyan('npm start')}`);
-    console.log('    Starts the development server.\n');
-    console.log(`  ${c.cyan('npm run build')}`);
-    console.log('    Bundles the app into static files for production.\n');
-    console.log('We suggest that you begin by typing:\n');
-    console.log(`  ${c.cyan('cd')} ${appFolder}`);
-    if (skipInstall) {
-      console.log(`  ${c.cyan('npm install')}`);
-    }
-    console.log(`  ${c.cyan('npm start')}\n`);
-    console.log(c.green('Happy coding!'));
-  }
-}
-
-export default SpyneAppCreator;

package/src/spyne-app-creator.js

@@ -1,119 +0,0 @@
-import path from 'path';
-import c from 'ansi-colors';
-import {checkIfFolderExists, copyDirSync} from './utils/file-utils.js';
-
-let _createAppBool = false;
-let _folderName;
-let _folderPath = path.resolve();
-let _appDirectory;
-let _errorMsg;
-
-
-
-
-import {packageDirectory} from 'pkg-dir';
-const globalPath = "/usr/local/lib/node_modules/spyne-cli"
-const _spyneAppSrcRelPath = '/src/hello-world-app-source';
-let _spyneAppSrcPath = path.resolve(globalPath, _spyneAppSrcRelPath);
-
-
-const getSpyneSrcPath = async()=> {
-  const localPath = await packageDirectory();
-  const mainPath = localPath || globalPath;
-  _spyneAppSrcPath = path.resolve(mainPath, 'src/hello-world-app-source');
-}
-
-
-export default class SpyneAppCreator {
-
-  constructor(args=[]) {
-
-    let {createAppBool, folderName} = SpyneAppCreator.checkArgs(args);
-
-    _createAppBool = createAppBool;
-    _folderName = folderName;
-
-
-    this.checkForErrors =   SpyneAppCreator.checkForErrors.bind(this);
-    this.generateResponse = SpyneAppCreator.generateResponse.bind(this);
-    this.copyDirAndReturnResponse = SpyneAppCreator.copyDirAndReturnResponse.bind(this);
-
-
-  }
-
-
-  static async generateResponse(){
-     try{
-       await getSpyneSrcPath();
-     } catch(e){
-       console.log('getting src path err ',e);
-     }
-    _errorMsg = this.checkForErrors();
-    return _errorMsg ? console.log(_errorMsg) : this.copyDirAndReturnResponse();
-  }
-
-
-
-  static copyDirAndReturnResponse(appDir=_appDirectory){
-    copyDirSync(_spyneAppSrcPath, appDir);
-    console.log(SpyneAppCreator.successColors(`spyne at created at ${appDir}`));
-  }
-
-
-  static successColors(successStr="XXXX"){
-    return c.blueBright(successStr);
-  }
-
-  static errorColors(errorStr="XXXX"){
-    return c.greenBright(errorStr);
-  }
-
-  static checkForErrors(folderPath=_folderPath, folderName=_folderName){
-
-    let folderNameIsMissing = folderName === undefined;
-
-    if (folderNameIsMissing){
-      return SpyneAppCreator.errorColors("Please add a folder name!");
-    }
-
-    _appDirectory =  `${folderPath}/${folderName}`;
-
-    let pathAlreadyExistsBool = SpyneAppCreator.checkIfDirectoryExists(_appDirectory);
-
-    if (pathAlreadyExistsBool){
-      return SpyneAppCreator.errorColors('App folder already exists!');
-    }
-
-    return undefined;
-
-  }
-
-  static checkIfDirectoryExists(appDir=""){
-    return checkIfFolderExists(appDir);;
-  }
-
-
-
-  static checkArgs(args){
-    const methodStr =  args.length>=3 ? args[2] : false;
-    const folderName = args.length>=4 ? args[3] : undefined;
-    const createAppBool =  ["create-app", "new", "create", "generate"].includes(methodStr);
-
-    return {folderName, createAppBool};
-
-  }
-
-  get createAppBool(){
-    return _createAppBool;
-  }
-
-  get folderName(){
-    return _folderName;
-  }
-
-  get folderPath(){
-    return _folderPath;
-  }
-
-
-}

package/src/spyne-starter-app-create.js

@@ -1,147 +0,0 @@
-import c from 'ansi-colors';
-import simpleGit from 'simple-git';
-import { spawn } from 'child_process';
-import fs from 'fs';
-import path from 'path';
-import ora from 'ora';
-
-async function installDependencies(appName) {
-  const spinner = ora({
-    text: c.cyan('Installing dependencies...'),
-    spinner: 'dots'
-  }).start();
-
-  return new Promise((resolve, reject) => {
-    const child = spawn('npm', ['install', '--silent'], {
-      cwd: appName,
-      stdio: 'ignore',
-    });
-
-    child.on('close', (code) => {
-      if (code === 0) {
-        spinner.succeed(c.greenBright('Dependencies installed successfully!'));
-        resolve();
-      } else {
-        spinner.fail(c.red(`Failed to install dependencies (exit code: ${code}).`));
-        reject(new Error('npm install failed'));
-      }
-    });
-  });
-}
-
-/**
- * Update <title> in index.tmpl.html
- * @param {string} targetDir
- * @param {string} appName
- */
-function updateIndexTitle(targetDir, appName) {
-  const indexFilePath = path.join(targetDir, 'src', 'index.tmpl.html');
-  if (!fs.existsSync(indexFilePath)) return; // skip if not found
-
-  let content = fs.readFileSync(indexFilePath, 'utf-8');
-  // Replace first occurrence of <title>...</title>
-  content = content.replace(/<title>.*<\/title>/, `<title>${appName}</title>`);
-
-  fs.writeFileSync(indexFilePath, content, 'utf-8');
-}
-
-/**
- * Update "name" field in package.json
- * @param {string} targetDir
- * @param {string} appName
- */
-function updatePackageName(targetDir, appName) {
-  const pkgPath = path.join(targetDir, 'package.json');
-  if (!fs.existsSync(pkgPath)) return; // skip if not found
-
-  const pkgData = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-
-  // sanitize: e.g. convert to lowercase, replace spaces with dashes
-  const sanitizedName = appName
-  .toLowerCase()
-  .replace(/\s+/g, '-')
-  .replace(/[^a-z0-9-_]/g, ''); // remove any non-alphanumeric (optional)
-
-  pkgData.name = sanitizedName || 'my-spyne-app';
-
-  fs.writeFileSync(pkgPath, JSON.stringify(pkgData, null, 2), 'utf-8');
-}
-
-/**
- * Update the project details (title, pkg name)
- */
-function updateProjectDetails(targetDir, appName) {
-  updateIndexTitle(targetDir, appName);
-  updatePackageName(targetDir, appName);
-}
-
-/**
- * Creates a new Spyne app in the directory `appName`.
- * If isSPA is true, clones the single-page-app template (spa-base-alpha).
- * Otherwise, clones the default starter-app-alpha.
- *
- * @param {string} appName - Name of the app / folder
- * @param {boolean} isSPA  - Whether to clone the SPA repo
- */
-export async function createNewApp(appName, isSPA = false) {
-  const targetDir = path.resolve(process.cwd(), appName);
-
-  // Choose repo based on isSPA flag
-  const repoUrl = isSPA
-      ? 'https://github.com/nybatista/spa-base-alpha.git'
-      : 'https://github.com/nybatista/starter-app-alpha.git';
-
-  const git = simpleGit();
-
-  console.log(c.cyan(`\nCreating a new Spyne app in ${c.bold(appName)}...`));
-  console.log(c.yellow(`Using repo: ${repoUrl}`));
-
-  // 1) Clone repository with Ora spinner
-  let spinner = ora({
-    text: c.cyan('Cloning repository...'),
-    spinner: 'dots',
-  }).start();
-
-  try {
-    await git.clone(repoUrl, targetDir, [
-      '--branch=main',
-      '--single-branch',
-      '--depth=1'
-    ]);
-
-    spinner.succeed(c.greenBright('Repository cloned successfully!'));
-  } catch (err) {
-    spinner.fail(c.red(`Failed to clone the repository: ${err.message}`));
-    process.exit(1);
-  }
-
-  // 2) Remove .git
-  try {
-    fs.rmSync(path.join(targetDir, '.git'), { recursive: true, force: true });
-  } catch (err) {
-    console.error(c.red(`Failed to remove .git folder: ${err.message}`));
-    process.exit(1);
-  }
-
-  // 3) Update index.tmpl.html <title> and package.json name
-  try {
-    updateProjectDetails(targetDir, appName);
-  } catch (err) {
-    console.error(c.red(`Failed to update project details: ${err.message}`));
-    // not a fatal error in most cases, but you can decide to exit if needed
-  }
-
-  // 4) Install dependencies
-  try {
-    await installDependencies(appName);
-  } catch (err) {
-    console.error(c.red(err.message));
-    process.exit(1);
-  }
-
-  // 5) Final message
-  console.log(`\n${c.greenBright('Success!')}`);
-  console.log(c.cyan(`Created ${c.bold(appName)} at ${targetDir}\n`));
-  console.log(c.greenBright('Next steps:'));
-  console.log(c.bgCyan(c.black(`  cd ${appName} && npm start`)));
-}