The metalsmith-hbs-relative-partial from jsonberry

cannot reproduce example

After many try that failed, I try to reproduce your example, so I copied the directory structure the main template src/index.hbs and the partial src/about/components heading.hbs. I wrote an index.js like this

var Metalsmith = require('metalsmith');
var partials = require('metalsmith-hbs-relative-partial');
var inplace = require('metalsmith-in-place');

Metalsmith(__dirname)
    .source('./src')
    .destination('./build')
    .use(partials({
        dirName: 'components'
    }))
    .use(inplace())
    .build(function (err) {
        // For error handling
        if (err) {
            throw err;
        }
    });

and when I execute this code with node v8.9.3 I get

$ node index.js

/home/marc/metaltest/index.js:15
            throw err;
            ^
Error: The partial about/heading could not be found
    at Object.invokePartial (/home/marc/metaltest/node_modules/jstransformer-handlebars/node_modules/handlebars/dist/cjs/handlebars/runtime.js:281:11)
    at Object.invokePartialWrapper [as invokePartial] (/home/marc/metaltest/node_modules/jstransformer-handlebars/node_modules/handlebars/dist/cjs/handlebars/runtime.js:68:39)
    at Object.eval [as main] (eval at createFunctionContext (/home/marc/metaltest/node_modules/jstransformer-handlebars/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:254:23), <anonymous>:5:31)
    at main (/home/marc/metaltest/node_modules/jstransformer-handlebars/node_modules/handlebars/dist/cjs/handlebars/runtime.js:175:32)
    at Object.ret (/home/marc/metaltest/node_modules/jstransformer-handlebars/node_modules/handlebars/dist/cjs/handlebars/runtime.js:178:12)
    at Object.ret [as fn] (/home/marc/metaltest/node_modules/jstransformer-handlebars/node_modules/handlebars/dist/cjs/handlebars/compiler/compiler.js:526:21)
    at Transformer.render (/home/marc/metaltest/node_modules/metalsmith-in-place/node_modules/jstransformer/index.js:289:25)
    at resolve (/home/marc/metaltest/node_modules/metalsmith-in-place/lib/index.js:60:33)
    at new Promise (<anonymous>)
    at render (/home/marc/metaltest/node_modules/metalsmith-in-place/lib/index.js:29:10)

The versions of package I use is

  "dependencies": {
    "jstransformer-handlebars": "^1.1.0",
    "metalsmith": "^2.3.0",
    "metalsmith-in-place": "^4.1.1",
    "metalsmith-jstransformer": "^0.13.0"
  }

You say that this plugin is aimed to be used with metalsmith-in-place, which has had a major change with version 2.0 the 2017-01-01, when it adopted jstransformer. As your plugin is from march 2017, I have assumed it rely on metalsmith-in-place greater than 2.0, but as there is presently no test data, and so metalsmith-in-place is not in your package.json, there is no way (except go through the code!) to know the targeted version.

What about this error, in which context your example is working?

Create gate for file not existing

There should be a gate for a file not existing

Along the lines of:

if (invalidFile(file)) {
    throw new Error('file is invalid');
}

what might be more appropriate here is allowing the plugin to gracefully exit if no file is found

Create gate for directory name

There should be a gate for the listed directory name not existing

Along the lines of:

if (invalidDirName(dirName)) {
    throw new Error('directory name is invalid');
}

Create gate for source

There should be a gate for the listed source directory not existing

Along the lines of:

if (invalidSource(source)) {
    throw new Error('source is invalid');
}

JSON config is incorrect

The key in the JSON config is "pattern", but it should be "dirName"

jsonberry / metalsmith-hbs-relative-partial Goto Github PK

metalsmith-hbs-relative-partial's People

Contributors

Stargazers

Watchers

metalsmith-hbs-relative-partial's Issues

cannot reproduce example

Create gate for file not existing

Create gate for directory name

Create gate for source

JSON config is incorrect

Add Jest tests

Add Travis CI support

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent