-
Notifications
You must be signed in to change notification settings - Fork 698
refactor(docs): centralize JSDoc configuration to repository root #9056
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
quirogas
wants to merge
3
commits into
googleapis:main
Choose a base branch
from
quirogas:refactor/4584-centralize-jsdoc-root
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // 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 fs from 'fs'; | ||
| import path from 'path'; | ||
|
|
||
| let systemName = ''; | ||
| const packageJsonPath = path.join(process.cwd(), 'package.json'); | ||
| if (fs.existsSync(packageJsonPath)) { | ||
| try { | ||
| const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); | ||
| if (pkg.name) { | ||
| systemName = pkg.name; | ||
| } | ||
| } catch (err) { | ||
| // Ignore invalid JSON or read errors | ||
| } | ||
| } | ||
|
|
||
| const include = []; | ||
| if (fs.existsSync(path.join(process.cwd(), 'build/src'))) { | ||
| include.push('build/src'); | ||
| } else if (fs.existsSync(path.join(process.cwd(), 'build/esm/src'))) { | ||
| include.push('build/esm/src'); | ||
| } else if (fs.existsSync(path.join(process.cwd(), 'build/cjs/src'))) { | ||
| include.push('build/cjs/src'); | ||
| } else if (fs.existsSync(path.join(process.cwd(), 'src'))) { | ||
| include.push('src'); | ||
| } else { | ||
| include.push('build/src'); | ||
| } | ||
|
|
||
| if (fs.existsSync(path.join(process.cwd(), 'protos'))) { | ||
| include.push('protos'); | ||
| } else if (fs.existsSync(path.join(process.cwd(), 'build/protos'))) { | ||
| include.push('build/protos'); | ||
| } | ||
|
|
||
| export const opts = { | ||
| readme: './README.md', | ||
| package: './package.json', | ||
| template: './node_modules/jsdoc-fresh', | ||
| recurse: true, | ||
| verbose: true, | ||
| destination: './docs/', | ||
| }; | ||
|
|
||
| export const plugins = ['plugins/markdown', 'jsdoc-region-tag']; | ||
|
|
||
| export const source = { | ||
| excludePattern: '(^|\\/|\\\\)[._]', | ||
| include, | ||
| includePattern: '\\.(js|cjs|mjs)$', | ||
| }; | ||
|
|
||
| export const templates = { | ||
| copyright: 'Copyright 2026 Google LLC', | ||
| includeDate: false, | ||
| sourceFiles: false, | ||
| systemName, | ||
| theme: 'lumen', | ||
| default: { | ||
| outputSourceFiles: false, | ||
| }, | ||
| }; | ||
|
|
||
| export const markdown = { | ||
| idInHeadings: true, | ||
| }; | ||
|
|
||
| export default { | ||
| opts, | ||
| plugins, | ||
| source, | ||
| templates, | ||
| markdown, | ||
| }; | ||
54 changes: 0 additions & 54 deletions
54
core/generator/gapic-generator-typescript/baselines/asset-esm/.jsdoc.cjs.baseline
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 0 additions & 55 deletions
55
core/generator/gapic-generator-typescript/baselines/asset/.jsdoc.js.baseline
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 0 additions & 54 deletions
54
core/generator/gapic-generator-typescript/baselines/bigquery-storage-esm/.jsdoc.cjs.baseline
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 0 additions & 55 deletions
55
core/generator/gapic-generator-typescript/baselines/bigquery-storage/.jsdoc.js.baseline
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the root
package.jsonhas"type": "module", any.jsfile at the root is treated as an ES module by Node.js. However, JSDoc loads configuration files using CommonJSrequire(). When JSDoc attempts to load an ES module viarequire(), Node.js will throw anERR_REQUIRE_ESMerror. Conversely, if the root does not use"type": "module", loading this file viarequire()will throw aSyntaxErrordue to the ESMimport/exportsyntax.To ensure compatibility with JSDoc's CommonJS loader across all environments, the centralized configuration file should be written using CommonJS syntax (
requireandmodule.exports) and named with a.cjsextension (e.g.,.jsdoc.cjs). This guarantees that Node.js always treats it as CommonJS.Additionally, we can make the
templatepath resolution more robust by usingpath.join(__dirname, 'node_modules/jsdoc-fresh')to resolve it to the rootnode_modulesdirectory, regardless of the package directory from which JSDoc is executed.