Uh oh!
There was an error while loading. Please reload this page.
Update deps and adds some useful API documentation - #49
Conversation
michaelficarra
left a comment
There was a problem hiding this comment.
We're going to need more comprehensive tests for :has. I've left a bunch of comments and will do a follow-up review once they're addressed.
| *Install (via npm for Node.js)* | ||
| `npm i esquery --save` |
There was a problem hiding this comment.
I strongly prefer installation documentation to use npm install .... There's no reason to use shorthand in documentation.
| ```js | ||
| const esquery = require('esquery'); | ||
| const conditional = "if (x === 1) { foo(); } else { x = 2; }" |
There was a problem hiding this comment.
Please use single quotes or double quotes, but not both.
| `[name="x"]:function` - function named `x` | ||
| `[name="foo"]:declaration` - declaration named `foo` | ||
| ## Complex |
| - adjacent sibling selector (`+`) | ||
| - general sibling selector (`~`) | ||
| Please see [javascript: expressions-vs-statements](http://www.2ality.com/2012/09/expressions-vs-statements.html) |
There was a problem hiding this comment.
I'm not sure how this is related. Instead, one should see the estree specification.
There was a problem hiding this comment.
You might also want to point them to the CSS documentation because these combinators are both syntactically and semantically identical.
| Please see [javascript: expressions-vs-statements](http://www.2ality.com/2012/09/expressions-vs-statements.html) | ||
| `IfStatement > BinaryExpression` - `if` statement followed by a [binary expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators) fx `3+4` or `x*y` |
There was a problem hiding this comment.
No, a BinaryExpression nested directly within an IfStatement.
| `VariableDeclaration ~ IfStatement` | ||
| `var` declaration with sibling `if` statement |
There was a problem hiding this comment.
if statement with sibling var declaration. The if statement is the target.
| ### Fields | ||
| You can also query on the [Mozilla Parser API](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Parser_API) fields directly |
There was a problem hiding this comment.
This link should be updated to estree.
| ### Subject | ||
| `!IfStatement Identifier` - any not an If statement with an Identifier under, such as `const x = 3` but not `if (x == 2)` |
There was a problem hiding this comment.
any not an If statement with an Identifier under
any if statement with one or more nested Identifier
| `!IfStatement Identifier` - any not an If statement with an Identifier under, such as `const x = 3` but not `if (x == 2)` | ||
| `!* > [name="foo"]` all nodes but those where the immediate child is a node namded `foo` |
| - `!:matches(*) > [name="foo"]` | ||
| - `!:not(BlockStatement) > [name="foo"]` | ||
| - `![left.name="x"][right.value=1]` | ||
| - `* !AssignmentExpression` |
There was a problem hiding this comment.
I don't think this is a productive example. What is it trying to show off?
There was a problem hiding this comment.
Please do whatever it takes to add sufficient docs for how to use the API. I tried my best using the tests cases for inspiration.
jkjustjoshing
commented
Dec 11, 2017
@kristianmandrup I hope you update the PR based on the feedback and help get this merged in - I found this document extremely helpful in understanding how to use esquery! |
kristianmandrup
commented
Dec 12, 2017
Hey! I would be grateful if you would get it merged. Thanks! |
kristianmandrup
commented
Dec 13, 2017
I made all the fixes as per your suggestions. Please review this PR again and let's make a good API documentation :) |
michaelficarra
commented
Dec 13, 2017
@kristianmandrup It seems your branch has fallen behind. You should rebase on this repo's |
| "name": "esquery", | ||
| "preferGlobal": false, | ||
| "version": "0.4.0", | ||
| "version": "0.4.1", |
There was a problem hiding this comment.
Please don't bump the version. We'll bump it appropriately during a release.
Please review and merge ;)