123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Source: collections/Node.js</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Source: collections/Node.js</h1>
-
-
- <section>
- <article>
- <pre class="prettyprint source linenums"><code>/*
- * Copyright (c) 2015-present, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- */
- 'use strict';
- var _ = require('lodash');
- var Collection = require('../Collection');
- var matchNode = require('../matchNode');
- var recast = require('recast');
- var Node = recast.types.namedTypes.Node;
- var types = recast.types.namedTypes;
- /**
- * @mixin
- */
- var traversalMethods = {
- /**
- * Find nodes of a specific type within the nodes of this collection.
- *
- * @param {type}
- * @param {filter}
- * @return {Collection}
- */
- find: function(type, filter) {
- var paths = [];
- var visitorMethodName = 'visit' + type;
- var visitor = {};
- function visit(path) {
- /*jshint validthis:true */
- if (!filter || matchNode(path.value, filter)) {
- paths.push(path);
- }
- this.traverse(path);
- }
- this.__paths.forEach(function(p, i) {
- var self = this;
- visitor[visitorMethodName] = function(path) {
- if (self.__paths[i] === path) {
- this.traverse(path);
- } else {
- return visit.call(this, path);
- }
- };
- recast.visit(p, visitor);
- }, this);
- return Collection.fromPaths(paths, this, type);
- },
- /**
- * Returns a collection containing the paths that create the scope of the
- * currently selected paths. Dedupes the paths.
- *
- * @return {Collection}
- */
- closestScope: function() {
- return this.map(path => path.scope && path.scope.path);
- },
- /**
- * Traverse the AST up and finds the closest node of the provided type.
- *
- * @param {Collection}
- * @param {filter}
- * @return {Collection}
- */
- closest: function(type, filter) {
- return this.map(function(path) {
- var parent = path.parent;
- while (
- parent &&
- !(
- type.check(parent.value) &&
- (!filter || matchNode(parent.value, filter))
- )
- ) {
- parent = parent.parent;
- }
- return parent || null;
- });
- },
- /**
- * Finds the declaration for each selected path. Useful for member expressions
- * or JSXElements. Expects a callback function that maps each path to the name
- * to look for.
- *
- * If the callback returns a falsey value, the element is skipped.
- *
- * @param {function} nameGetter
- *
- * @return {Collection}
- */
- getVariableDeclarators: function(nameGetter) {
- return this.map(function(path) {
- /*jshint curly:false*/
- var scope = path.scope;
- if (!scope) return;
- var name = nameGetter.apply(path, arguments);
- if (!name) return;
- scope = scope.lookup(name);
- if (!scope) return;
- var bindings = scope.getBindings()[name];
- if (!bindings) return;
- var decl = Collection.fromPaths(bindings)
- .closest(types.VariableDeclarator);
- if (decl.length === 1) {
- return decl.paths()[0];
- }
- }, types.VariableDeclarator);
- },
- };
- function toArray(value) {
- return Array.isArray(value) ? value : [value];
- }
- /**
- * @mixin
- */
- var mutationMethods = {
- /**
- * Simply replaces the selected nodes with the provided node. If a function
- * is provided it is executed for every node and the node is replaced with the
- * functions return value.
- *
- * @param {Node|Array<Node>|function} nodes
- * @return {Collection}
- */
- replaceWith: function(nodes) {
- return this.forEach(function(path, i) {
- var newNodes =
- (typeof nodes === 'function') ? nodes.call(path, path, i) : nodes;
- path.replace.apply(path, toArray(newNodes));
- });
- },
- /**
- * Inserts a new node before the current one.
- *
- * @param {Node|Array<Node>|function} insert
- * @return {Collection}
- */
- insertBefore: function(insert) {
- return this.forEach(function(path, i) {
- var newNodes =
- (typeof insert === 'function') ? insert.call(path, path, i) : insert;
- path.insertBefore.apply(path, toArray(newNodes));
- });
- },
- /**
- * Inserts a new node after the current one.
- *
- * @param {Node|Array<Node>|function} insert
- * @return {Collection}
- */
- insertAfter: function(insert) {
- return this.forEach(function(path, i) {
- var newNodes =
- (typeof insert === 'function') ? insert.call(path, path, i) : insert;
- path.insertAfter.apply(path, toArray(newNodes));
- });
- },
- remove: function() {
- return this.forEach(path => path.prune());
- }
- };
- function register() {
- Collection.registerMethods(traversalMethods, Node);
- Collection.registerMethods(mutationMethods, Node);
- Collection.setDefaultCollectionType(Node);
- }
- exports.register = _.once(register);
- </code></pre>
- </article>
- </section>
- </div>
- <nav>
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-jscodeshift.html">jscodeshift</a></li></ul><h3>Externals</h3><ul><li><a href="external-astTypes.html">astTypes</a></li></ul><h3>Classes</h3><ul><li><a href="Collection.html">Collection</a></li></ul><h3>Mixins</h3><ul><li><a href="globalMethods.html">globalMethods</a></li><li><a href="mutationMethods.html">mutationMethods</a></li><li><a href="transformMethods.html">transformMethods</a></li><li><a href="traversalMethods.html">traversalMethods</a></li></ul><h3>Global</h3><ul><li><a href="global.html#registerMethods">registerMethods</a></li></ul>
- </nav>
- <br class="clear">
- <footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.1</a> on Wed Sep 21 2016 16:53:09 GMT-0400 (EDT)
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|