@akinon/projectzero 1.0.0

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "bracketSameLine": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "bracketSpacing": true,
+  "semi": true,
+  "useTabs": false,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "proseWrap": "never",
+  "trailingComma": "none"
+}

package/README.md

@@ -0,0 +1,18 @@
+# Project Zero CLI
+
+This is the command line interface for Project Zero Next.
+
+## Installation
+
+```bash
+npm install -g @akinon/projectzero
+```
+
+## Available Commands
+
+### `create`
+It creates a new project.
+
+```bash
+npx @akinon/projectzero --create
+```

package/commands/add-language.ts

@@ -0,0 +1,111 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+const argv = require("yargs").argv;
+
+export default () => {
+  /**
+   * @param {string} src  The path to the thing to copy.
+   * @param {string} dest The path to the new copy.
+   * @param {string} lng Get Language
+   */
+  const addLanguage = (src: string, dest: string, lng: string) => {
+    const exists = fs.existsSync(src);
+    const stats = exists && fs.statSync(src);
+    const isDirectory = exists && stats.isDirectory();
+    if (isDirectory) {
+      fs.mkdirSync(dest);
+      fs.readdirSync(src).forEach((childItemName: string) => {
+        addLanguage(
+          path.join(src, childItemName),
+          path.join(dest, childItemName),
+          lng
+        );
+      });
+
+      console.log(
+        "\x1b[32m%s\x1b[0m",
+        `\n✓ Added language option ${lng.toUpperCase()}.\nDon't forget to translate '${lng.toUpperCase()}' translation files inside 'public/locales/${lng.toUpperCase()}'\n`
+      );
+
+      console.log("\x1b[33m%s\x1b[0m", "Project Zero - Akinon\n");
+    } else {
+      fs.copyFileSync(src, dest);
+    }
+  };
+
+  const i18nDocumentUpdate = (lng: string) => {
+    /* next-i18next.config.js */
+    const workingDir = path.resolve(process.cwd());
+
+    const i18nPath = path.resolve(workingDir, "next-i18next.config.js");
+
+    if (!fs.existsSync(i18nPath)) {
+      return;
+    }
+
+    const i18nData = fs.readFileSync(i18nPath, {
+      encoding: "utf8",
+      flag: "r",
+    });
+
+    fs.writeFileSync(
+      i18nPath,
+      i18nData.replace(/locales: '*.'/, `locales: ['${lng}', '`)
+    );
+
+    /* settings.js */
+
+    const settingsPath = path.resolve(workingDir, "src/settings.js");
+
+    if (!fs.existsSync(settingsPath)) {
+      return;
+    }
+
+    const settingsData = fs.readFileSync(settingsPath, {
+      encoding: "utf8",
+      flag: "r",
+    });
+
+    const data = `{ label: '${lng.toUpperCase()}', value: '${lng.toLowerCase()}', apiValue: '${
+      argv.addLanguage
+    }' }`;
+
+    const changes = "languages: [";
+
+    fs.writeFileSync(
+      settingsPath,
+      settingsData.replace(changes, `languages: [\n\t\t${data},`)
+    );
+  };
+
+  const init = () => {
+    if (!argv.addLanguage) return;
+    let lng = argv.addLanguage;
+    lng = lng.split("-")[0];
+
+    const dest = `public/locales/${lng}`;
+    const exists = fs.existsSync(dest);
+
+    try {
+      if (exists)
+        throw new Error(`${lng.toUpperCase()} has already been added`);
+      addLanguage("public/locales/en", `public/locales/${lng}`, lng);
+      i18nDocumentUpdate(lng);
+    } catch (err) {
+      const typedError = err as Error;
+
+      console.log(
+        "\n\x1b[31m%s\x1b[0m",
+        `${
+          typedError.message
+            ? typedError.message + "\n"
+            : "Something went wrong.\n"
+        }`
+      );
+    }
+  };
+
+  init();
+};

package/commands/commerce-url.ts

@@ -0,0 +1,33 @@
+import * as fs from 'fs';
+import path from 'path';
+
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
+const args = yargs(hideBin(process.argv)).argv;
+
+export default () => {
+  const workingDir = path.resolve(process.cwd());
+  const settingsPath = path.resolve(workingDir, './src/settings.js');
+
+  if (!fs.existsSync(settingsPath)) {
+    return;
+  }
+
+  const settingsData = fs.readFileSync(settingsPath, {
+    encoding: 'utf8',
+    flag: 'r'
+  });
+
+  fs.writeFileSync(
+    settingsPath,
+    settingsData.replace(
+      /commerceUrl: '.*'/,
+      `commerceUrl: '${args.commerceUrl}'`
+    )
+  );
+
+  console.log(
+    '\x1b[32m%s\x1b[0m',
+    `\n ✓ Commerce URL is set to ${args.commerceUrl}.\n\n`
+  );
+};

package/commands/create.ts

@@ -0,0 +1,228 @@
+import path from 'path';
+import * as fs from 'fs';
+import * as readline from 'readline';
+import { slugify } from '../utils';
+import { execSync } from 'child_process';
+
+const exec = require('child_process').exec;
+const loadingSpinner = require('loading-spinner');
+
+interface Question {
+  text: string;
+  optional: boolean;
+  answerKey: string;
+  hint?: string;
+}
+
+interface Answers {
+  [key: string]: string;
+}
+
+const repositorySlug = 'projectzeropwa';
+const tempDirName = '.pz-temp';
+const workingDir = path.resolve(process.cwd());
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+const ANSWERS: Answers = {};
+
+const QUESTIONS: Array<Question> = [
+  {
+    text: 'Brand name',
+    optional: false,
+    answerKey: 'brandName',
+    hint: 'eg. Project Zero'
+  },
+  {
+    text: 'Project description',
+    optional: true,
+    answerKey: 'projectDescription'
+  },
+  {
+    text: 'Commerce URL (SERVICE_BACKEND_URL)',
+    optional: true,
+    answerKey: 'commerceUrl',
+    hint: 'Can be changed later'
+  }
+];
+
+const getAnswers = () => {
+  return new Promise<Answers>((resolve) => {
+    const question = QUESTIONS[Object.keys(ANSWERS).length];
+
+    if (!question) {
+      rl.close();
+      resolve(ANSWERS);
+      return;
+    }
+
+    let questionText = question.text;
+
+    if (question.hint) {
+      questionText += ` (${question.hint})`;
+    }
+
+    if (question.optional) {
+      questionText += ` (optional)`;
+    }
+
+    rl.question(`${questionText}: `, (answer: string) => {
+      if (!question.optional && !answer.length) {
+        console.log('\x1b[31m%s\x1b[0m', `* This field is required\n`);
+        resolve(getAnswers());
+      } else {
+        ANSWERS[question.answerKey] = answer;
+        resolve(getAnswers());
+      }
+    });
+  });
+};
+
+const cloneRepository = () =>
+  new Promise<{ error?: Error }>((resolve) => {
+    execSync(`mkdir ${tempDirName}`);
+
+    exec(
+      `cd ${tempDirName} && git clone git@bitbucket.org:akinonteam/${repositorySlug}.git`,
+      function (err: any, stdout: any, stderr: any) {
+        if (err != null) {
+          resolve({ error: new Error(err) });
+        } else if (typeof stderr != 'string') {
+          resolve({ error: new Error(stderr) });
+        } else {
+          resolve({});
+        }
+      }
+    );
+  });
+
+const updatePackageJson = (brandName: string) => {
+  const packageJsonPath = path.resolve(
+    workingDir,
+    `./${tempDirName}/${repositorySlug}/package.json`
+  );
+
+  const packageJsonData = fs.readFileSync(packageJsonPath, {
+    encoding: 'utf8',
+    flag: 'r'
+  });
+
+  fs.writeFileSync(
+    packageJsonPath,
+    packageJsonData.replace(/"name": ".*"/, `"name": "${slugify(brandName)}"`)
+  );
+};
+
+const updateAkinonJson = (brandName: string, projectDescription: string) => {
+  const akinonJsonPath = path.resolve(
+    workingDir,
+    `./${tempDirName}/${repositorySlug}/akinon.json`
+  );
+
+  const akinonJsonData = fs.readFileSync(akinonJsonPath, {
+    encoding: 'utf8',
+    flag: 'r'
+  });
+
+  let updatedData = akinonJsonData.replace(
+    /"name": ".*"/,
+    `"name": "${brandName}"`
+  );
+
+  if (projectDescription) {
+    updatedData = updatedData.replace(
+      /"description": ".*"/,
+      `"description": "${projectDescription}"`
+    );
+  }
+
+  fs.writeFileSync(akinonJsonPath, updatedData);
+};
+
+const copyEnv = (commerceUrl: string) => {
+  const repositoryPath = path.resolve(
+    workingDir,
+    `./${tempDirName}/${repositorySlug}`
+  );
+
+  const envExamplePath = path.resolve(repositoryPath, `./.env.example`);
+  const envPath = path.resolve(repositoryPath, `./.env`);
+
+  const envData = fs.readFileSync(envExamplePath, {
+    encoding: 'utf8',
+    flag: 'r'
+  });
+
+  if (commerceUrl) {
+    fs.writeFileSync(
+      envExamplePath,
+      envData.replace(
+        /SERVICE_BACKEND_URL=.*/,
+        `SERVICE_BACKEND_URL=${commerceUrl}`
+      )
+    );
+  }
+
+  fs.copyFileSync(envExamplePath, envPath);
+};
+
+const updatePlugins = () => {
+  const pluginsPath = path.resolve(
+    workingDir,
+    `./${tempDirName}/${repositorySlug}/src/plugins.js`
+  );
+
+  fs.writeFileSync(pluginsPath, 'module.exports = [];');
+};
+
+export default async () => {
+  const answers = await getAnswers();
+
+  loadingSpinner.start();
+
+  await cloneRepository();
+  updatePackageJson(answers.brandName);
+  updateAkinonJson(answers.brandName, answers.projectDescription);
+  copyEnv(answers.commerceUrl);
+  updatePlugins();
+
+  const slugifiedBrandName = slugify(answers.brandName);
+
+  fs.rmSync(
+    path.resolve(workingDir, `./${tempDirName}/${repositorySlug}/.git`),
+    {
+      recursive: true,
+      force: true
+    }
+  );
+
+  fs.renameSync(
+    path.resolve(workingDir, `./${tempDirName}/${repositorySlug}`),
+    path.resolve(workingDir, `./${tempDirName}/${slugifiedBrandName}`)
+  );
+
+  fs.cpSync(
+    path.resolve(workingDir, `./${tempDirName}/${slugifiedBrandName}`),
+    path.resolve(workingDir, `./${slugifiedBrandName}`),
+    {
+      recursive: true,
+      force: true
+    }
+  );
+
+  fs.rmSync(path.resolve(workingDir, `./${tempDirName}/`), {
+    recursive: true,
+    force: true
+  });
+
+  loadingSpinner.stop();
+
+  console.log(
+    '\x1b[32m%s\x1b[0m',
+    `\n ✓ ${answers.brandName} project is ready.\n`
+  );
+
+  console.log('\x1b[33m%s\x1b[0m', 'Project Zero - Akinon\n');
+};

package/commands/default-language.ts

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+
+const argv = require("yargs").argv;
+
+export default () => {
+  const i18nDocumentUpdate = (lng: string) => {
+    /* next-i18next.config.js */
+    const workingDir = path.resolve(process.cwd());
+    const i18nPath = path.resolve(workingDir, "next-i18next.config.js");
+
+    if (!fs.existsSync(i18nPath)) {
+      return;
+    }
+
+    const i18nData = fs.readFileSync(i18nPath, {
+      encoding: "utf8",
+      flag: "r",
+    });
+
+    const regExpLiteral = "locales:(.+)+";
+
+    const result = i18nData.match(regExpLiteral);
+
+    if (result[1].search(lng) < 0) {
+      throw new Error(`${lng.toUpperCase()} not available`);
+    }
+
+    let updatedData = i18nData.replace(
+      /defaultLocale: '.*'/,
+      `defaultLocale: '${lng}'`
+    );
+
+    updatedData = updatedData.replace(
+      /fallbackLng: '.*'/,
+      `fallbackLng: '${lng}'`
+    );
+
+    fs.writeFileSync(i18nPath, updatedData);
+  };
+
+  const init = () => {
+    if (!argv.defaultLanguage) return;
+    let lng = argv.defaultLanguage;
+
+    try {
+      i18nDocumentUpdate(lng);
+      console.log(
+        "\x1b[32m%s\x1b[0m",
+        `\n✓ Set as the default language option ${lng.toUpperCase()}.\n`
+      );
+      console.log("\x1b[33m%s\x1b[0m", "Project Zero - Akinon\n");
+    } catch (err) {
+      const typedError = err as Error;
+
+      console.log(
+        "\n\x1b[31m%s\x1b[0m",
+        `${
+          typedError.message
+            ? typedError.message + "\n"
+            : "Something went wrong.\n"
+        }`
+      );
+    }
+  };
+
+  init();
+};

package/commands/index.ts

@@ -0,0 +1,15 @@
+import commerceUrl from './commerce-url';
+import create from './create';
+import addLanguage from './add-language';
+import removeLanguage from './remove-language';
+import defaultLanguage from './default-language';
+import plugins from './plugins';
+
+export default {
+  commerceUrl,
+  create,
+  addLanguage,
+  removeLanguage,
+  defaultLanguage,
+  plugins
+};

package/commands/plugins.ts

@@ -0,0 +1,70 @@
+import * as fs from 'fs';
+import path from 'path';
+import { execSync } from 'child_process';
+
+const Prompt = require('prompt-checkbox');
+
+const rootDir = path.resolve(process.cwd());
+const pluginsFilePath = path.resolve(rootDir, './src/plugins.js');
+
+let installedPlugins: Array<string> = [];
+
+try {
+  installedPlugins = require(path.resolve(rootDir, './src/plugins.js'));
+} catch (error) {}
+
+const definedPlugins = [
+  {
+    name: 'Basket Gift Pack',
+    value: 'pz-basket-gift-package'
+  }
+];
+
+export default async () => {
+  const prompt = new Prompt({
+    name: 'plugins',
+    message: 'Please check/uncheck plugins to install/uninstall.',
+    type: 'checkbox',
+    default: installedPlugins.map((p) =>
+      definedPlugins.findIndex((dp) => dp.value === p)
+    ),
+    choices: definedPlugins.map((p, index) => `${index + 1}) ${p.name}`)
+  });
+
+  prompt.ask(async (answers: Array<string>) => {
+    const formattedAnswers = answers.map((answer) =>
+      answer.replace(/\d\)\s/, '')
+    );
+
+    const values = formattedAnswers.map(
+      (answer) => definedPlugins.find((p) => p.name === answer)?.value
+    );
+
+    if (formattedAnswers.length) {
+      console.log(`\nInstalling ${formattedAnswers.join(', ')}.`);
+    } else {
+      console.log(`\nUninstalling all plugins.`);
+    }
+
+    console.log(`\nPlease wait...`);
+
+    fs.writeFileSync(
+      pluginsFilePath,
+      `module.exports = ${JSON.stringify(values)};\n`,
+      {
+        encoding: 'utf-8'
+      }
+    );
+
+    execSync('yarn install', { stdio: 'pipe' });
+
+    console.log(
+      '\x1b[32m%s\x1b[0m',
+      `\n ✓ ${
+        formattedAnswers.length
+          ? 'Installed selected plugins'
+          : 'Uninstalled all plugins'
+      }.\n`
+    );
+  });
+};

package/commands/remove-language.ts

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+const argv = require("yargs").argv;
+
+export default () => {
+  /**
+   * @param {string} lng  Get Language
+   */
+
+  const removeLanguage = (lng: string) => {
+    const workingDir = path.resolve(process.cwd());
+
+    try {
+      fs.rm(`public/locales/${lng}`, { recursive: true }, (err: any) => {
+        if (err) {
+          console.error(err);
+          return;
+        }
+      });
+    } catch (error) {
+      console.log("error", error);
+    }
+
+    /* settings.js */
+
+    const settingsPath = path.resolve(workingDir, "src/settings.js");
+
+    if (!fs.existsSync(settingsPath)) {
+      return;
+    }
+
+    const settingsData = fs.readFileSync(settingsPath, {
+      encoding: "utf8",
+      flag: "r",
+    });
+
+    const data = `{ label: '${lng.toUpperCase()}', value: '${lng.toLowerCase()}', apiValue: '${lng.toLowerCase()}-${lng.toLowerCase()}' },`;
+
+    let updatedData = settingsData.replace(data.toString(), "");
+
+    updatedData = updatedData.replace(/^\s*$(?:\r\n?|\n)/gm, "");
+
+    fs.writeFileSync(settingsPath, updatedData);
+
+    /* next-i18next.config.js */
+
+    const i18nPath = path.resolve(workingDir, "next-i18next.config.js");
+
+    if (!fs.existsSync(i18nPath)) {
+      return;
+    }
+
+    const i18nData = fs.readFileSync(i18nPath, {
+      encoding: "utf8",
+      flag: "r",
+    });
+
+    fs.writeFileSync(i18nPath, i18nData.replace(`'${lng}',\u0020`, ""));
+
+    console.log(
+      "\x1b[32m%s\x1b[0m",
+      `\n✓ Remove language option ${lng.toUpperCase()}.\n`
+    );
+
+    console.log("\x1b[33m%s\x1b[0m", "Project Zero - Akinon\n");
+  };
+
+  const init = () => {
+    if (!argv.removeLanguage) return;
+    let lng = argv.removeLanguage;
+
+    try {
+      removeLanguage(lng);
+    } catch (err) {
+      const typedError = err as Error;
+
+      console.log(
+        "\n\x1b[31m%s\x1b[0m",
+        `${
+          typedError.message
+            ? typedError.message + "\n"
+            : "Something went wrong.\n"
+        }`
+      );
+    }
+  };
+
+  init();
+};