Error: Invalid layout specified.

[truetamtam]

• win10
• git-bash
• yarn

Installed it. Launched example from your docs.
Result - "Error: Invalid layout specified.".

[neogeek]

Hmm, that is weird. I'll look into this. Managed to get tests to run and pass on Windows via Appveyor, but I'm guessing I've missed something.

[poupryc]

Same issue here on Bash subsystem for Windows

[neogeek]

Sorry this is been a long-standing issue. Getting access to a PC tomorrow to diagnose the problem.

[SalathielGenese]

I think I got some hint - #61 (comment)

[jasonk]

FWIW a couple of years later.. I got this same error on a Mac, and the problem (at least in my case) was that the findPackagePath function in loaders.js uses it's own home-grown search algorithm to find where a node module is installed, and that algorithm only looks at two possible directories (the node_modules directory that doxdox was installed into, and the node_modules directory in your current working directory, if there was one) which leaves a lot of possibilities for where the packages may have been installed that they won't be found. I was trying to use it in a monorepo and it wasn't finding plugins.

I'm not entirely sure why these loadPlugin and loadParser functions are going to so much trouble to return a promise when that promise is ultimately resolved by a call to require (which is synchronous anyway), but my recommendation would be to reduce those functions down to something like this (which assumes that the handlebars plugin will provide an appropriate error if the file isn't found or isn't a file):

const loadPlugin = config => new Promise((resolve, reject) => {
  if ( config.layout.match(HANDLEBARS_PATTERN) ) {
    try {
      const pkg = require( 'doxdox-plugin-handlebars' );
      if ( pkg ) return resolve( pkg );
    } catch ( err ) {
      return reject( new Error('Invalid layout specified.') );
    }
  }
  if ( config.layout.match(JAVASCRIPT_PATTERN) ) {
    const pkg = require( path.resolve( config.layout ) );
    if ( pkg ) return resolve( pkg );
  }
  try {
    const pkg = require( `doxdox-plugin-${config.layout}` );
    if ( pkg ) return resolve( pkg );
    return reject( new Error('Invalid layout specified.') );
  } catch ( err ) {
    return reject( new Error('Invalid layout specified.') );
  }
} );

[neogeek]

Window support has been improved in version v4.0.0-preview.2 and this should no longer be an issue. Feel free to re-open if the issue persists.