evals
scenario-1
scenario-10
scenario-2
scenario-3
scenario-4
scenario-5
scenario-6
scenario-7
scenario-8
scenario-9
{
"context": "This criteria evaluates how effectively the engineer uses the jsdoc-to-markdown package's programmatic API to build a documentation generation tool. The focus is on proper use of the package's core methods, handling of file inputs, and integration with Node.js async/await patterns.",
"type": "weighted_checklist",
"checklist": [
{
"name": "Import package correctly",
"description": "Uses require() or import to load the jsdoc-to-markdown package (typically as 'jsdoc2md' or 'jsdocToMarkdown')",
"max_score": 10
},
{
"name": "Use render method",
"description": "Calls the jsdoc2md.render() method with appropriate options to generate markdown documentation",
"max_score": 30
},
{
"name": "Pass file paths",
"description": "Provides source file paths to render() via the 'files' option (e.g., { files: sourceFiles })",
"max_score": 20
},
{
"name": "Handle async operations",
"description": "Properly uses async/await or Promise handling (.then/.catch) when calling render() since it returns a Promise",
"max_score": 20
},
{
"name": "Process render output",
"description": "Captures the markdown string returned by render() and writes it to the output file",
"max_score": 15
},
{
"name": "Error handling",
"description": "Implements try/catch or .catch() to handle errors from the render() method and display meaningful error messages",
"max_score": 5
}
]
}