shoplazza-cli 1.0.12 → 1.1.1

package/lib/app/commands/dev/index.js

@@ -0,0 +1,11 @@
+const { Command } = require('commander');
+const devCommand = new Command('dev');
+const { devAction } = require('./actions/dev');
+
+devCommand.option('--path <path>', 'The path to your app directory');
+
+devCommand.action(devAction);
+
+module.exports = {
+  devCommand
+};

package/lib/app/commands/generate/actions/extension.js

@@ -0,0 +1,97 @@
+const path = require('path');
+const fs = require('fs');
+const inquirer = require('inquirer');
+
+const { withErrorHandling } = require('../../../utils/error');
+const { EXTENSION_TYPES } = require('../../../constant/extension');
+
+const { generateTheme } = require('./generateTheme');
+const { generateCheckout } = require('./generateCheckout');
+const { generateFunction } = require('./generateFunction');
+
+const strategies = {
+  [EXTENSION_TYPES.THEME]: generateTheme,
+  [EXTENSION_TYPES.CHECKOUT]: generateCheckout,
+  [EXTENSION_TYPES.FUNCTION]: generateFunction
+};
+
+async function selectExtensionType(targetDirectory) {
+  // 只允许一个 theme extension
+  // const extensionTomlPath = path.join(targetDirectory, 'extensions', '**', 'shoplazza.extension.toml');
+  // const extensionTomlPaths = glob.sync(extensionTomlPath);
+  // const isExistsThemeExtension = extensionTomlPaths.some((path) => {
+  //   const toml = parseTomlFile(path);
+  //   return toml.type === EXTENSION_TYPES.THEME;
+  // });
+
+  // // 创建选项列表
+  // const choices = [];
+
+  // Object.values(EXTENSION_TYPES).forEach((type) => {
+  //   if (type === EXTENSION_TYPES.THEME && isExistsThemeExtension) {
+  //     // 使用自定义分隔符替代禁用的选项
+  //     choices.push(new inquirer.Separator(chalk.gray(`${type} (limit reached)`)));
+  //   } else {
+  //     choices.push({
+  //       name: type,
+  //       value: type
+  //     });
+  //   }
+  // });
+
+  // 允许有多个 theme extension
+  const choices = Object.values(EXTENSION_TYPES);
+
+  const { type } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'type',
+      message: 'Type of extension?',
+      choices: choices
+    }
+  ]);
+
+  return type;
+}
+
+// 校验项目地址
+async function checkProjectDir(projectDir) {
+  // 检查目录是否已存在
+  if (fs.existsSync(projectDir)) {
+    throw new Error(
+      `A directory with this name (${path.basename(projectDir)}) already exists.\nChoose a new name for your extension.`
+    );
+  }
+}
+
+async function extensionAction(options) {
+  const { path: argPath = '.' } = options;
+  const extensionType = await selectExtensionType(path.resolve(argPath));
+
+  // 交互获取扩展名称
+  const { extensionName } = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'extensionName',
+      message: 'Extension name?',
+      validate: (value) => (value.trim() === '' ? 'Extension name is required' : true)
+    }
+  ]);
+
+  const targetDirectory = path.resolve(argPath, 'extensions', extensionName);
+
+  const strategy = strategies[extensionType];
+
+  if (!strategy) {
+    throw new Error(`Unknown extension type: ${extensionType}`);
+  }
+
+  // 校验项目地址
+  await checkProjectDir(targetDirectory);
+
+  await strategy({ targetDirectory });
+}
+
+module.exports = {
+  extensionAction: withErrorHandling(extensionAction)
+};

package/lib/app/commands/generate/actions/generateCheckout.js

@@ -0,0 +1,58 @@
+const path = require('path');
+const fs = require('fs');
+const simpleGit = require('simple-git');
+
+const { getTemplateGitRequest } = require('../../../api/cli');
+const { checkGit } = require('../../../utils/git');
+const { withTempDir } = require('../../../utils/withTempDir');
+const { EXTENSION_TYPES } = require('../../../constant/extension');
+const { successMessageRender } = require('../../../utils/views/message');
+const { modifyTomlFile } = require('../../../utils/toml');
+const { modifyJsonFile } = require('../../../utils/json');
+
+// 生成结账扩展
+async function generateCheckout(params) {
+  const { targetDirectory } = params;
+  const extensionName = path.basename(targetDirectory);
+
+  // 检查 git 是否安装
+  checkGit();
+
+  await withTempDir(async (tempDir) => {
+    const { https } = await getTemplateGitRequest('ext_co');
+
+    const tempDirPath = path.join(tempDir, 'extension');
+
+    // 克隆项目到本地
+    await simpleGit().clone(https, tempDirPath);
+
+    // 删除 .git 文件夹
+    fs.rmSync(path.join(tempDirPath, '.git'), { recursive: true, force: true });
+
+    // 修改 package.json
+    await modifyJsonFile(path.join(tempDirPath, 'package.json'), (config) => {
+      return {
+        ...config,
+        name: extensionName
+      };
+    });
+
+    // 修改 shoplazza.extension.toml
+    await modifyTomlFile(path.join(tempDirPath, 'shoplazza.extension.toml'), (config) => {
+      return {
+        ...config,
+        name: extensionName,
+        type: EXTENSION_TYPES.CHECKOUT
+      };
+    });
+
+    // 复制目录到目标位置
+    fs.cpSync(tempDirPath, targetDirectory, { recursive: true });
+  });
+
+  successMessageRender(`Your extension was created in extensions/${extensionName}.`);
+}
+
+module.exports = {
+  generateCheckout
+};

package/lib/app/commands/generate/actions/generateFunction.js

@@ -0,0 +1,56 @@
+const { getTemplateGitRequest } = require('../../../api/cli');
+const { withTempDir } = require('../../../utils/withTempDir');
+const { checkGit } = require('../../../utils/git');
+const simpleGit = require('simple-git');
+const { modifyJsonFile } = require('../../../utils/json');
+const { modifyTomlFile } = require('../../../utils/toml');
+const path = require('path');
+const fs = require('fs');
+const { successMessageRender } = require('../../../utils/views/message');
+const { EXTENSION_TYPES } = require('../../../constant/extension');
+
+// 生成功能扩展
+async function generateFunction({ targetDirectory }) {
+  const extensionName = path.basename(targetDirectory);
+
+  // 检查 git 是否安装
+  checkGit();
+
+  await withTempDir(async (tempDir) => {
+    const { https } = await getTemplateGitRequest('ext_func');
+
+    const tempDirPath = path.join(tempDir, 'extension');
+
+    // 克隆项目到本地
+    await simpleGit().clone(https, tempDirPath);
+
+    // 删除 .git 文件夹
+    fs.rmSync(path.join(tempDirPath, '.git'), { recursive: true, force: true });
+
+    // 修改 package.json
+    await modifyJsonFile(path.join(tempDirPath, 'package.json'), (config) => {
+      return {
+        ...config,
+        name: extensionName
+      };
+    });
+
+    // 修改 shoplazza.extension.toml
+    await modifyTomlFile(path.join(tempDirPath, 'shoplazza.extension.toml'), (config) => {
+      return {
+        ...config,
+        name: extensionName,
+        type: EXTENSION_TYPES.FUNCTION
+      };
+    });
+
+    // 复制目录到目标位置
+    fs.cpSync(tempDirPath, targetDirectory, { recursive: true });
+  });
+
+  successMessageRender(`Your extension was created in extensions/${extensionName}.`);
+}
+
+module.exports = {
+  generateFunction
+};

package/lib/app/commands/generate/actions/generateTheme.js

@@ -0,0 +1,128 @@
+const fs = require('fs');
+const path = require('path');
+const inquirer = require('inquirer');
+
+const { getTemplateGitRequest } = require('../../../api/cli');
+const { THEME_EXTENSION_TYPES, EXTENSION_TYPES } = require('../../../constant/extension');
+const { successMessageRender } = require('../../../utils/views/message');
+const { withTempDir } = require('../../../utils/withTempDir');
+const { checkGit } = require('../../../utils/git');
+const simpleGit = require('simple-git');
+const { modifyJsonFile } = require('../../../utils/json');
+const { modifyTomlFile } = require('../../../utils/toml');
+// 生成主题扩展
+async function generateTheme({ targetDirectory }) {
+  const extensionName = path.basename(targetDirectory);
+
+  // 选择主题扩展类型
+  const { themeExtensionType } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'themeExtensionType',
+      message: 'Select theme extension type:',
+      choices: [
+        { name: 'Basic Extension(a card storekeeper decide where it add)', value: THEME_EXTENSION_TYPES.BASIC },
+        { name: 'Embed Extension(a card not need add)', value: THEME_EXTENSION_TYPES.EMBED }
+      ]
+    }
+  ]);
+
+  // 检查 git 是否安装
+  checkGit();
+
+  await withTempDir(async (tempDir) => {
+    const { https } = await getTemplateGitRequest('ext_thm');
+
+    const tempDirPath = path.join(tempDir, 'extension');
+
+    // 克隆项目到本地
+    await simpleGit().clone(https, tempDirPath);
+
+    // 删除 .git 文件夹
+    fs.rmSync(path.join(tempDirPath, '.git'), { recursive: true, force: true });
+
+    // 修改 package.json
+    await modifyJsonFile(path.join(tempDirPath, 'package.json'), (config) => {
+      return {
+        ...config,
+        name: extensionName
+      };
+    });
+
+    // 修改 shoplazza.extension.toml
+    await modifyTomlFile(path.join(tempDirPath, 'shoplazza.extension.toml'), (config) => {
+      return {
+        ...config,
+        name: extensionName,
+        type: EXTENSION_TYPES.THEME
+      };
+    });
+
+    // 重命名 文件
+    fs.renameSync(
+      path.join(tempDirPath, 'blocks', `index-${themeExtensionType}.liquid`),
+      path.join(tempDirPath, 'blocks', `${extensionName}.liquid`)
+    );
+    fs.renameSync(
+      path.join(tempDirPath, 'snippets', 'index.liquid'),
+      path.join(tempDirPath, 'snippets', `${extensionName}.liquid`)
+    );
+
+    if (themeExtensionType === THEME_EXTENSION_TYPES.EMBED) {
+      // embed 重命名 snippets/index_css.liquid
+      fs.renameSync(
+        path.join(tempDirPath, 'snippets', 'index_css.liquid'),
+        path.join(tempDirPath, 'snippets', `${extensionName}_css.liquid`)
+      );
+
+      // embed 删除 assets/**
+      fs.rmSync(path.join(tempDirPath, 'assets'), { recursive: true, force: true });
+    } else {
+      // 删除 snippets/index_css.liquid
+      fs.unlinkSync(path.join(tempDirPath, 'snippets', 'index_css.liquid'));
+
+      // basic 重命名 assets/index.css
+      fs.renameSync(
+        path.join(tempDirPath, 'assets', 'index.css'),
+        path.join(tempDirPath, 'assets', `${extensionName}.css`)
+      );
+    }
+
+    // 修改 blocks/index.liquid
+    const blocksIndexLiquidPath = path.join(tempDirPath, 'blocks', `${extensionName}.liquid`);
+    const blocksIndexLiquidContent = fs.readFileSync(blocksIndexLiquidPath, 'utf-8');
+    const newBlocksIndexLiquidContent = blocksIndexLiquidContent.replaceAll('{{projectName}}', extensionName);
+    fs.writeFileSync(blocksIndexLiquidPath, newBlocksIndexLiquidContent);
+
+    // 修改 locales/en-US.json 和 locales/zh-CN.json
+    await Promise.all(
+      ['en-US.json', 'zh-CN.json'].map(async (locale) => {
+        const localesJsonPath = path.join(tempDirPath, 'locales', locale);
+        const localesJsonContent = fs.readFileSync(localesJsonPath, 'utf-8');
+        const newLocalesJsonContent = localesJsonContent.replaceAll(
+          '{{type}}',
+          themeExtensionType === THEME_EXTENSION_TYPES.BASIC ? 'BASIC' : 'EMBED'
+        );
+        fs.writeFileSync(localesJsonPath, newLocalesJsonContent);
+      })
+    );
+
+    // 删除 多余的 blocks/index-xxx.liquid
+    fs.unlinkSync(
+      path.join(
+        tempDirPath,
+        'blocks',
+        `index-${themeExtensionType === THEME_EXTENSION_TYPES.BASIC ? 'embed' : 'basic'}.liquid`
+      )
+    );
+
+    // 复制目录到目标位置
+    fs.cpSync(tempDirPath, targetDirectory, { recursive: true });
+  });
+
+  successMessageRender(`Your extension was created in extensions/${extensionName}.`);
+}
+
+module.exports = {
+  generateTheme
+};

package/lib/app/commands/generate/extension.js

@@ -0,0 +1,11 @@
+const { Command } = require('commander');
+const { extensionAction } = require('./actions/extension');
+const extensionCommand = new Command('extension');
+
+extensionCommand.option('--path <path>', 'The path to your app directory');
+
+extensionCommand.action(extensionAction);
+
+module.exports = {
+  extensionCommand
+};

package/lib/app/commands/generate/index.js

@@ -0,0 +1,22 @@
+const { Command } = require('commander');
+const { extensionCommand } = require('./extension');
+const chalk = require('chalk');
+const generateCommand = new Command('generate');
+
+generateCommand.option('--path <path>', 'The path to your app directory');
+
+generateCommand.addCommand(extensionCommand);
+
+generateCommand.helpInformation = function () {
+  return `Generate a new app Extension.
+
+${chalk.bold('USAGE')}
+  $ shoplazza app generate COMMAND
+
+${chalk.bold('COMMANDS')}
+  app generate extension  Generate a new app Extension.`;
+};
+
+module.exports = {
+  generateCommand
+};

package/lib/app/commands/index.js

@@ -0,0 +1,82 @@
+const chalk = require('chalk');
+const { Command } = require('commander');
+const { configCommand } = require('./config');
+const { versionsCommand } = require('./versions');
+const { deployCommand } = require('./deploy');
+const { infoCommand } = require('./info');
+const { initCommand } = require('./init');
+const { generateCommand } = require('./generate');
+const { devCommand } = require('./dev');
+const path = require('path');
+const { ssoStore, configStore, installStore } = require('../store');
+const { existsPath } = require('../utils/path');
+const { errorMessageRender } = require('../utils/views/message');
+const { isDebug } = require('../utils/debug');
+const appCommand = new Command('app')
+  .description('Build Shoplazza apps.')
+  .option('--reset', 'Reset app cache') // 重置 app 的本地缓存
+  .addCommand(initCommand)
+  .addCommand(infoCommand)
+  .addCommand(deployCommand)
+  .addCommand(configCommand)
+  .addCommand(versionsCommand)
+  .addCommand(generateCommand)
+  .addCommand(devCommand);
+
+// 在 appCommand 执行任何子命令前加载 dotenv
+appCommand.hook('preAction', (thisCommand, actionCommand) => {
+  const { path: argPath = '.' } = actionCommand.opts();
+
+  const { reset: argReset } = thisCommand.opts();
+
+  const projectDir = path.resolve(process.cwd(), argPath);
+
+  if (!existsPath(projectDir)) {
+    errorMessageRender(`Couldn't find directory ${projectDir}`);
+    process.exit(1);
+  }
+
+  require('dotenv').config({
+    path: path.join(projectDir, '.env')
+  });
+
+  // 增加环境变量
+  process.env.APP_PROJECT_DIR = projectDir;
+
+  if (isDebug()) {
+    // 设置调试模式
+    process.env.DEBUG = true;
+  }
+
+  if (argReset) {
+    // 清空 app config 缓存
+    configStore.clear();
+    // 清空 app clientId 对应店铺授权信息
+    installStore.clear();
+    // 清空 app access_token
+    ssoStore.clear();
+  }
+});
+
+appCommand.helpInformation = function () {
+  return `Build Shoplazza app.
+
+${chalk.bold('USAGE')}
+  $ shoplazza app COMMAND [options]
+
+${chalk.bold('TOPICS')}
+  app config    Manage app configuration.
+  app generate  Generate a new app Extension.
+  app versions  List deployed versions of your app.
+
+${chalk.bold('COMMANDS')}
+  app init    Create a new app project.
+  app info    Print basic information about your app and extensions.
+  app dev     Run the app.
+  app deploy  Deploy your Shoplazza app.
+`;
+};
+
+module.exports = {
+  appCommand
+};

package/lib/app/commands/info/actions/info.js

@@ -0,0 +1,168 @@
+const path = require('path');
+const fs = require('fs');
+const glob = require('glob');
+const chalk = require('chalk');
+
+const { parseTomlFile } = require('../../../utils/toml');
+const { withErrorHandling } = require('../../../utils/error');
+const { warningMessageRender, infoMessageRender } = require('../../../utils/views/message');
+const { getAppCompleteInfoRequest } = require('../../../api/cli');
+const { getActiveConfigFile } = require('../../../services/config');
+
+// 整理 extensions 信息
+function getExtensionInfo(projectDir) {
+  const extnesions = glob.sync(path.join(projectDir, 'extensions/**/*.toml'));
+
+  const extensionsInfo = extnesions.map((extension) => {
+    const extensionInfo = parseTomlFile(extension);
+    return {
+      name: extensionInfo.name,
+      type: extensionInfo.type
+    };
+  });
+
+  // 获取 extnesions 中 name 最长的长度
+  const maxNameLength = Math.max(...extensionsInfo.map((item) => item.name.length));
+
+  // padEnd 长度
+  const result = extensionsInfo.map((item) => {
+    return `${item.name.padEnd(maxNameLength)}   ${chalk.gray(`(${item.type})`)}`;
+  });
+
+  return result.join('\n');
+}
+
+async function infoAction(options) {
+  const { path: argPath = '.' } = options;
+  // 项目地址
+  const projectDir = path.resolve(argPath);
+
+  // 判断项目是否存在
+  if (!fs.existsSync(projectDir)) {
+    throw new Error(`Couldn't find directory ${projectDir}`);
+  }
+
+  // 获取当前正在使用的 configFile
+  const activeConfigFile = getActiveConfigFile(projectDir);
+
+  // 判断 configFile 是否存在
+  if (!fs.existsSync(path.join(projectDir, activeConfigFile))) {
+    // 获取 projectDir 根目录下 所有的 shoplazza.app.*.toml
+    const configFiles = glob.sync(path.join(projectDir, 'shoplazza.app.*.toml'));
+
+    // 如果 configFiles 为空，则抛出错误
+    if (configFiles.length === 0) {
+      warningMessageRender(
+        `No config file found, please use ${chalk.hex('#d079f8')(
+          '`shoplazza app config link`'
+        )} to create a new config file`
+      );
+    } else {
+      warningMessageRender(
+        `No active config file found, please use ${chalk.hex('#d079f8')(
+          '`shoplazza app config use`'
+        )} to switch to a new config file`
+      );
+    }
+
+    process.exit(1);
+  }
+
+  // 获取 configFile 信息
+  const configContent = parseTomlFile(path.join(projectDir, activeConfigFile));
+
+  // 获取 app 相关信息
+  const { user, partner, app } = await getAppCompleteInfoRequest(configContent.client_id);
+
+  // userObj
+  const userObj = [
+    {
+      label: 'Configuration file',
+      value: activeConfigFile
+    },
+    {
+      label: 'App name',
+      value: app.name
+    },
+    {
+      label: 'App Client ID',
+      value: configContent.client_id
+    },
+    {
+      label: 'Access scopes',
+      value: configContent.scopes
+    },
+    {
+      label: 'User',
+      value: user.shoplazza_account
+    }
+  ];
+
+  // your project
+  const projectObj = [
+    {
+      label: 'Root location',
+      value: projectDir
+    }
+  ];
+
+  // tooling and system
+  const toolingObj = [
+    {
+      label: 'Shoplazza CLI',
+      value: `v${require('../../../../../package.json').version}`
+    },
+    {
+      label: 'OS',
+      value: `${process.platform}-${process.arch}`
+    },
+    {
+      label: 'Shell',
+      value: process.env.SHELL
+    },
+    {
+      label: 'Node',
+      value: process.version
+    }
+  ];
+
+  const userObjStr = userObj
+    .map((item) => {
+      return `${chalk.gray(item.label.padEnd(20))} ${item.value || ''}`;
+    })
+    .join('\n');
+
+  const projectObjStr = projectObj
+    .map((item) => {
+      return `${chalk.gray(item.label.padEnd(20))} ${item.value || ''}`;
+    })
+    .join('\n');
+
+  const toolingObjStr = toolingObj
+    .map((item) => {
+      return `${chalk.gray(item.label.padEnd(20))} ${item.value || ''}`;
+    })
+    .join('\n');
+
+  // 展示 CURRENT APP CONFIGURATION
+  infoMessageRender(`${chalk.bold('CURRENT APP CONFIGURATION')}
+
+${userObjStr}
+
+${chalk.bold('YOUR PROJECT')}
+
+${projectObjStr}
+
+${chalk.bold('DIRECTORY COMPONENTS')}
+
+${getExtensionInfo(projectDir)}
+
+${chalk.bold('TOOLING AND SYSTEM')}
+
+${toolingObjStr}
+`);
+}
+
+module.exports = {
+  infoAction: withErrorHandling(infoAction)
+};

package/lib/app/commands/info/index.js

@@ -0,0 +1,11 @@
+const { Command } = require('commander');
+const { infoAction } = require('./actions/info');
+const infoCommand = new Command('info');
+
+infoCommand.option('--path <path>', 'The path to your app directory');
+
+infoCommand.action(infoAction);
+
+module.exports = {
+  infoCommand
+};