Parsers

Messagevisor uses parsers to read and write authoring definitions. The parser layer lets the project model stay stable even when the source file format changes.

Built-in parser names#

Messagevisor accepts yml and json as built-in parser names, with yml as the default.

module.exports = {
  parser: "json",
};

Useful starter references in this repo:

• project-yml
• project-json
• project-raw

Custom parser objects#

Projects can also provide a custom parser object instead of a parser name, as long as it matches the parser contract expected by the core package.

This is useful when:

• your repo already uses a different file format
• you want to integrate with an internal serialization layer
• you need custom read/write behavior

@TODO: show example with TOML

What parsers affect#

Parsers affect:

• how project files are read
• how created or updated definitions are written
• how CLI workflows interact with authoring files

They do not change the underlying Messagevisor data model.

Related#

• Configuration
• Projects
• Datasource