adding

2 years ago · 184c5fc61e
parent 918c0896e7
commit 184c5fc61e
14 changed files with 94 additions and 39 deletions
--- a/package-lock.json
+++ b/package-lock.json
@ -1,13 +1,14 @@
 {
-    "name": "@/siteomat-webpack-plugin",
+    "name": "@helpers/siteomat-webpack-plugin",
    "version": "0.1.0",
    "lockfileVersion": 2,
    "requires": true,
    "packages": {
        "": {
-            "name": "@/siteomat-webpack-plugin",
+            "name": "@helpers/siteomat-webpack-plugin",
            "version": "0.1.0",
            "dependencies": {
+                "assign-deep": "^1.0.1",
                "crypto": "^1.0.1",
                "dayjs": "^1.11.6",
                "fast-xml-parser": "^4.0.11",
@ -38,6 +39,25 @@
            "resolved": "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz",
            "integrity": "sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA=="
        },
+        "node_modules/assign-deep": {
+            "version": "1.0.1",
+            "resolved": "https://registry.npmjs.org/assign-deep/-/assign-deep-1.0.1.tgz",
+            "integrity": "sha512-CSXAX79mibneEYfqLT5FEmkqR5WXF+xDRjgQQuVf6wSCXCYU8/vHttPidNar7wJ5BFmKAo8Wei0rCtzb+M/yeA==",
+            "dependencies": {
+                "assign-symbols": "^2.0.2"
+            },
+            "engines": {
+                "node": ">=6"
+            }
+        },
+        "node_modules/assign-symbols": {
+            "version": "2.0.2",
+            "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-2.0.2.tgz",
+            "integrity": "sha512-9sBQUQZMKFKcO/C3Bo6Rx4CQany0R0UeVcefNGRRdW2vbmaMOhV1sbmlXcQLcD56juLXbSGTBm0GGuvmrAF8pA==",
+            "engines": {
+                "node": ">=6"
+            }
+        },
        "node_modules/base64-js": {
            "version": "1.5.1",
            "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
@ -766,6 +786,19 @@
            "resolved": "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz",
            "integrity": "sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA=="
        },
+        "assign-deep": {
+            "version": "1.0.1",
+            "resolved": "https://registry.npmjs.org/assign-deep/-/assign-deep-1.0.1.tgz",
+            "integrity": "sha512-CSXAX79mibneEYfqLT5FEmkqR5WXF+xDRjgQQuVf6wSCXCYU8/vHttPidNar7wJ5BFmKAo8Wei0rCtzb+M/yeA==",
+            "requires": {
+                "assign-symbols": "^2.0.2"
+            }
+        },
+        "assign-symbols": {
+            "version": "2.0.2",
+            "resolved": "https://registry.npmjs.org/assign-symbols/-/assign-symbols-2.0.2.tgz",
+            "integrity": "sha512-9sBQUQZMKFKcO/C3Bo6Rx4CQany0R0UeVcefNGRRdW2vbmaMOhV1sbmlXcQLcD56juLXbSGTBm0GGuvmrAF8pA=="
+        },
        "base64-js": {
            "version": "1.5.1",
            "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
--- a/package.json
+++ b/package.json
@ -10,6 +10,7 @@
    },
    "description": "A Webpack Plugin for generating a Website as Html-Files from a Markdown File Structure",
    "dependencies": {
+        "assign-deep": "^1.0.1",
        "crypto": "^1.0.1",
        "dayjs": "^1.11.6",
        "fast-xml-parser": "^4.0.11",
--- a/src/config.js
+++ b/src/config.js
@ -1,8 +1,13 @@
 /**
+ *  ConfigStore
 *
 *
+ *
+ *  @author Björn Hase <me@herr-hase.wtf>
+ *  @license http://opensource.org/licenses/MIT The MIT License
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
+ *
 */
-
 class ConfigStore {

    constructor() {
@ -15,6 +20,10 @@ class ConfigStore {
    }

    /**
+     *  set value by key
+     *
+     *  @param {String} key
+     *  @param {String|Object} value
     *
     */
    set(key, value) {
@ -22,10 +31,17 @@ class ConfigStore {
    }

    /**
+     *  get value by key
     *
-     *
+     *  @param  {String} key
+     *  @return {String|Object}
     */
    get(key) {
+
+        if (!this._data?.[key]) {
+            throw new Error(key + ' not found in ConfigStore!')
+        }
+
        return this._data[key]
    }
 }
@ -33,4 +49,4 @@ class ConfigStore {
 // create instance
 const instance = new ConfigStore();

-module.exports =instance
+module.exports = instance
--- a/src/engines/helpers.js
+++ b/src/engines/helpers.js
@ -12,8 +12,8 @@ const Media = require('./media.js')
 *
 */

-function asset(staticPath)
-{
+function asset(staticPath) {
+    
    // getting basePath
    let result = staticPath

--- a/src/engines/nunjucks.js
+++ b/src/engines/nunjucks.js
@ -2,16 +2,17 @@ const nunjucks = require('nunjucks')
 const { minify } = require('html-minifier')
 const fs = require('fs')

+const configStore = require('./../config.js')
 const { asset, resize } = require('./helpers.js')
-const PageQuery = require('./queries/pages.js')
-const configStore = require('./config.js')
+const PageQuery = require('./../queries/pages.js')

 /**
- * engine - handle eta.js
+ *  nunjucks
+ *
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */
 class Engine {
--- a/src/factories/media.js
+++ b/src/factories/media.js
--- a/src/factories/sitemap.js
+++ b/src/factories/sitemap.js
@ -6,7 +6,7 @@ const dayjs = require('dayjs')
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */
 class Sitemap {
--- a/src/models/block.js
+++ b/src/models/block.js
@ -4,12 +4,12 @@ const parseMarkdownFile = require('./../parsers/markdown.js')
 /**
 *  Block
 *
- *  parsed markdown-file that can contains fields
- *  as yaml
+ *  parsed markdown-file that can
+ *  contains fields as yaml
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */

@ -26,9 +26,10 @@ class Block {
        // parse string of file
        const parsedFile = parseMarkdownFile(fileString)

-        this._content = parsedFile.content
-        this._fields = parsedFile.fields
+        // getting parsed data
+        this.content = parsedFile.content
+        this.fields = parsedFile.fields
    }
 }

-module.exports =Block
+module.exports = Block
--- a/src/models/page.js
+++ b/src/models/page.js
@ -2,6 +2,7 @@ const path = require('path')
 const slugify = require('slugify')
 const merge = require('lodash.merge')
 const nunjucks = require('nunjucks')
+const assign = require('assign-deep')

 const parseMarkdownFile = require('./../parsers/markdown.js')

@ -11,7 +12,7 @@ const parseMarkdownFile = require('./../parsers/markdown.js')
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */

@ -36,15 +37,15 @@ class Page {
        this.pathname = this._resolvePathname(parent)

        // fields merge by default values
-        this._fields = merge({
+        this.fields = merge({
            view: 'page',
            meta: {
                robots: 'index'
            }
        }, result.fields)

-        this._content = result.content
-        this._blocks = blocks
+        this.content = result.content
+        this.blocks = blocks
    }

    /**
@ -56,13 +57,13 @@ class Page {
     */
    render(engine, done) {

-        const page = Object.assign({}, this._fields)
+        const page = assign({}, this.fields)

-        page.content = this._content
-        page.blocks = this._blocks
+        page.content = this.content
+        page.blocks = this.blocks
        page.path = this.pathname + '/' + this.filename

-        return engine.render(this._fields.view, {
+        return engine.render(this.fields.view, {
            page: page
        }, done)
    }
--- a/src/parsers/markdown.js
+++ b/src/parsers/markdown.js
@ -6,7 +6,7 @@ const { marked } = require('marked')
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */

@ -39,4 +39,4 @@ function parseMarkdownFile(fileString) {
    return result
 }

-module.exports =parseMarkdownFile
+module.exports = parseMarkdownFile
--- a/src/parsers/yaml.js
+++ b/src/parsers/yaml.js
@ -5,7 +5,7 @@ const yaml = require('js-yaml')
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */

--- a/src/queries/blocks.js
+++ b/src/queries/blocks.js
@ -6,9 +6,10 @@ const Block = require('./../models/block.js')
 /**
 *  search, filter and find pages
 *
+ *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */

@ -22,6 +23,7 @@ class Blocks {
     */
    constructor(dirPath) {

+        this.FILE_EXTENSION   = '.md'
        this.DIRECTORY_BLOCKS = '_blocks'

        this._dirPath = dirPath + '/' + this.DIRECTORY_BLOCKS;
@ -45,7 +47,7 @@ class Blocks {
    /**
     *  find files
     *
-     *  @param  {[type]} dirPath
+     *  @param  {string} dirPath
     *  @param  {Object} [parent = '']
     *
     */
@ -59,7 +61,7 @@ class Blocks {
        files.forEach((file) => {

            // skip for file that is not markdown
-            if (file.isFile() && path.extname(file.name) !== '.md') {
+            if (file.isFile() && path.extname(file.name) !== this.FILE_EXTENSION) {
                return;
            }

--- a/src/queries/pages.js
+++ b/src/queries/pages.js
@ -11,7 +11,7 @@ const Blocks = require('./../queries/blocks.js')
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */

--- a/src/siteomat.js
+++ b/src/siteomat.js
@ -2,22 +2,22 @@ const fs = require('fs')
 const path = require('path')
 const mkdirp = require('mkdirp')

-const Engine = require('./engine.js')
-const Sitemap = require('./sitemap.js')
+const configStore = require('./config.js')
+
+const Engine = require('./engines/nunjucks.js')
+const Sitemap = require('./factories/sitemap.js')

 const PagesQuery = require('./queries/pages.js')
 const parseYamlFile = require('./parsers/yaml.js')

-const configStore = require('./config.js')
-
 /**
- *  Main
+ *  Siteomat
 *
 *
 *
 *  @author Björn Hase <me@herr-hase.wtf>
 *  @license http://opensource.org/licenses/MIT The MIT License
- *  @link https://gitea.node001.net/HerrHase/happy-site-webpack-plugin.git
+ *  @link https://gitea.node001.net/HerrHase/siteomat-webpack-plugin.git
 *
 */
 class Siteomat {