-
-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(linter): docs for jsx-a11y/anchor-is-valid
- Loading branch information
Showing
9 changed files
with
311 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| //! Create documentation pages for each rule. Pages are printed as Markdown and | ||
| //! get added to the website. | ||
|
|
||
| use oxc_linter::{table::RuleTableRow, RuleFixMeta}; | ||
| use std::fmt::{self, Write}; | ||
|
|
||
| use crate::linter::rules::html::HtmlWriter; | ||
|
|
||
| pub fn render_rule_docs_page(rule: &RuleTableRow) -> Result<String, fmt::Error> { | ||
| const APPROX_FIX_CATEGORY_AND_PLUGIN_LEN: usize = 512; | ||
| let RuleTableRow { name, documentation, plugin, turned_on_by_default, autofix, .. } = rule; | ||
|
|
||
| let mut page = HtmlWriter::with_capacity( | ||
| documentation.map_or(0, str::len) + name.len() + APPROX_FIX_CATEGORY_AND_PLUGIN_LEN, | ||
| ); | ||
|
|
||
| writeln!( | ||
| page, | ||
| "<!-- This file is auto-generated by {}. Do not edit it manually. -->\n", | ||
| file!() | ||
| )?; | ||
| writeln!(page, "# {plugin}/{name}\n")?; | ||
|
|
||
| // rule metadata | ||
| page.div(r#"class="rule-meta""#, |p| { | ||
| if *turned_on_by_default { | ||
| p.span(r#"class="default-on""#, |p| { | ||
| p.writeln("✅ This rule is turned on by default.") | ||
| })?; | ||
| } | ||
|
|
||
| if let Some(emoji) = fix_emoji(*autofix) { | ||
| p.span(r#"class="fix""#, |p| { | ||
| p.writeln(format!("{} {}", emoji, autofix.description())) | ||
| })?; | ||
| } | ||
|
|
||
| Ok(()) | ||
| })?; | ||
|
|
||
| // rule documentation | ||
| if let Some(docs) = documentation { | ||
| writeln!(page, "\n{}", *docs)?; | ||
| } | ||
|
|
||
| // TODO: link to rule source | ||
|
|
||
| Ok(page.into()) | ||
| } | ||
|
|
||
| fn fix_emoji(fix: RuleFixMeta) -> Option<&'static str> { | ||
| match fix { | ||
| RuleFixMeta::None => None, | ||
| RuleFixMeta::FixPending => Some("🚧"), | ||
| RuleFixMeta::Conditional(_) | RuleFixMeta::Fixable(_) => Some("🛠️"), | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| use std::{ | ||
| cell::RefCell, | ||
| fmt::{self, Write}, | ||
| }; | ||
|
|
||
| #[derive(Debug)] | ||
| pub(crate) struct HtmlWriter { | ||
| inner: RefCell<String>, | ||
| } | ||
|
|
||
| impl fmt::Write for HtmlWriter { | ||
| #[inline] | ||
| fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> fmt::Result { | ||
| self.inner.get_mut().write_fmt(args) | ||
| } | ||
|
|
||
| #[inline] | ||
| fn write_char(&mut self, c: char) -> fmt::Result { | ||
| self.inner.get_mut().write_char(c) | ||
| } | ||
|
|
||
| #[inline] | ||
| fn write_str(&mut self, s: &str) -> fmt::Result { | ||
| self.inner.get_mut().write_str(s) | ||
| } | ||
| } | ||
|
|
||
| impl From<HtmlWriter> for String { | ||
| #[inline] | ||
| fn from(html: HtmlWriter) -> Self { | ||
| html.into_inner() | ||
| } | ||
| } | ||
|
|
||
| impl HtmlWriter { | ||
| pub fn new() -> Self { | ||
| Self { inner: RefCell::new(String::new()) } | ||
| } | ||
|
|
||
| pub fn with_capacity(capacity: usize) -> Self { | ||
| Self { inner: RefCell::new(String::with_capacity(capacity)) } | ||
| } | ||
|
|
||
| pub fn writeln<S: AsRef<str>>(&self, line: S) -> fmt::Result { | ||
| writeln!(self.inner.borrow_mut(), "{}", line.as_ref()) | ||
| } | ||
|
|
||
| pub fn into_inner(self) -> String { | ||
| self.inner.into_inner() | ||
| } | ||
|
|
||
| pub fn html<F>(&self, tag: &'static str, attrs: &str, inner: F) -> fmt::Result | ||
| where | ||
| F: FnOnce(&Self) -> fmt::Result, | ||
| { | ||
| // Allocate space for the HTML being printed | ||
| let write_amt_guess = { | ||
| // opening tag. 2 extra for '<' and '>' | ||
| 2 + tag.len() + attrs.len() + | ||
| // approximate inner content length | ||
| 256 + | ||
| // closing tag. 3 extra for '</' and '>' | ||
| 3 + tag.len() | ||
| }; | ||
| let mut s = self.inner.borrow_mut(); | ||
| s.reserve(write_amt_guess); | ||
|
|
||
| // Write the opening tag | ||
| write!(s, "<{tag}")?; | ||
| if attrs.is_empty() { | ||
| writeln!(s, ">")?; | ||
| } else { | ||
| writeln!(s, " {attrs}>")?; | ||
| } | ||
|
|
||
| // Callback produces the inner content | ||
| drop(s); | ||
| inner(self)?; | ||
|
|
||
| // Write the closing tag | ||
| writeln!(self.inner.borrow_mut(), "</{tag}>")?; | ||
|
|
||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| macro_rules! make_tag { | ||
| ($name:ident) => { | ||
| impl HtmlWriter { | ||
| #[inline] | ||
| pub fn $name<F>(&self, attrs: &str, inner: F) -> fmt::Result | ||
| where | ||
| F: FnOnce(&Self) -> fmt::Result, | ||
| { | ||
| self.html(stringify!($name), attrs, inner) | ||
| } | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| make_tag!(div); | ||
| make_tag!(span); | ||
|
|
||
| #[cfg(test)] | ||
| mod test { | ||
| use super::*; | ||
|
|
||
| #[test] | ||
| fn test_div() { | ||
| let html = HtmlWriter::new(); | ||
| html.div("", |html| html.writeln("Hello, world!")).unwrap(); | ||
|
|
||
| assert_eq!( | ||
| html.into_inner().as_str(), | ||
| "<div> | ||
| Hello, world! | ||
| </div> | ||
| " | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.