Skip to main content

MarkdownConfig

Struct MarkdownConfig 

Source
pub struct MarkdownConfig {
Show 16 fields pub locked: Option<bool>, pub associations: Option<Vec<String>>, pub deno: Option<bool>, pub emphasis_kind: Option<StrongKind>, pub heading_kind: Option<HeadingKind>, pub ignore_directive: Option<String>, pub ignore_end_directive: Option<String>, pub ignore_file_directive: Option<String>, pub ignore_start_directive: Option<String>, pub line_width: Option<u32>, pub new_line_kind: Option<NewLineKind>, pub strong_kind: Option<StrongKind>, pub tags: Option<BTreeMap<String, String>>, pub text_wrap: Option<TextWrap>, pub unordered_list_kind: Option<UnorderedListKind>, pub extra: BTreeMap<String, Value>,
}
Expand description

Configuration for the dprint Markdown plugin.

See: https://dprint.dev/plugins/markdown/config/

Fields§

§locked: Option<bool>

Whether the configuration is not allowed to be overridden or extended.

§associations: Option<Vec<String>>

File patterns to associate with this plugin.

§deno: Option<bool>

Top level configuration that sets the configuration to what is used in Deno.

Default: false

See: https://dprint.dev/plugins/markdown/config/#deno

§emphasis_kind: Option<StrongKind>

The character to use for emphasis/italics.

Default: "underscores"

See: https://dprint.dev/plugins/markdown/config/#emphasisKind

§heading_kind: Option<HeadingKind>

The style of heading to use for level 1 and level 2 headings. Level 3 and higher always use ATX headings.

Default: "atx"

See: https://dprint.dev/plugins/markdown/config/#headingKind

§ignore_directive: Option<String>

The text to use for an ignore directive (ex. <!-- dprint-ignore -->).

Default: "dprint-ignore"

See: https://dprint.dev/plugins/markdown/config/#ignoreDirective

§ignore_end_directive: Option<String>

The text to use for an ignore end directive (ex. <!-- dprint-ignore-end -->).

Default: "dprint-ignore-end"

See: https://dprint.dev/plugins/markdown/config/#ignoreEndDirective

§ignore_file_directive: Option<String>

The text to use for an ignore file directive (ex. <!-- dprint-ignore-file -->).

Default: "dprint-ignore-file"

See: https://dprint.dev/plugins/markdown/config/#ignoreFileDirective

§ignore_start_directive: Option<String>

The text to use for an ignore start directive (ex. <!-- dprint-ignore-start -->).

Default: "dprint-ignore-start"

See: https://dprint.dev/plugins/markdown/config/#ignoreStartDirective

§line_width: Option<u32>

The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

Default: 80

See: https://dprint.dev/plugins/markdown/config/#lineWidth

§new_line_kind: Option<NewLineKind>

The kind of newline to use.

Default: "lf"

See: https://dprint.dev/plugins/markdown/config/#newLineKind

§strong_kind: Option<StrongKind>

The character to use for strong emphasis/bold.

Default: "asterisks"

See: https://dprint.dev/plugins/markdown/config/#strongKind

§tags: Option<BTreeMap<String, String>>

Custom tag to file extension mappings for formatting code blocks. For example: { “markdown”: “md” }

See: https://dprint.dev/plugins/markdown/config/#tags

§text_wrap: Option<TextWrap>

Text wrapping possibilities.

Default: "maintain"

See: https://dprint.dev/plugins/markdown/config/#textWrap

§unordered_list_kind: Option<UnorderedListKind>

The character to use for unordered lists.

Default: "dashes"

See: https://dprint.dev/plugins/markdown/config/#unorderedListKind

§extra: BTreeMap<String, Value>

Additional plugin-specific settings not covered by the typed fields.

Trait Implementations§

Source§

impl Clone for MarkdownConfig

Source§

fn clone(&self) -> MarkdownConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MarkdownConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MarkdownConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for MarkdownConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for MarkdownConfig

Source§

fn eq(&self, other: &MarkdownConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MarkdownConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for MarkdownConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,