sync-lint-docs

Remove ESLint and Prettier enforced code style rules from Markdown documentation.

Updated Dec 28, 2023
One-click install
npx skills add https://github.com/daisuke-tanabe/daisuke-tanabe --skill sync-lint-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-lint-docs
Source: https://github.com/daisuke-tanabe/daisuke-tanabe/tree/main/.claude/skills/sync-lint-docs
Command: npx skills add https://github.com/daisuke-tanabe/daisuke-tanabe --skill sync-lint-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures your documentation accurately reflects the automated code style rules enforced by ESLint and Prettier, eliminating redundant information and maintaining consistency.

Core Features & Use Cases

  • Automated Rule Removal: Identifies and removes documentation entries that are already covered by ESLint or Prettier.
  • Deduplication: Resolves inconsistencies between coding guidelines and automated linting rules.
  • Use Case: After updating your ESLint configuration, use this Skill to automatically clean up your docs/coding-guidelines to remove any rules that are now enforced by the linter, preventing outdated information.

Quick Start

Run the sync-lint-docs skill to update documentation based on ESLint and Prettier configuration changes.

Frequently Asked Questions about sync-lint-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I remove redundant ESLint and Prettier rules from markdown documentation?

To synchronize lint rules with documentation, this Skill reads ESLint configuration files and Markdown documentation to identify and delete duplicate code style rule descriptions automatically enforced by linters.

Why does my coding guidelines documentation conflict with automated linter configurations?

Documentation conflicts with linter configurations when coding guidelines retain manual style rules after ESLint or Prettier updates, creating redundant information that this Skill resolves by removing duplicated entries.

Can I automatically clean up documentation after updating ESLint configuration files?

Yes, you can automatically clean up documentation after updating ESLint configuration files by running this Skill to scan Markdown files and delete style rules already enforced by your linter setup.

What's the best way to keep coding guidelines consistent with Prettier formatting rules?

The best way to keep coding guidelines consistent with Prettier formatting rules is synchronizing lint rules with documentation by scanning configuration files and removing outdated manual style entries from Markdown.

Does this documentation synchronization require any external dependencies or plugins?

No, this documentation synchronization requires no external dependencies or plugins, operating independently to read ESLint configuration files and Markdown documentation to identify and remove duplicate rule descriptions.