.config/coc/extensions/node_modules/coc-prettier/node_modules/acorn-jsx/README.md

   1 # Acorn-JSX
   2
   3 [![Build Status](https://travis-ci.org/acornjs/acorn-jsx.svg?branch=master)](https://travis-ci.org/acornjs/acorn-jsx)
   4 [![NPM version](https://img.shields.io/npm/v/acorn-jsx.svg)](https://www.npmjs.org/package/acorn-jsx)
   5
   6 This is plugin for [Acorn](http://marijnhaverbeke.nl/acorn/) - a tiny, fast JavaScript parser, written completely in JavaScript.
   7
   8 It was created as an experimental alternative, faster [React.js JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) parser. Later, it replaced the [official parser](https://github.com/facebookarchive/esprima) and these days is used by many prominent development tools.
   9
  10 ## Transpiler
  11
  12 Please note that this tool only parses source code to JSX AST, which is useful for various language tools and services. If you want to transpile your code to regular ES5-compliant JavaScript with source map, check out [Babel](https://babeljs.io/) and [Buble](https://buble.surge.sh/) transpilers which use `acorn-jsx` under the hood.
  13
  14 ## Usage
  15
  16 Requiring this module provides you with an Acorn plugin that you can use like this:
  17
  18 ```javascript
  19 var acorn = require("acorn");
  20 var jsx = require("acorn-jsx");
  21 acorn.Parser.extend(jsx()).parse("my(<jsx/>, 'code');");
  22 ```
  23
  24 Note that official spec doesn't support mix of XML namespaces and object-style access in tag names (#27) like in `<namespace:Object.Property />`, so it was deprecated in `acorn-jsx@3.0`. If you still want to opt-in to support of such constructions, you can pass the following option:
  25
  26 ```javascript
  27 acorn.Parser.extend(jsx({ allowNamespacedObjects: true }))
  28 ```
  29
  30 Also, since most apps use pure React transformer, a new option was introduced that allows to prohibit namespaces completely:
  31
  32 ```javascript
  33 acorn.Parser.extend(jsx({ allowNamespaces: false }))
  34 ```
  35
  36 Note that by default `allowNamespaces` is enabled for spec compliancy.
  37
  38 ## License
  39
  40 This plugin is issued under the [MIT license](./LICENSE).