Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
A library to traverse/modify an AST
Read the API documentation
let createQueryWrapper = require('query-ast')
let $ = createQueryWrapper(ast, options)
QueryAST aims to provide a jQuery like API for traversing an AST.
let ast = {
type: 'program',
value: [{
type: 'item_container',
value: [{
type: 'item',
value: 'a'
}]
}, {
type: 'item_container',
value: []
}, {
type: 'item',
value: 'b'
}]
}
// Create a QueryWrapper that will be used to traverse/modify an AST
let $ = createQueryWrapper(ast)
// By default, the QueryWrapper is scoped to the root node
$('item').length() // 2
// The QueryWrapper can also be scoped to a NodeWrapper or array of NodeWrappers
$('item_container').filter((n) => {
return $(n).has('item')
}).length() // 1
Most of the traversal functions take an optional QueryWrapper~Selector
argument that will
be use to filter the results.
A selector can be 1 of 3 types:
string
that is compared against the return value of options.getType()
regexp
that is compared against the return value of options.getType()
function
that will be passed a NodeWrapper
and expected to return a boolean
let ast = {
type: 'program',
value: [{
type: 'item_container',
value: [{
type: 'item',
value: 'a'
}]
}, {
type: 'item',
value: 'b'
}]
}
let $ = createQueryWrapper(ast)
// String
$('item').length() // 2
// RegExp
$(/item/).length() // 3
// Function
$((n) => n.node.value === 'a').length() // 1
By default, QueryAST assumes that an AST will be formatted as a node tree
where each node has a type
key and a value
key that either contains the
string value of the node or an array of child nodes.
let ast = {
type: 'program',
value: [{
type: 'item',
value: 'a'
}]
}
Not every AST follows the same format, so QueryAST also provides a way to traverse any tree structure. Below are the default options used to handle the above AST structure.
let options = {
/**
* Return true if the node has children
*
* @param {object} node
* @returns {boolean}
*/
hasChildren: (node) => Array.isArray(node.value),
/**
* Return an array of child nodes
*
* @param {object} node
* @returns {object[]}
*/
getChildren: (node) => node.value,
/**
* Return a string representation of the node's type
*
* @param {object} node
* @returns {string}
*/
getType: (node) => node.type,
/**
* Convert the node back to JSON. This usually just means merging the
* children back into the node
*
* @param {object} node
* @param {object[]} [children]
* @returns {string}
*/
toJSON: (node, children) => {
return Object.assign({}, node, {
value: children ? children : node.value
})
},
/**
* Convert the node to a string
*
* @param {object} node
* @returns {string}
*/
toString: (node) => {
return typeof node.value === 'string' ? node.value : ''
}
}
Clone the repository, then:
npm install
# requires node >= 6.0.0
npm test
npm run doc
FAQs
A library to traverse/modify an AST
The npm package query-ast receives a total of 157,952 weekly downloads. As such, query-ast popularity was classified as popular.
We found that query-ast demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.