jsdoc/packages/jsdoc-ast/lib/ast-builder.js
Jeff Williams 89f2c72da4
refactor: provide logging functions in dependencies; stop using EventBus
These changes enable templates to use the logging functions even if they're not installed in the same `node_modules` directory as JSDoc.

Includes API changes to various modules and functions that didn't have access to the dependency object. Most notably, you now call a function to retrieve tag definitions, rather than just using an exported object as-is.
2023-11-15 17:43:21 -08:00

86 lines
1.9 KiB
JavaScript

/*
Copyright 2020 the JSDoc Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import babelParser from '@babel/parser';
import _ from 'lodash';
// Exported so we can use them in tests.
export const parserOptions = {
allowAwaitOutsideFunction: true,
allowImportExportEverywhere: true,
allowReturnOutsideFunction: true,
allowSuperOutsideMethod: true,
allowUndeclaredExports: true,
plugins: [
'asyncGenerators',
'bigInt',
'classPrivateMethods',
'classPrivateProperties',
'classProperties',
[
'decorators',
{
decoratorsBeforeExport: true,
},
],
'doExpressions',
'dynamicImport',
'estree',
'exportDefaultFrom',
'exportNamespaceFrom',
'functionBind',
'functionSent',
'importMeta',
'jsx',
'logicalAssignment',
'nullishCoalescingOperator',
'numericSeparator',
'objectRestSpread',
'optionalCatchBinding',
'optionalChaining',
[
'pipelineOperator',
{
proposal: 'minimal',
},
],
'throwExpressions',
],
ranges: true,
};
// TODO: docs
export class AstBuilder {
#log;
constructor(deps) {
this.#log = deps.get('log');
}
build(source, filename, sourceType) {
let ast;
const options = _.defaults({}, parserOptions, { sourceType });
try {
ast = babelParser.parse(source, options);
} catch (e) {
this.#log.error(`Unable to parse ${filename}: ${e.message}`);
}
return ast;
}
}