1.0 Roadmap

[malobre]

This describes what I aim to achieve with the crate, not its current state.

Design Goals

Provide an idiomatic API to interact with Vue SFC, this library should let users parse, create, modify and print SFC.

Non-goals

• Pretty-printing block content.

Vue SFC Specifications

From vuejs.org:

• A Single File Component or SFC is a file syntactically-compatible with HTML.
• It may contain:
  • A single template block.
  • A single script block.
  • A single script setup block.
  • style blocks.
  • Custom blocks.
  • HTML comments.

From the compiler-sfc repo:

• template blocks with no lang attribute or a lang attribute set to html are to be parsed in Data State.
• Other blocks are to be parsed in RAWTEXT State.

[malobre]

Potential interface:

use std::collections::HashMap;

type Attributes = HashMap<String, Option<String>>;
type Content = String;

trait Block {
    const NAME: &'static str; // or `Cow<'static, str>` for more flexibility

    fn attributes(&self) -> &Attributes;
    fn attributes_mut(&mut self) -> &mut Attributes;

    fn content(&self) -> &Content;
    fn content_mut(&mut self) -> &mut Content;
}

trait CustomBlock: Block {/* snip */}

struct Template {/* snip */};
impl Block for Template { /* snip */ }

struct Script {/* snip */};
impl Block for Script { /* snip */ }

struct Style {/* snip */};
impl Block for Style { /* snip */ }

struct Sfc {/* snip */}

impl Sfc {
    pub fn new() -> Self;

    pub fn template(&self) -> Option<&Template>;
    pub fn template_mut(&mut self) -> Option<&mut Template>;

    pub fn script(&self) -> Option<&Script>;
    pub fn script_mut(&mut self) -> Option<&mut Script>;

    pub fn script_setup(&self) -> Option<&Script>;
    pub fn script_setup_mut(&self) -> Option<&mut Script>;

    pub fn styles(&self) -> &[&Style];
    pub fn styles_mut(&self) -> &[&mut Style];

    pub fn get<B: CustomBlock>(&self) -> &[&B];
    pub fn get_mut<B: CustomBlock>(&self) -> &[&mut B];
}

However this raises multiple questions:

• How to handle top-level comments ?
• How to handle script setup / script ?

[malobre]

Because of top-level comments, order matters (comment could refer to something above, below or something else entirely), as such it makes sense to have sorted iterators:

impl Sfc {
    pub fn iter(&self) -> impl Iterator<Item = &BlockOrComment>;
    pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut BlockOrComment>;
    pub fn into_iter(self) -> impl Iterator<Item = BlockOrComment>;
}