{"id":25191,"library":"edu-doc-lint","title":"edu-doc-lint","description":"A JSDoc path linting and auto-fixing tool that detects and corrects incorrect file path annotations in JSDoc comments. Version 0.1.1. It is designed for projects using module-based paths and automatically replaces wrong paths with correct ones in JavaScript files under the src directory. The tool is installed globally and run from the component root directory. It processes files recursively and provides detailed output of replaced paths. Not actively maintained.","status":"maintenance","version":"0.1.1","language":"javascript","source_language":"en","source_url":"https://github.com/rookiebob/edu-doc-lint","tags":["javascript"],"install":[{"cmd":"npm install edu-doc-lint","lang":"bash","label":"npm"},{"cmd":"yarn add edu-doc-lint","lang":"bash","label":"yarn"},{"cmd":"pnpm add edu-doc-lint","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"The tool is a global CLI, not a module. It is used via command line.","symbol":"edu-doc-lint (CLI)","correct":"npm install -g edu-doc-lint"}],"quickstart":{"code":"# Install globally\nnpm install -g edu-doc-lint\n\n# Run in your component root directory\ncd my-component\nedu-doc-lint\n","lang":"javascript","description":"Installs and runs the edu-doc-lint CLI tool to detect and fix incorrect JSDoc file paths in src directory."},"warnings":[{"fix":"Modify the source code if other directories are needed.","message":"Only processes JavaScript files in the 'src' directory by default.","severity":"gotcha","affected_versions":">=0.1.1"},{"fix":"Understand that the path correction logic assumes a particular module structure.","message":"The tool is intended for a specific project ('pool' component library) and may not work generically.","severity":"gotcha","affected_versions":">=0.1.1"},{"fix":"Consider alternative JSDoc linting tools like eslint-plugin-jsdoc.","message":"The package appears unmaintained with no updates since initial release.","severity":"deprecated","affected_versions":">=0.1.1"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Ensure npm global bin is in PATH: export PATH=$(npm bin -g):$PATH","cause":"Global installation failed or not in PATH.","error":"Command not found: edu-doc-lint"},{"fix":"Ensure your component has a 'src' directory with .js files.","cause":"The tool only scans the 'src' directory for .js files.","error":"No files found in src directory"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}