@magento/directive-parser

    0.1.8 • Public • Published

    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"
     */

    Keywords

    Install

    npm i @magento/directive-parser

    DownloadsWeekly Downloads

    3,182

    Version

    0.1.8

    License

    (OSL-3.0 OR AFL-3.0)

    Unpacked Size

    26.7 kB

    Total Files

    8

    Last publish

    Collaborators

    • prabhuramgr
    • abrhim
    • jzetlen
    • magento-owner
    • jimbo
    • sirugh
    • depatil
    • deloreyj
    • davemacaulay1
    • twiebell-adobe