v.1.0.0

Author: razbakov

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

README.md

@@ -0,0 +1,65 @@
+# @razbakov/sourcy
+
+> Synchronise data from Google Sheets
+
+## Installation
+
+```bash
+yarn add @razbakov/sourcy -D
+```
+
+Add to package.json:
+
+```json
+{
+  "scripts": {
+    "sourcy": "sourcy"
+  }
+}
+```
+
+Create **sourcy.config.js** in project root:
+
+```js
+module.exports = {
+  sources: [
+    {
+      spreadsheetId: "spreadsheet id",
+      range: "sheet name",
+      output: "./locales/",
+      transformer: "i18n",
+      format: "yaml", // or json
+    },
+  ],
+};
+```
+
+Execute and follow instructions:
+
+```bash
+yarn sourcy
+```
+
+## Transformer: i18n
+
+**Input:**
+
+| key        | en   | de         | es             | ru      |
+| ---------- | ---- | ---------- | -------------- | ------- |
+| home.title | Home | Startseite | Página inicial | Главная |
+
+**Output:**
+
+```
+en.yml
+    home.title: Home
+
+de.yml
+    home.title: Startseite
+
+es.yml
+    home.title: Página inicial
+
+ru.yml
+    home.title: Главная
+```

lib/auth.js

@@ -0,0 +1,90 @@
+import { google } from "googleapis";
+import { promises as fs } from "fs";
+import inquirer from "inquirer";
+import mkdirp from "mkdirp";
+import { dirname } from "path";
+
+async function loadJson(path) {
+  let result = false;
+
+  try {
+    const json = await fs.readFile(path);
+    result = JSON.parse(json);
+  } catch (err) {}
+
+  return result;
+}
+
+async function getNewCredentials(config) {
+  console.log(
+    `Download credentials.json from https://developers.google.com/sheets/api/quickstart/nodejs`
+  );
+
+  const { filePath } = await inquirer.prompt([
+    {
+      type: "input",
+      name: "filePath",
+      message: "Enter full path to downloaded file",
+    },
+  ]);
+
+  const credentials = await loadJson(filePath);
+
+  if (!credentials) {
+    throw Error("Unable to load credentials");
+  }
+
+  return credentials;
+}
+
+async function getNewToken(oAuth2Client, scope) {
+  const authUrl = oAuth2Client.generateAuthUrl({
+    access_type: "offline",
+    scope,
+  });
+
+  console.log("Authorize this app by visiting this url: ", authUrl);
+
+  const { code } = await inquirer.prompt([
+    {
+      type: "input",
+      name: "code",
+      message: "Enter the code from that page here: ",
+    },
+  ]);
+
+  return await oAuth2Client.getToken(code);
+}
+
+async function auth(config) {
+  let credentials = await loadJson(config.credentialsPath);
+
+  if (!credentials) {
+    credentials = await getNewCredentials(config);
+    await mkdirp(dirname(config.credentialsPath));
+    await fs.writeFile(config.credentialsPath, JSON.stringify(credentials));
+  }
+
+  const { client_secret, client_id, redirect_uris } = credentials.installed;
+
+  const oAuth2Client = new google.auth.OAuth2(
+    client_id,
+    client_secret,
+    redirect_uris[0]
+  );
+
+  let token = await loadJson(config.tokenPath);
+
+  if (!token) {
+    token = await getNewToken(oAuth2Client, config.scope);
+    await fs.writeFile(config.tokenPath, JSON.stringify(token));
+  }
+
+  oAuth2Client.setCredentials(token);
+
+  google.options({
+    auth: oAuth2Client,
+  });
+}
+
+export default auth;

lib/config.js

@@ -0,0 +1,34 @@
+import path from "path";
+
+const userConfigPath = "sourcy.config.js";
+
+const defaultConfigPath = path.join(
+  __dirname,
+  "/../lib/config/default.config.js"
+);
+
+function resolvePath(filePath) {
+  if (filePath[0] === "~") {
+    return path.join(process.env.HOME, filePath.slice(1));
+  }
+
+  return path.resolve(filePath);
+}
+
+function loadConfig() {
+  const userConfig = require(resolvePath(userConfigPath));
+  const defaultConfig = require(defaultConfigPath);
+  const config = { ...defaultConfig, ...userConfig };
+
+  config.sources = config.sources.map((source) => ({
+    ...source,
+    output: resolvePath(source.output),
+  }));
+
+  config.credentialsPath = resolvePath(config.credentialsPath);
+  config.tokenPath = resolvePath(config.tokenPath);
+
+  return config;
+}
+
+export default loadConfig;

lib/config/default.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  credentialsPath: "~/config/sourcy/credentials.json",
+  tokenPath: "~/config/sourcy/token.json",
+  scope: "https://www.googleapis.com/auth/spreadsheets",
+};

lib/exporters/json.js

@@ -0,0 +1,8 @@
+import { promises as fs } from "fs";
+
+export default async (path, content) => {
+  const filePath = path + ".json";
+  await fs.writeFile(filePath, JSON.stringify(content));
+
+  return filePath;
+};

lib/exporters/yaml.js

@@ -0,0 +1,9 @@
+import YAML from "json2yaml";
+import { promises as fs } from "fs";
+
+export default async (path, content) => {
+  const filePath = path + ".yml";
+  await fs.writeFile(filePath, YAML.stringify(content));
+
+  return filePath;
+};

lib/index.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+
+import { google } from "googleapis";
+import loadConfig from "./config";
+import auth from "./auth";
+import i18n from "./transformers/i18n";
+import json from "./exporters/json";
+import yaml from "./exporters/yaml";
+import mkdirp from "mkdirp";
+import path from "path";
+
+function transform(rows, transformer) {
+  switch (transformer) {
+    case "i18n":
+      return i18n(rows);
+    default:
+      return rows;
+  }
+}
+
+async function save(filePath, content, format) {
+  switch (format) {
+    case "yaml":
+      return await yaml(filePath, content);
+    case "json":
+    default:
+      return await json(filePath, content);
+  }
+}
+
+async function main() {
+  const config = loadConfig();
+
+  await auth(config);
+
+  const sheets = google.sheets({ version: "v4" });
+
+  for (let source of config.sources) {
+    const res = await sheets.spreadsheets.values.get({
+      spreadsheetId: source.spreadsheetId,
+      range: source.range,
+    });
+
+    const content = transform(res.data.values, source.transformer);
+
+    await mkdirp(source.output);
+
+    const files = Object.keys(content.files);
+
+    for (let file of files) {
+      const filePath = path.join(source.output, file);
+      try {
+        const savedFile = await save(
+          filePath,
+          content.files[file],
+          source.format
+        );
+
+        console.log("Saved ", savedFile);
+      } catch (error) {
+        console.error(error);
+      }
+    }
+  }
+}
+
+(async function () {
+  await main();
+})();

lib/transformers/i18n.js

@@ -0,0 +1,16 @@
+export default (rows) => {
+  const result = {};
+  const header = rows[0];
+
+  for (let j = 1; j < header.length; j++) {
+    result[header[j]] = result[header[j]] || {};
+
+    for (let i = 1; i < rows.length; i++) {
+      result[header[j]][rows[i][0]] = rows[i][j];
+    }
+  }
+
+  return {
+    files: result,
+  };
+};

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@razbakov/sourcy",
+  "version": "1.0.0",
+  "license": "MIT",
+  "description": "Synchronise data from Google Sheets",
+  "bin": {
+    "sourcy": "dist/index.js"
+  },
+  "scripts": {
+    "build": "babel lib --out-dir dist"
+  },
+  "dependencies": {
+    "googleapis": "^47.0.0",
+    "inquirer": "^7.3.3",
+    "json2yaml": "^1.1.0",
+    "mkdirp": "^1.0.4"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.11.6",
+    "@babel/core": "^7.11.6",
+    "@babel/preset-env": "^7.11.5",
+    "babel-plugin-module-resolver": "^4.0.0",
+    "babel-plugin-root-import": "^6.5.0"
+  },
+  "babel": {
+    "presets": [
+      [
+        "@babel/preset-env",
+        {
+          "targets": {
+            "node": "8.9.0"
+          }
+        }
+      ]
+    ]
+  },
+  "engines": {
+    "node": ">=8.9.0"
+  }
+}