edu-doc-lint

0.1.1 verified Fri May 01 auth: no javascript maintenance

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.

Common errors

error Command not found: edu-doc-lint ↓

cause Global installation failed or not in PATH.

fix

Ensure npm global bin is in PATH: export PATH=$(npm bin -g):$PATH

error No files found in src directory ↓

cause The tool only scans the 'src' directory for .js files.

fix

Ensure your component has a 'src' directory with .js files.

Warnings

gotcha Only processes JavaScript files in the 'src' directory by default. ↓

fix Modify the source code if other directories are needed.

gotcha The 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.

deprecated The package appears unmaintained with no updates since initial release. ↓

fix Consider alternative JSDoc linting tools like eslint-plugin-jsdoc.

Install

npm install edu-doc-lint

yarn add edu-doc-lint

pnpm add edu-doc-lint

Imports

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.

Quickstart

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