Clarify type of id used

[rbdr/blog] / lib / blog.js

diff --git a/lib/blog.js b/lib/blog.js
index f31234b526f7289f767bbadb04bb47134c0d9798..9024a00b95ce825ed5e0244bc322a9fe1762ec36 100644 (file)
--- a/lib/blog.js
+++ b/lib/blog.js
@@ -1,27 +1,20 @@
 'use strict';
 
 'use strict';
 

-const Fs = require('fs');
-const Mustache = require('mustache');
-const Ncp = require('ncp');
-const Path = require('path');
-const Rimraf = require('rimraf');
-const Showdown = require('showdown');
-const Util = require('util');
+const { exec } = require('child_process');
+const { access, mkdir, readdir, readFile, rmdir, writeFile } = require('fs/promises');
+const { template } = require('dot');
+const { ncp } = require('ncp');
+const { join } = require('path');
+const Marked = require('marked');
+const { debuglog, promisify } = require('util');

 
 const internals = {
 
   // Promisified functions
 
 const internals = {
 
   // Promisified functions

+  ncp: promisify(ncp),

 
 

-  fs: {
-    access: Util.promisify(Fs.access),
-    mkdir: Util.promisify(Fs.mkdir),
-    readdir: Util.promisify(Fs.readdir),
-    readFile: Util.promisify(Fs.readFile),
-    writeFile: Util.promisify(Fs.writeFile)
-  },
-  ncp: Util.promisify(Ncp.ncp),
-  rimraf: Util.promisify(Rimraf),
-  debuglog: Util.debuglog('blog'),
+  exec: promisify(exec),
+  debuglog: debuglog('blog'),

 
   // constants
 
 
   // constants
 


@@ -29,6 +22,7 @@ const internals = {
   kIndexName: 'index.html',
   kFileNotFoundError: 'ENOENT',
   kMarkdownRe: /\.md$/i,
   kIndexName: 'index.html',
   kFileNotFoundError: 'ENOENT',
   kMarkdownRe: /\.md$/i,

+  kRemoveCommand: 'rm -rf',

 
   // Strings
 
 
   // Strings
 


@@ -93,42 +87,42 @@ module.exports = class Blog {
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */

-  async publish() {
+  publish() {

 
     console.error('Publishing not yet implemented');
 
     console.error('Publishing not yet implemented');

+    return Promise.resolve();

   }
 
   // Parses markdown for each page, copies assets and generates index.
 
   async _generate() {
 
   }
 
   // Parses markdown for each page, copies assets and generates index.
 
   async _generate() {
 

-    const assetsTarget = Path.join(this.staticDirectory, internals.kAssetsDirectoryName);
-    const indexTarget = Path.join(this.staticDirectory, internals.kIndexName);
-    const indexLocation = Path.join(this.templatesDirectory, internals.kIndexName);
+    const assetsTarget = join(this.staticDirectory, internals.kAssetsDirectoryName);
+    const indexTarget = join(this.staticDirectory, internals.kIndexName);
+    const indexLocation = join(this.templatesDirectory, internals.kIndexName);

     const posts = [];
 
     internals.debuglog(`Removing ${assetsTarget}`);
     const posts = [];
 
     internals.debuglog(`Removing ${assetsTarget}`);

-    await internals.rimraf(assetsTarget);
+    await rmdir(assetsTarget, { recursive: true });

 
     for (let i = 0; i < this.maxPosts; ++i) {
 
     for (let i = 0; i < this.maxPosts; ++i) {

-      const sourcePath = Path.join(this.postsDirectory, `${i}`);
+      const sourcePath = join(this.postsDirectory, `${i}`);

 
       try {
 
       try {

-        await internals.fs.access(this.postsDirectory);
+        await access(this.postsDirectory);

 
 

-        const assetsSource = Path.join(sourcePath, internals.kAssetsDirectoryName);
+        const assetsSource = join(sourcePath, internals.kAssetsDirectoryName);

         const postContentPath = await this._findBlogContent(sourcePath);
 
         internals.debuglog(`Copying ${assetsSource} to ${assetsTarget}`);
         await internals.ncp(assetsSource, assetsTarget);
 
         internals.debuglog(`Reading ${postContentPath}`);
         const postContentPath = await this._findBlogContent(sourcePath);
 
         internals.debuglog(`Copying ${assetsSource} to ${assetsTarget}`);
         await internals.ncp(assetsSource, assetsTarget);
 
         internals.debuglog(`Reading ${postContentPath}`);

-        const postContent = await internals.fs.readFile(postContentPath, { encoding: 'utf8' });
+        const postContent = await readFile(postContentPath, { encoding: 'utf8' });

 
         internals.debuglog('Parsing markdown');
 
         internals.debuglog('Parsing markdown');

-        const parser = new Showdown.Converter();

         posts.push({
         posts.push({

-          html: parser.makeHtml(postContent),
+          html: Marked(postContent),

           id: i + 1
         });
       }
           id: i + 1
         });
       }


@@ -143,11 +137,11 @@ module.exports = class Blog {
     }
 
     internals.debuglog(`Reading ${indexLocation}`);
     }
 
     internals.debuglog(`Reading ${indexLocation}`);

-    const indexTemplate = await internals.fs.readFile(indexLocation, { encoding: 'utf8' });
+    const indexTemplate = await readFile(indexLocation, { encoding: 'utf8' });

 
     internals.debuglog('Generating HTML');
 
     internals.debuglog('Generating HTML');

-    const indexHtml = Mustache.render(indexTemplate, { posts });
-    await internals.fs.writeFile(indexTarget, indexHtml);
+    const indexHtml = template(indexTemplate)({ posts });
+    await writeFile(indexTarget, indexHtml);

   }
 
   // Shift the posts, delete any remainder.
   }
 
   // Shift the posts, delete any remainder.


@@ -157,14 +151,14 @@ module.exports = class Blog {
     await this._ensurePostsDirectoryExists();
 
     for (let i = this.maxPosts - 1; i > 0; --i) {
     await this._ensurePostsDirectoryExists();
 
     for (let i = this.maxPosts - 1; i > 0; --i) {

-      const targetPath = Path.join(this.postsDirectory, `${i}`);
-      const sourcePath = Path.join(this.postsDirectory, `${i - 1}`);
+      const targetPath = join(this.postsDirectory, `${i}`);
+      const sourcePath = join(this.postsDirectory, `${i - 1}`);

 
       try {
 
       try {

-        await internals.fs.access(sourcePath);
+        await access(sourcePath);

 
         internals.debuglog(`Removing ${targetPath}`);
 
         internals.debuglog(`Removing ${targetPath}`);

-        await internals.rimraf(targetPath);
+        await rmdir(targetPath, { recursive: true });

 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);
         await internals.ncp(sourcePath, targetPath);
 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);
         await internals.ncp(sourcePath, targetPath);


@@ -186,10 +180,10 @@ module.exports = class Blog {
 
     await this._ensurePostsDirectoryExists();
 
 
     await this._ensurePostsDirectoryExists();
 

-    const targetPath = Path.join(this.postsDirectory, '0');
+    const targetPath = join(this.postsDirectory, '0');

 
     internals.debuglog(`Removing ${targetPath}`);
 
     internals.debuglog(`Removing ${targetPath}`);

-    await internals.rimraf(targetPath);
+    await rmdir(targetPath, { recursive: true });

 
     internals.debuglog(`Adding ${postLocation} to ${targetPath}`);
     await internals.ncp(postLocation, targetPath);
 
     internals.debuglog(`Adding ${postLocation} to ${targetPath}`);
     await internals.ncp(postLocation, targetPath);


@@ -201,12 +195,12 @@ module.exports = class Blog {
 
     internals.debuglog(`Checking if ${this.postsDirectory} exists.`);
     try {
 
     internals.debuglog(`Checking if ${this.postsDirectory} exists.`);
     try {

-      await internals.fs.access(this.postsDirectory);
+      await access(this.postsDirectory);

     }
     catch (error) {
       if (error.code === internals.kFileNotFoundError) {
         internals.debuglog('Creating posts directory');
     }
     catch (error) {
       if (error.code === internals.kFileNotFoundError) {
         internals.debuglog('Creating posts directory');

-        await internals.fs.mkdir(this.postsDirectory);
+        await mkdir(this.postsDirectory);

         return;
       }
 
         return;
       }
 


@@ -218,11 +212,11 @@ module.exports = class Blog {
 
   async _findBlogContent(directory) {
 
 
   async _findBlogContent(directory) {
 

-    const entries = await internals.fs.readdir(directory);
+    const entries = await readdir(directory);

 
     const markdownEntries = entries
       .filter((entry) => internals.kMarkdownRe.test(entry))
 
     const markdownEntries = entries
       .filter((entry) => internals.kMarkdownRe.test(entry))

-      .map((entry) => Path.join(directory, entry));
+      .map((entry) => join(directory, entry));

 
     if (markdownEntries.length > 0) {
       internals.debuglog(`Found markdown file: ${markdownEntries[0]}`);
 
     if (markdownEntries.length > 0) {
       internals.debuglog(`Found markdown file: ${markdownEntries[0]}`);