From ce880fdfce9a9c529184600a2b65b2048a70f2e3 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Sun, 23 Jun 2024 10:26:00 +0100 Subject: [PATCH] fix(core): update internal translations --- package-lock.json | 40 +++++++++---------- package.json | 2 +- .../src/renderer/overrides.ts | 6 +-- .../context/partials/comments.comment.ts | 2 +- 4 files changed, 24 insertions(+), 26 deletions(-) diff --git a/package-lock.json b/package-lock.json index d56dfb60..a88e4575 100644 --- a/package-lock.json +++ b/package-lock.json @@ -45,7 +45,7 @@ "ts-morph": "^22.0.0", "ts-node": "^10.9.2", "tsc-alias": "^1.8.10", - "typedoc": "^0.26.0", + "typedoc": "^0.26.1", "typescript": "^5.5.2", "unified-prettier": "^2.0.1" } @@ -5064,9 +5064,9 @@ "dev": true }, "node_modules/@shikijs/core": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.7.0.tgz", - "integrity": "sha512-O6j27b7dGmJbR3mjwh/aHH8Ld+GQvA0OQsNO43wKWnqbAae3AYXrhFyScHGX8hXZD6vX2ngjzDFkZY5srtIJbQ==" + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.9.0.tgz", + "integrity": "sha512-cbSoY8P/jgGByG8UOl3jnP/CWg/Qk+1q+eAKWtcrU3pNoILF8wTsLB0jT44qUBV8Ce1SvA9uqcM9Xf+u3fJFBw==" }, "node_modules/@sideway/address": { "version": "4.1.5", @@ -20431,11 +20431,11 @@ } }, "node_modules/shiki": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.7.0.tgz", - "integrity": "sha512-H5pMn4JA7ayx8H0qOz1k2qANq6mZVCMl1gKLK6kWIrv1s2Ial4EmD4s4jE8QB5Dw03d/oCQUxc24sotuyR5byA==", + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-1.9.0.tgz", + "integrity": "sha512-i6//Lqgn7+7nZA0qVjoYH0085YdNk4MC+tJV4bo+HgjgRMJ0JmkLZzFAuvVioJqLkcGDK5GAMpghZEZkCnwxpQ==", "dependencies": { - "@shikijs/core": "1.7.0" + "@shikijs/core": "1.9.0" } }, "node_modules/side-channel": { @@ -22159,14 +22159,14 @@ } }, "node_modules/typedoc": { - "version": "0.26.0", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.0.tgz", - "integrity": "sha512-OcYevjHsMN8DfpaL0dSBGAEBhOxuBB5Au8QVs9oz9iB0kRStPZwXLFWqh9gwbMUxNjW3yQuIM5GrVVauMJ2Akw==", + "version": "0.26.1", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.26.1.tgz", + "integrity": "sha512-APsVXqh93jTlpkLuw6+/IORx7n5LN8hzJV8nvMIrYYaIva0VCq0CoDN7Z3hsRThEYVExI/qoFHnAAxrhG+Wd7Q==", "dependencies": { "lunr": "^2.3.9", "markdown-it": "^14.1.0", "minimatch": "^9.0.4", - "shiki": "^1.6.5", + "shiki": "^1.9.0", "yaml": "^2.4.5" }, "bin": { @@ -23680,21 +23680,21 @@ "@docusaurus/types": "^3.2.1" }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0" + "typedoc-plugin-markdown": ">=4.1.0" } }, "packages/typedoc-github-wiki-theme": { "version": "2.0.0", "license": "MIT", "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0" + "typedoc-plugin-markdown": ">=4.1.0" } }, "packages/typedoc-gitlab-wiki-theme": { "version": "2.0.1", "license": "MIT", "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0" + "typedoc-plugin-markdown": ">=4.1.0" } }, "packages/typedoc-plugin-frontmatter": { @@ -23704,11 +23704,11 @@ "yaml": "^2.3.4" }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0" + "typedoc-plugin-markdown": ">=4.1.0" } }, "packages/typedoc-plugin-markdown": { - "version": "4.0.3", + "version": "4.1.0", "license": "MIT", "engines": { "node": ">= 18" @@ -23718,7 +23718,7 @@ } }, "packages/typedoc-plugin-remark": { - "version": "1.0.1", + "version": "1.0.2", "license": "MIT", "dependencies": { "remark": "^15.0.1", @@ -23728,14 +23728,14 @@ "to-vfile": "^8.0.0" }, "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0" + "typedoc-plugin-markdown": ">=4.1.0" } }, "packages/typedoc-vitepress-theme": { "version": "1.0.0", "license": "MIT", "peerDependencies": { - "typedoc-plugin-markdown": ">=4.0.0" + "typedoc-plugin-markdown": ">=4.1.0" } } } diff --git a/package.json b/package.json index 765d2836..d843321c 100644 --- a/package.json +++ b/package.json @@ -50,7 +50,7 @@ "ts-morph": "^22.0.0", "ts-node": "^10.9.2", "tsc-alias": "^1.8.10", - "typedoc": "^0.26.0", + "typedoc": "^0.26.1", "typescript": "^5.5.2", "unified-prettier": "^2.0.1" } diff --git a/packages/typedoc-plugin-markdown/src/renderer/overrides.ts b/packages/typedoc-plugin-markdown/src/renderer/overrides.ts index 1ec2eea7..42bdb4fe 100644 --- a/packages/typedoc-plugin-markdown/src/renderer/overrides.ts +++ b/packages/typedoc-plugin-markdown/src/renderer/overrides.ts @@ -17,11 +17,9 @@ export async function generateDocs(project: ProjectReflection, out: string) { const start = Date.now(); await this.renderer.render(project, out); if (this.logger.hasErrors()) { - this.logger.error( - 'Documentation could not be generated due to the errors above.', - ); + this.logger.error(this.i18n.docs_could_not_be_generated()); } else { - this.logger.info(`Documentation generated at ${nicePath(out)}`); + this.logger.info(this.i18n.docs_generated_at_0(nicePath(out))); this.logger.verbose(`Markdown rendering took ${Date.now() - start}ms`); } } diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts index 9292e35f..aad688fa 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/comments.comment.ts @@ -76,7 +76,7 @@ export function comment( [], ); - const filteredBlockTags = ['@returns', '@module']; + const filteredBlockTags = ['@returns']; const tags = blockTags .filter((tag) => !filteredBlockTags.includes(tag.tag))