comments/formatter docs

[oscartbeaumont]

Convert these into documentation:

use std::{io, path::Path, process::Command};

use crate::typescript::FormatterFn;

/// Format the specified file using [ESLint](https://eslint.org).
pub fn eslint(file: &Path) -> io::Result<()> {
    Command::new("eslint")
        .arg("--fix")
        .arg(file)
        .output()
        .map(|_| ())
        .map_err(|e| io::Error::new(io::ErrorKind::Other, e))
}

// Assert that the function signature matches the expected type.
const _: FormatterFn = eslint;

/// Format the specified file using [Prettier](https://prettier.io).
pub fn prettier(file: &Path) -> io::Result<()> {
    Command::new("prettier")
        .arg("--write")
        .arg(file)
        .output()
        .map(|_| ())
        .map_err(|e| io::Error::new(io::ErrorKind::Other, e))
}

// Assert that the function signature matches the expected type.
const _: FormatterFn = prettier;

/// Format the specified file using [Biome](https://prettier.io).
pub fn biome(file: &Path) -> io::Result<()> {
    Command::new("biome")
        .arg("format")
        .arg(file)
        .output()
        .map(|_| ())
        .map_err(|e| io::Error::new(io::ErrorKind::Other, e))
}

// Assert that the function signature matches the expected type.
const _: FormatterFn = biome;

use crate::typescript::{CommentFormatterArgs, CommentFormatterFn};

use super::js_doc;

// Assert that the function signature matches the expected type.
const _: CommentFormatterFn = js_doc;

/// Converts Typescript comments into JSDoc comments.
pub fn js_doc(arg: CommentFormatterArgs) -> String {
    js_doc_builder(arg).build()
}

pub(crate) fn js_doc_builder(arg: CommentFormatterArgs) -> js_doc::Builder {
    let mut builder = js_doc::Builder::default();

    if !arg.docs.is_empty() {
        builder.extend(arg.docs.split('\n'));
    }

    if let Some(deprecated) = arg.deprecated {
        builder.push_deprecated(deprecated);
    }

    builder
}

[oscartbeaumont]

Also should we remove specta_typescript::js_doc and move it to specta_jsdoc