Registry / testing / eslint-plugin-apidoc

eslint-plugin-apidoc

library0.0.7jsnpmunverified

An ESLint plugin for linting apidoc.json configuration files based on API style rules. Version 0.0.7 is the latest release. It provides rules to enforce base URL, contact information, and description presence for APIs and resources. Designed to integrate with ESLint, it allows developers to validate apidoc.json files as part of their linting process. The plugin is minimal, with only a few rules, and requires ESLint as a peer dependency. It is not actively maintained, with no recent updates.

testing

npm install eslint-plugin-apidoc

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-APID

eslint-plugin-apidoc

testingjavascriptv0.0.7

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.

apidoc

✓ "plugins": ["apidoc"]

✗ import { apidoc } from 'eslint-plugin-apidoc'

Plugin is used via ESLint config, not imported in code

rules

✓ "rules": { "apidoc/base-url": 2 }

✗ "rules": { "base-url": 2 }

Rule names must be prefixed with 'apidoc/'

require('eslint-plugin-apidoc')

✓ const plugin = require('eslint-plugin-apidoc'); // in ESM context, use createRequire

✗ import plugin from 'eslint-plugin-apidoc'; // CJS module, default import fails

Package is CommonJS; using dynamic import may work but require is safer

Shows ESLint configuration to lint apidoc.json using the plugin's three rules.

// .eslintrc.json { "plugins": ["apidoc"], "rules": { "apidoc/base-url": ["error", { "domain": "example.com" }], "apidoc/contact": "error", "apidoc/description": "warn" } } // Run: eslint apidoc.json

Debug

Known issues

gotchaPackage is not widely maintained; no updates since 2017. May have compatibility issues with modern ESLint versions.

fix

Consider forking or using an alternative if issues arise.

affects: >=0.0.7

gotchaThe plugin only works with apidoc.json files; it does not parse inline JSDoc annotations for apiDoc.

fix

Ensure your apiDoc configuration is in a separate JSON file.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Failed to load plugin 'apidoc': Cannot find module 'eslint-plugin-apidoc'

Plugin not installed or ESLint cannot resolve it.

fix

Run 'npm install eslint-plugin-apidoc --save-dev'

Error: Cannot read property 'base-url' of undefined

Missing 'apidoc/' prefix in rule name.

fix

Use 'apidoc/base-url' instead of 'base-url'

Parsing error: Unexpected token

apidoc.json file is not valid JSON or missing.

fix

Ensure the file is valid JSON and exists.

Upgrade

Version history

0.0.7latest on npm

Audit

Dependencies

eslintrequiredpeer dependency required to use ESLint plugins

Agent activity

8 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/securityscorecard/eslint-plugin-apidoc ↗

packagehttps://www.npmjs.com/package/eslint-plugin-apidoc ↗