refactor: rename @jsdoc/parse to @jsdoc/ast

To prevent circular dependencies with `@jsdoc/doclet` in the near future.
StephanLuis · Jan 16, 2023 · 59ecaa1 · 59ecaa1
1 parent 913f884
commit 59ecaa1
Show file tree

Hide file tree

Showing 26 changed files with 1,308 additions and 83 deletions.
diff --git a/packages/jsdoc-parse/.npmignore → packages/jsdoc-ast/.npmignore b/packages/jsdoc-parse/.npmignore → packages/jsdoc-ast/.npmignore
diff --git a/packages/jsdoc-parse/LICENSE → packages/jsdoc-ast/LICENSE b/packages/jsdoc-parse/LICENSE → packages/jsdoc-ast/LICENSE
diff --git a/packages/jsdoc-ast/README.md b/packages/jsdoc-ast/README.md
@@ -0,0 +1,3 @@
+# `@jsdoc/ast`
+
+JSDoc tools for working with abstract syntax trees (ASTs).
diff --git a/packages/jsdoc-parse/index.js → packages/jsdoc-ast/index.js b/packages/jsdoc-parse/index.js → packages/jsdoc-ast/index.js
diff --git a/packages/jsdoc-parse/lib/ast-builder.js → packages/jsdoc-ast/lib/ast-builder.js b/packages/jsdoc-parse/lib/ast-builder.js → packages/jsdoc-ast/lib/ast-builder.js
diff --git a/packages/jsdoc-parse/lib/ast-node.js → packages/jsdoc-ast/lib/ast-node.js b/packages/jsdoc-parse/lib/ast-node.js → packages/jsdoc-ast/lib/ast-node.js
@@ -14,7 +14,6 @@
   limitations under the License.
 */
 // TODO: docs
-/** @module @jsdoc/parse.astNode */
 const _ = require('lodash');
 const { cast } = require('@jsdoc/util');
 const { SCOPE } = require('@jsdoc/core').name;
@@ -26,7 +25,6 @@ let uid = 100000000;
 /**
  * Check whether an AST node represents a function.
  *
- * @alias module:@jsdoc/parse.astNode.isFunction
  * @param {(Object|string)} node - The AST node to check, or the `type` property of a node.
  * @return {boolean} Set to `true` if the node is a function or `false` in all other cases.
  */
@@ -54,7 +52,6 @@ const isFunction = (exports.isFunction = (node) => {
 /**
  * Check whether an AST node creates a new scope.
  *
- * @alias module:@jsdoc/parse.astNode.isScope
  * @param {Object} node - The AST node to check.
  * @return {Boolean} Set to `true` if the node creates a new scope, or `false` in all other cases.
  */

diff --git a/packages/jsdoc-parse/lib/syntax.js → packages/jsdoc-ast/lib/syntax.js b/packages/jsdoc-parse/lib/syntax.js → packages/jsdoc-ast/lib/syntax.js
diff --git a/packages/jsdoc-parse/lib/walker.js → packages/jsdoc-ast/lib/walker.js b/packages/jsdoc-parse/lib/walker.js → packages/jsdoc-ast/lib/walker.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# `@jsdoc/ast`

		JSDoc tools for working with abstract syntax trees (ASTs).