Registry / testing / edu-doc-lint

edu-doc-lint

JSON →
library0.1.1jsnpmunverified

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.

npm install edu-doc-lint
INSTALL
IMPORT
SIG · EDU-DOC-LINT
E
edu-doc-lint
testingjavascriptv0.1.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

edu-doc-lint (CLI)
npm install -g edu-doc-lint
The tool is a global CLI, not a module. It is used via command line.

Installs and runs the edu-doc-lint CLI tool to detect and fix incorrect JSDoc file paths in src directory.

# Install globally npm install -g edu-doc-lint # Run in your component root directory cd my-component edu-doc-lint
edu-doc-lint --version
Debug
Known issues
gotchaOnly processes JavaScript files in the 'src' directory by default.
fix
Modify the source code if other directories are needed.
affects: >=0.1.1
gotchaThe tool is intended for a specific project ('pool' component library) and may not work generically.
fix
Understand that the path correction logic assumes a particular module structure.
affects: >=0.1.1
deprecatedThe package appears unmaintained with no updates since initial release.
fix
Consider alternative JSDoc linting tools like eslint-plugin-jsdoc.
affects: >=0.1.1
Errors
Common errors & fixes
Command not found: edu-doc-lint
Global installation failed or not in PATH.
fix
Ensure npm global bin is in PATH: export PATH=$(npm bin -g):$PATH
No files found in src directory
The tool only scans the 'src' directory for .js files.
fix
Ensure your component has a 'src' directory with .js files.
Upgrade
Version history
0.1.1latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
edu-doc-lint — npm install edu-doc-lint · libregistry