feat: improve doc and cli

README.md

@@ -14,23 +14,67 @@ For every article it compares the content and then:
 
 ## Todo
 
-[] Add support for canonical urls
-[] Add support for images
+[ ] Add support for canonical urls
+
+[ ] Add support for images
 
 ## Supported blog platforms
 
 - DevTo
 
+## Quick Start
+
+1. Make sure you have the correct folder structure
+
+```
+- blog-articles
+  - article one
+    - index.md
+  - article two
+    - index.md
+```
+
+2. Add a masterid to the articles you want to sync
+
+```markdown
+---
+title: "Sample Blog Post"
+published: false
+description: "This is an example"
+tags: discuss, javascript
+masterid: 123
+---
+
+Lorem Ipsum..
+```
+
+3. Run Papertown with a valid api key
+
+```
+papertown sync --devtoApiKey yourdevtoapikey
+```
+
 ## Configuration
 
-### 1: Use a .env file
+| Config        | Env           | Args        |
+| ------------- | ------------- | ----------- |
+| Root Folder   | ROOT_FOLDER   | rootFolder  |
+| API Key DevTo | DEVTO_API_KEY | devtoApiKey |
+
+### 1: Use args
+
+```
+papertown sync --devtoApiKey yourdevtoapikey
+```
+
+### 2: Use a .env file
 
-````
+```
 DEVTO_API_KEY="yourdevtoapikey"
-````
+```
 
-### 2: Set env variables before running problogger
+### 3: Set env variables before running papertown
 
-````
-DEVTO_API_KEY="yourdevtoapikey" problogger sync
-````
+```
+DEVTO_API_KEY="yourdevtoapikey" papertown sync
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "papertown",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

src/config.ts

@@ -4,17 +4,19 @@ import * as dotenv from "dotenv";
 dotenv.config();
 
 export const config = convict({
-  articlesFolder: {
+  rootFolder: {
     doc: "Root folder of articles",
     format: String,
     default: "blog-articles",
-    env: "ARTICLES_FOLDER"
+    env: "ROOT_FOLDER",
+    arg: "rootFolder"
   },
   devtoApiKey: {
     doc: "DevTo API Key",
     format: String,
     default: "",
-    env: "DEVTO_API_KEY"
+    env: "DEVTO_API_KEY",
+    arg: "devtoApiKey"
   }
 })
   .validate()

src/index.ts

@@ -1,18 +1,63 @@
 #!/usr/bin/env node
-import { getMasterArticlesWithMasterId } from "./masterArticles/master-articles";
-import { MasterArticle } from "./masterArticles/MasterArticle";
+import {
+  getMasterArticlesWithMasterId,
+  rootFolderExists,
+  haveDuplicateMasterIDs
+} from "./masterArticles/master-articles";
 import { syncBlogPlatformsWithMasters } from "./sync/sync";
 import { error } from "./utils/logger";
 import { config } from "./config";
+import { log } from "util";
+
+const usage = `
+Usage
+  $ papertown <command>
+  
+Commands
+  sync           Runs a sync
+
+Options
+  --rootFolder   Change the root folder
+  --devtoApiKey  Set the Api Key for DevTo
+
+Examples
+  $ foo sync --devtoApiKey asdf234asdf
+`;
 
 async function main() {
+  /**
+   * Check command
+   */
+  const command = process.argv[2];
+  const availableCommands = ["sync"];
+  if (availableCommands.indexOf(command) === -1) {
+    log(usage);
+    return;
+  }
+
+  /**
+   * Stop if root folder does not exist
+   */
+  if (!(await rootFolderExists(config.rootFolder))) {
+    error(`Root folder not found: ${config.rootFolder}`);
+    return;
+  }
+
   /**
    * Get all articles with an masterid in the frontmatter
    */
   const masterArticles = await getMasterArticlesWithMasterId(
-    config.articlesFolder
+    config.rootFolder
   );
 
+  /**
+   * Stop if no master articles were found
+   */
+  if (masterArticles.length === 0) {
+    error("No articles found with masterid");
+    return;
+  }
+
   /**
    * Stop if a masterid is used twice
    */
@@ -27,12 +72,4 @@ async function main() {
   await syncBlogPlatformsWithMasters(masterArticles, config);
 }
 
-/**
- * Check if a masterid is used more than once
- */
-function haveDuplicateMasterIDs(masterArticles: MasterArticle[]) {
-  const allIds = masterArticles.map(article => article.frontmatter.masterid);
-  return new Set(allIds).size !== allIds.length;
-}
-
 (async () => await main())();

src/masterArticles/master-articles.ts

@@ -6,6 +6,7 @@ import * as frontmatterParser from "frontmatter";
 
 const readDir = util.promisify(fs.readdir);
 const readFile = util.promisify(fs.readFile);
+const exists = util.promisify(fs.exists);
 
 export async function getMasterArticlesWithMasterId(
   rootFolder: string
@@ -14,6 +15,18 @@ export async function getMasterArticlesWithMasterId(
   return allMasterArticles.filter(hasMasterId);
 }
 
+export async function rootFolderExists(rootFolder) {
+  return await exists(rootFolder);
+}
+
+/**
+ * Check if a masterid is used more than once
+ */
+export function haveDuplicateMasterIDs(masterArticles: MasterArticle[]) {
+  const allIds = masterArticles.map(article => article.frontmatter.masterid);
+  return new Set(allIds).size !== allIds.length;
+}
+
 /**
  * Structure has to be:
  * - rootFolder

src/utils/logger.ts

@@ -1,5 +1,5 @@
 import chalk from "chalk";
-const appName = "ProBlogger:";
+const appName = "Papertown:";
 
 export function error(message: string) {
   console.log(`${chalk.green(appName)} ${chalk.red(message)}`);