jonschlinkert/gray-matter
Gray Matter
gray-matter este o bibliotecă pentru separarea, parsarea și serializarea datelor de configurare structurate în documente bazate pe text. Funcționează ca un extractor de metadate pentru documente care izolează blocurile structurate din corpul principal al unui fișier și ca o bibliotecă de serializare care convertește obiectele de date înapoi în șiruri formatate.
Proiectul suportă extracția blocurilor de metadate YAML, JSON și TOML de la începutul șirurilor sau fișierelor. Include mecanisme pentru identificarea prezenței metadatelor și determinarea limbajului de formatare specific utilizat pe baza caracterelor care urmează delimitatorului de deschidere.
Sistemul este extensibil printr-un motor de parsare bazat pe plug-in-uri și înregistrarea de parsere personalizate, permițând logicii definite de utilizator să gestioneze limbaje de metadate non-standard. Capabilitățile sale acoperă identificarea limbajului de metadate, extracția metadatelor din fișiere și serializarea simetrică pentru a reconstrui formatele originale ale documentelor.
Features
- Document Metadata Extractors - Separates structured configuration data from the main body of markdown or text files.
- Configurable Content Parsers - Provides a flexible parser that supports custom delimiters and external engines for non-standard metadata.
- Front Matter Parsers - Extracts and parses YAML, JSON, and TOML metadata blocks from the beginning of text files.
- File-Based Metadata Extraction - Loads files from the filesystem and parses front-matter metadata into structured objects.
- Metadata String Serialization - Converts data objects into formatted metadata blocks and prepends them to content strings using delimiters.
- Front-Matter Indexing - Extracts metadata formatted as YAML, JSON, or TOML from the start of a string and separates it from the content.
- Serialization Libraries - Converts structured data objects back into formatted front matter strings for document reconstruction.
- Pluggable Parsing Engines - Implements a plug-in architecture to support various metadata formats like YAML, JSON, and TOML.
- Delimiter-Based Splitters - Splits documents into metadata and body sections using specified start and end delimiters.
- Format Parser Registries - Allows users to register custom parsing and stringifying logic for non-standard metadata formats.
- Metadata Format Detection - Analyzes the text immediately following the opening delimiter to identify the metadata language.
- Metadata Parsing Logic - Allows the definition of custom logic to parse and stringify specific metadata languages.
- Metadata Language Identification - Analyzes strings to determine which metadata language follows the initial delimiter.
- Metadata Presence Detection - Analyzes strings to determine if they contain a valid metadata block based on specified delimiters.
- Symmetric Read-Write Pipelines - Ensures consistency between parsing and serialization by using the same engine for both directions.
