What happened?

1. I set my configuration to...
2. Then I ran npx scribe:generate ...
3. But I saw
   ⓘ Writing docs...
   ✖ Writing HTML docs
   ◼ Writing Postman collection
   ◼ Writing OpenAPI spec
   Error: Promise rejected with value: [
   [Error: ENOENT: no such file or directory, lstat 'C:\nodejs\blog_api\node_modules@knuckleswtf\scribe\resources\images'] {
   errno: -4058,
   code: 'ENOENT',
   syscall: 'lstat',
   path: 'C:\nodejs\blog_api\node_modules\@knuckleswtf\scribe\resources\images'
   }
   ]
   at process. (C:\nodejs\blog_api\node_modules\hard-rejection\index.js:15:12)
   at process.emit (events.js:375:28)
   at processEmit [as emit] (C:\nodejs\blog_api\node_modules\signal-exit\index.js:175:34)
   at processPromiseRejections (internal/process/promises.js:245:33)
   at processTicksAndRejections (internal/process/task_queues.js:96:32)
   instead of...
   done

Screenshots or stack traces:

My environment:

• Node.js version (from node -v): 14.17.2
• Framework (Adonis/Express/Restify):Express 4.17.1
• Framework version (from npm list @adonisjs/core or npm list express or npm list restify): npm list express : [email protected]
• Scribe version (from npm list @knuckleswtf/scribe):2.0.0

My Scribe config (minus the comments):

Additional info:

Hello, first of all thank you for this library 🚀
Is the support of Adonis V5 planned ? In progress ? Do you need help with this?
I use the version for Laravel and I would love to use it for my projects with Adonis as well.
Thanks

Hi,

I try to use your package for generate docs of my nodeJS API based on overridden Express

I arrive to generate one config file (00.yaml) with all my endpoints. And i would like define Group / title and description in it.
It's ok for title / description but when i put groupName in metaData and when i launch the generate command.
It's work once;
If i want to relaunch it, while it was explose it in multiple files (00.yaml, 01.yaml…), he rebase it on app router and so it loose title / description and groups..

Sorry for my english, i 'm french
Say me if i'm not clear
Thnaks a lot

• I've read the documentation and I can't find details on how to achieve this.

Hello! I would love for you to go ahead and add a license your software!

https://choosealicense.com/

Most OSS like this one tend to be MIT

Thanks :)

• I've read the documentation and I can't find details on how to achieve this.

• All endpoints have the "lang" param.
  How do i specify the details and example for it generally without adding it to every route doc block?
  Also scribe generates random value for it on every route

Does scribe library supports routes which are imported from different files in expressjs 4.x? I have divided routes into different files and sub files under it for better management like this:

// front routes
require('./app/routes/front')(app);

Code of app/routes/front/index.js

module.exports = function(app) {
  var routeFiles = fs.readdirSync(path.join(__dirname, 'router/'))

  routeFiles.forEach(function(file) {

    if (file === 'index.js' || file.substr(file.lastIndexOf('.') + 1) !== 'js') {
      return;
    }

    var name = file.substr(0, file.indexOf('.'));

    app.use('/', require('./router/' + name));
  });
}

// admin routes
require('./app/routes/admin')(app);

I'm unable to generate api docs. It always gives me undefined handlers on @knuckleswtf\scribe-express\src\get_routes.js [Line no. 55]

Any idea what am I missing over here?

Thank you

I have the following

/**
* Here be my title
*
* And this is a description
*
* @urlParam {string} theParam required This should be the description. Example: its-a-string
* @urlParam {int} anotherParam This is another description
*/
server.get('/:theParam/:anotherParam', (req, res, next) => {
...

It seems that the @urlParam parser is ... exiting early? I can't provide a screenshot for unimportant reasons. But, what I get as output in the html page here is the "URL Parameters" header followed by
theParam string
anotherParam string

It is completely ignoring everything other than the @urlParam and the variable name tokens on those lines. The example text isn't used in the example request. The description is completely missing. required vs not having it there makes no difference. And the type is even ignored (as the int is showing in the doc as string).

Is this library compatible with AdonisJS v5?

What happened?
After generating the documentation I noticed that request body examples are missing

Screenshots or stack traces:

My environment:

• Node.js version (from node -v): v14.16.1
• Framework (Adonis/Express/Restify): Express
• Framework version (from npm list @adonisjs/core or npm list express or npm list restify): [email protected]
• Scribe version (from npm list @knuckleswtf/scribe): @knuckleswtf/[email protected]

My Scribe config (minus the comments):

Additional info:
The openapi.yaml that is generated has examples in it but the postman collections generate doesn't