CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-jsdoc-to-markdown

Generates markdown API documentation from JSDoc-annotated source code with comprehensive customization options

Overall
score

97%

Overview
Eval results
Files

rubric.jsonevals/scenario-6/

{
  "context": "This criteria evaluates how well the engineer uses jsdoc-to-markdown's data pipeline access methods (getJsdocData, getTemplateData, and getNamepaths) to extract and format JSDoc information from JavaScript source files.",
  "type": "weighted_checklist",
  "checklist": [
    {
      "name": "Uses getJsdocData",
      "description": "Correctly uses the getJsdocData() method to extract raw JSDoc data when the --json flag is provided. The method should be called with appropriate options including the file path.",
      "max_score": 30
    },
    {
      "name": "Uses getTemplateData",
      "description": "Correctly uses the getTemplateData() method to extract structured template data when the --template flag is provided. The method should be called with appropriate options including the file path.",
      "max_score": 30
    },
    {
      "name": "Uses getNamepaths",
      "description": "Correctly uses the getNamepaths() method to extract categorized namepath information when the --namepaths flag is provided. The method should be called with appropriate options including the file path.",
      "max_score": 30
    },
    {
      "name": "Proper options format",
      "description": "Passes options to the jsdoc-to-markdown methods in the correct format, specifically using the 'files' option (or 'source' option) to specify the input JavaScript file path.",
      "max_score": 10
    }
  ]
}

Install with Tessl CLI

npx tessl i tessl/npm-jsdoc-to-markdown

tile.json