ember-estree 0.1.0 → 0.1.2

package/README.md

@@ -1 +1,71 @@
 # ember-estree
+
+ESTree-compatible AST parser for Ember's `.gjs` and `.gts` files.
+
+Parses `<template>` tags into [Glimmer](https://github.com/emberjs/ember.js/) AST nodes that are embedded directly in the ESTree, so tools like linters and codemods can work with both the JavaScript/TypeScript _and_ template portions of a single file.
+
+## Install
+
+```bash
+pnpm add ember-estree
+```
+
+## Usage
+
+### Parsing
+
+`toTree` returns a `File` node whose `.program` is a standard ESTree `Program`, with any `<template>` regions represented as `Glimmer*` AST nodes.
+
+```js
+import { toTree } from "ember-estree";
+
+let ast = toTree(`
+  import Component from "@glimmer/component";
+
+  export default class Demo extends Component {
+    <template>Hello, {{this.name}}!</template>
+  }
+`);
+
+console.log(ast.type); // "File"
+console.log(ast.program.body.length); // 2 — ImportDeclaration + ClassDeclaration
+```
+
+`parse` is a lower-level alternative that returns the `Program` node directly.
+
+```js
+import { parse } from "ember-estree";
+
+let program = parse(`const x = <template>hi</template>;`);
+console.log(program.type); // "Program"
+```
+
+### Printing
+
+`print` converts an AST node (ESTree _or_ Glimmer) back to source code.
+
+```js
+import { print } from "ember-estree";
+
+print({ type: "Identifier", name: "foo" });
+// => "foo"
+
+print({
+  type: "GlimmerTemplate",
+  body: [{ type: "GlimmerTextNode", chars: "Hello" }],
+});
+// => "<template>Hello</template>"
+```
+
+## Examples
+
+The [`examples/`](./examples) directory contains ready-to-run integrations:
+
+| Example                                     | Description                                                          |
+| ------------------------------------------- | -------------------------------------------------------------------- |
+| [`eslint-parser`](./examples/eslint-parser) | Custom ESLint parser that understands `<template>`                   |
+| [`zmod`](./examples/zmod)                   | Codemod toolkit using [zmod](https://github.com/nicolo-ribaudo/zmod) |
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-estree",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "ESTree generator for gjs and gts file used by ember",
   "keywords": [
     "AST",

package/src/parse.js

@@ -57,7 +57,7 @@ export function toTree(source, options = {}) {
 
   outerAST = walk(outerAST, null, {
     _(node, { next }) {
-      if (isExpressionPlaceholder(node)) {
+      if (isExpressionPlaceholder(node) || isClassMemberPlaceholder(node)) {
         let parseResult = parseResults.find((r) => {
           // WARNING: these are byte ranges
           return node.start === r.range.start && node.end === r.range.end;
@@ -109,3 +109,11 @@ function isExpressionPlaceholder(node) {
 
   return node.callee.name === "TEMPLATE_TEMPLATE";
 }
+
+function isClassMemberPlaceholder(node) {
+  if (node.type !== "PropertyDefinition") return;
+
+  return (
+    node.computed && node.key?.type === "CallExpression" && node.key.callee?.name === "_TEMPLATE_"
+  );
+}