eslint-docgen

Automatically generate ESLint plugin documentation from rule metadata and test cases.

MIT License

Downloads

270

Stars

10

Committers

View Code on GitHub Twitter

Ecosystems: MediaWiki

Bot releases are hidden (Show)

eslint-docgen - v0.7.1 Latest Release

Published by edg2s about 2 years ago

Fix: lintFix: Check for custom parser in mergedConfig (#132)
Code: Security updates from npm audit fix

eslint-docgen - v0.7.0

Published by jdforrester over 2 years ago

Breaking change: Upgrade to ESLint 8

eslint-docgen - v0.6.2

Published by edg2s over 2 years ago

Fix: Use throw instead of process.exit (#127) (Justin Poehnelt)
Code: Update eslint-config-wikimedia to 0.21.0

eslint-docgen - V0.6.1

Published by jdforrester almost 3 years ago

Fix: Filter out docgen:false tests before parsing (#120)

eslint-docgen -

Published by jdforrester almost 3 years ago

Breaking change: Drop deprecated 'noDoc' option and '--doc' CLI flag (#115)
New: build-docs-from-tests: add Vue syntax highlighting (#105) (DannyS712)
New: Add TypeScript syntax highlighting
New: Add HTML syntax highlighting
New: Separate syntax highlighting support from showFilenames (#114)
Fix: Don't put an empty line before the first multi-line examples in a set (#117)
Code: Cleanup code for detecting highlight language (#113)

eslint-docgen - v0.5.1

Published by edg2s almost 3 years ago

Breaking change: Change the default icon for rules which are included in a preset (#109)
Breaking change: Add generated-file-warning comment to the top of MD files (#107)
Breaking change: Drop support for Node 10 (#110)
New: Add configuration to show file names for test cases (#101) (DannyS712)
New: Add per-rule config overrides (DannyS7123)
Docs: Various README fixes
Code: Update dependencies

eslint-docgen - v0.4.5

Published by edg2s over 3 years ago

Code: Update dependencies

eslint-docgen - v0.4.4

Published by edg2s over 4 years ago

Code: Ensure config.docPath exists before writing output path. (Raine Revere)
Code: Calculate outputDir from outputPath
Code: Fix reporting of writeFile error messages
Code: Output formatted error when rule not found (#92)
Docs: Fix config param heading level in README (#91)

eslint-docgen - v0.4.3

Published by edg2s over 4 years ago

Code: Run one test 'it' per rule

eslint-docgen - v0.4.2

Published by edg2s over 4 years ago

New: Introduce excludeExamplesByDefault config
Code: Remove some whitespace in config-schema
Code: Add a 'report' script

eslint-docgen - v0.4.1

Published by edg2s over 4 years ago

Code: Update mocha to 8.0.1
Code: Replace path with upath for windows compatibility (#83)
Code: Use DOCGEN environment variable instead of --doc flag
Code: Add an editorconfig to make the tabs a reasonable width on GitHub (Jed Fox)
Code: Allow package.main to be empty
Code: Support scoped plugin names
Docs: Add more method documentation
Docs: Fix external links to examples
Docs: Add Migration section to README and move some pieces around

eslint-docgen - v0.4.0

Published by edg2s over 4 years ago

Breaking change: New: Add fix message to introduction (#49)
Breaking change: New: Format long lists correctly ("a, b, and c")
Breaking change: New: Sort examples by options then valid/invalid (#48)
New: Refactor rulesData to rulesWithConfig and expose (#16)
New: Add ruleTemplatePath config (#14)
New: Add showFixExamples config (#49)
Code: Update eslint-config-wikimedia to 0.16.1 and use /mocha
Code: Use pkg-dir
Code: Create a JSON-schema to validate configs (#63)
Code: Update various dependencies
Tests: Separate config tests into get/validate
Tests: Increase timeout
Tests: Separate buildDocsFromTests cases
Docs: Fix example docpath

eslint-docgen - v0.3.1

Published by edg2s over 4 years ago

Fix: Use plugin's version of ESLint

eslint-docgen - v0.3.0

Published by edg2s over 4 years ago

Breaking change: New: Support multi-line test cases (#34)
New: Support multiple lines in formatter
New: Add min/maxExamples to config (#29)
New: Use chalk to do pretty output of warnings/errors (#38)
Code: Bump node dependency to 10 (#44)
Code: Use strict mode
Code: Use eslint-plugin-node/recommended
Code: Removed fixed length truncation from rules-data.js
Tests: Add tests for most utils (#39)
Tests: Increase code coverage to 100%
Docs: Add "plugin" to description

eslint-docgen - v0.2.0

Published by edg2s over 4 years ago

Breaking change: Refactor templates. Users with existing template overrides will need to rewrite them.
Release: Update ejs to 3.1.3

eslint-docgen - v0.1.0

Published by edg2s over 4 years ago

Initial release.

Package Rankings

Top 6.05% on Npmjs.org

Top 6.73% on Proxy.golang.org

Related Projects

jquery.i18n

🌐 jQuery based internationalization library

16 Aug 2012 701

stylelint-config-wikimedia

CSS/Less Stylelint configuration according to CSS coding conventions for Wikimedia.

eslint-plugin-no-jquery

Control allowance of certain jQuery functions, and suggest or autofix alternatives.

Wikiploy

User scripts and gadgets deployment (JS/CSS) for MediaWiki (Wikipedia).

mediawiki-services-mobileapps

Mirror of https://gerrit.wikimedia.org/g/mediawiki/services/mobileapps See https://www.mediawiki....

wikipeg

Mirror of https://gerrit.wikimedia.org/g/wikipeg. See https://www.mediawiki.org/wiki/Developer_ac...

eslint-config-wikimedia

JavaScript style guide for Wikimedia.

m3api

minimal modern MediaWiki API client

eventgate

Library and HTTP Service for validating JSONSchema events and producing them (to Kafka or elsewhere)

Wikitext-Extension-Gadget

A Mediawiki Gadget for Wikitext Extension

wikiapi

JavaScript MediaWiki API for node.js

jsdoc-wmf-theme

Mirror of https://gerrit.wikimedia.org/g/jsdoc/wmf-theme

ExternalContent

MediaWiki extension that allows embedding external content

ToolforgeBundle

A Symfony 4 & 5 bundle that provides some common parts of web-based tools running on Wikimedia's ...

vite-plugin-mediawiki-userscript

A Vite plugin for creating single-file MediaWiki userscript JavaScript files.