{"repo":"the-working-party/liquid-docs","free":true,"listed":false,"github":"https://github.com/the-working-party/liquid-docs","clone":"git clone https://github.com/the-working-party/liquid-docs.git","description":"A parser for Shopify liquid doc tags.","language":"Rust","stars":25,"topics":["liquid","rust-lang","shopify","wasm"],"license":"MIT","category":"ecommerce","readme_excerpt":"A parser for Shopify liquid doc tags that allows you to extract the {% doc %} content of a liquid file into an object and check liquid files to make sure they all have a doc block. Written in Rust and compiled to WASM to make it run in node and the browser. Content - Goals - Parser - Checker - Contribution - License Goals This project wants to stay as close to, how Shopify interprets the doc tag, as possible. Right now this library supports only what has been noted in the Shopify liquid docs: - @description , @param and @example - Description without @description at the top - Param types: string , string[] , number , number[] , boolean , boolean[] , object and object[] - Param types also supports Shopify objects via the Shopify type. e.g. { Shopify: \"currency\" } - Param optionality - Param type and description are optional - Multiple examples Parser This library can be used as a library in your or JS/TS (or Rust) project. To install: Checker The checker is a built-in CLI tool that allows you to check every file within a given glob for the existence of doc tags. The checker will return a non-zero error code if it finds a file that does not contain a doc tag. Usage: (exit code = 0 ) Or when it fails: (exit code = 1 ) Checker Options Warn Flag: -w --warn Throw a warning instead of an error on files without doc tags. (exit code = 0 ) Error on Parsing Flag: -e --eparse Error on parsing issues (default: warning). Parsing issues: unsupported type, missing parameter name etc (exit co","default_branch":null,"files":null,"tree":[],"storefront":"/r/the-working-party","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/the-working-party/liquid-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}