Error: package must be an instance of Package

Question

Error: package must be an instance of Package

Opened this issue 7 years ago · 7 comments

when running 'dgeni ./dgeni-run.js' to generate docs, I have this error: '

node_modules/dgeni/lib/Dgeni.js:45
            throw new Error('package must be an instance of Package');
            ^

Error: package must be an instance of Package
    at Dgeni.package (/home/chaaben/git/projects/UNIWAPP/repos/app-pds/node_modules/dgeni/lib/Dgeni.js:45:19)
    at /home/chaaben/git/projects/UNIWAPP/repos/app-pds/node_modules/dgeni/lib/Dgeni.js:26:57
    at Array.map (<anonymous>)
    at new Dgeni (/home/chaaben/git/projects/UNIWAPP/repos/app-pds/node_modules/dgeni/lib/Dgeni.js:26:18)
    at Object.<anonymous> (/home/chaaben/git/projects/UNIWAPP/repos/app-pds/node_modules/dgeni/lib/gen-docs.js:26:13)
    at Module._compile (module.js:624:30)
    at Object.Module._extensions..js (module.js:635:10)
    at Module.load (module.js:545:32)
    at tryModuleLoad (module.js:508:12)
    at Function.Module._load (module.js:500:3)

I 'm testing with a basic configuration, this is my dgeni-run.js file:

var Dgeni = require('dgeni');

var Package = require('dgeni').Package;

var myPackage = new Package('myDoc', [
  // require('dgeni-packages/ngdoc'),
  // require('dgeni-packages/nunjucks'),
]);
console.log(myPackage)
var dgeni = new Dgeni([myPackage]);

dgeni.generate();

Answer 1 · 2017-10-18T11:51:29.000Z

It might be because you have "required" dgeni twice. Instead try:

var Dgeni = require('dgeni');
var Package = Dgeni.Package;

Answer 2 · 2017-10-18T12:45:46.000Z

I have the same error after this modification

Answer 3 · 2017-10-18T14:48:11.000Z

Can you tell me what version of dgeni and dgeni-packages you are using?

…

On Wed, 18 Oct 2017 at 13:45 chaabenMohamed ***@***.***> wrote: I have the same error after this modification — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#168 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAA9J25ei-A8O2fR0KLaU59xjKQm22U2ks5stfL6gaJpZM4P9k2h> .

Answer 4 · 2017-10-18T16:24:36.000Z

dgeni: 0.4.9
dgeni-packages: 0.22.0

Answer 5 · 2017-10-19T13:10:12.000Z

I'll try to reproduce on my side...

Answer 6 · 2017-10-20T08:13:10.000Z

OK, so I realise what the problem is:

If you want to use dgeni via the command line then the file that you pass it must export a package. What you have is a file that is actually running dgeni by itself and not exporting anything.

You have two choices:

a) Change your file to simply export your package:

my-doc.js

var Package = require('dgeni').Package;

module.exports = new Package('myDoc', [
  // require('dgeni-packages/ngdoc'),
  // require('dgeni-packages/nunjucks'),
]);

in which case you can then run this via the command line dgeni ./my-doc.js

b) Do not use the command line at all and simply run the file you have directly:

node dgeni-run.js

Answer 7 · 2017-10-20T13:39:00.000Z

thank you, my problem is resolved with your solution.