Skip to content
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

chore: replace compodoc with jsdoc #577

Merged
merged 17 commits into from
Oct 18, 2024
4 changes: 2 additions & 2 deletions .jsdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ module.exports = {
source: {
excludePattern: '(^|\\/|\\\\)[._]',
include: [
'src',
'build/src',
],
includePattern: '\\.js$'
},
templates: {
copyright: 'Copyright 2019 Google, LLC.',
copyright: 'Copyright 2024 Google, LLC.',
includeDate: false,
sourceFiles: false,
systemName: 'googleapis-common',
Expand Down
11 changes: 1 addition & 10 deletions owlbot.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Copyright 2018, 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
# http://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 synthtool as s
import synthtool.gcp as gcp
import synthtool.languages.node as node
Expand All @@ -18,4 +9,4 @@

common_templates = gcp.CommonTemplates()
templates = common_templates.node_library()
s.copy(templates)
s.copy(sources=templates, excludes=["LICENSE", "README.md", ".github/ISSUE_TEMPLATE", ".github/scripts", ".kokoro", ".github/workflows/issues-no-repro.yaml", ".jsdoc.js"])
11 changes: 7 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
"pretest": "npm run compile",
"lint": "gts check",
"samples-test": "mocha build/samples-test",
"docs": "compodoc src/",
"docs": "jsdoc -c .jsdoc.js",
"predocs-test": "npm run docs",
"docs-test": "linkinator docs",
"webpack": "webpack",
"browser-test": "karma start",
"predocs-test": "npm run docs",
"prelint": "cd samples; npm link ../; npm install",
"clean": "gts clean",
"precompile": "gts clean"
Expand All @@ -43,7 +43,6 @@
},
"devDependencies": {
"@babel/plugin-proposal-private-methods": "^7.18.6",
"@compodoc/compodoc": "1.1.19",
"@types/execa": "^2.0.0",
"@types/extend": "^3.0.1",
"@types/mocha": "^9.0.0",
Expand All @@ -62,6 +61,9 @@
"gts": "^5.0.0",
"http2spy": "^2.0.0",
"is-docker": "^2.0.0",
"jsdoc": "^4.0.0",
"jsdoc-fresh": "^3.0.0",
"jsdoc-region-tag": "^3.0.0",
"karma": "^6.0.0",
"karma-chrome-launcher": "^3.0.0",
"karma-coverage": "^2.0.0",
Expand All @@ -76,9 +78,10 @@
"ncp": "^2.0.0",
"nock": "^13.0.0",
"null-loader": "^4.0.0",
"path-to-regexp": "^6.0.0",
"proxyquire": "^2.1.3",
"puppeteer": "^18.2.1",
"sinon": "^18.0.0",
"sinon": "^17.0.0",
"tmp": "^0.2.0",
"ts-loader": "^8.0.0",
"typescript": "5.1.6",
Expand Down
2 changes: 1 addition & 1 deletion system-test/test.kitchen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ describe('pack and install', () => {
await execa('npx', ['webpack'], {cwd: `${stagingPath}/`, stdio: 'inherit'});
const bundle = path.join(stagingPath, 'dist', 'bundle.min.js');
const stat = fs.statSync(bundle);
assert(stat.size < 300 * 1024);
assert(stat.size < 400 * 1024);
});

/**
Expand Down
Loading