@magento/directive-parser

Parses Magento PWA Studio directives

Stats

StarsIssuesVersionUpdatedCreatedSize
@magento/directive-parser
320.1.82 years ago4 years agoMinified + gzip package size for @magento/directive-parser in KB

Readme

PWA Studio Directive Parser

CircleCI

A Directive in Magento PWA Studio is an inline comment within a source file that signals additional metadata that should be processed by the PWA Studio tooling.

If you're a user of Magento PWA Studio, it's unlikely you're looking to depend on this package directly. The primary use-case for this library is to be consumed by other PWA Studio tools.

Goals

The primary goals of this project are:

  • Parse all JavaScript comments within a source file, and return descriptors for every comment that conforms to the Magento Directive syntax
  • Run significantly faster than a parser that parses the entire ECMAScript grammar
  • Provide actionable warnings/errors with location info

Install

npm install @magento/directive-parser

Usage

const parseDirectives = require('@magento/directive-parser');
const { directives, errors } = parseDirectives(someSourceFileString);

Example Directive (Kitchen Sink)

/**
 * @RootComponent
 * pageTypes = some_page, some_other_page
 * description = "Some description here"
 */

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.