Skip to content

Commit

Permalink
Update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
krisztianb committed Sep 22, 2024
1 parent a4013bc commit 6532dc2
Show file tree
Hide file tree
Showing 13 changed files with 562 additions and 365 deletions.
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [6.0.1] - 2024-09-22
### Fixed
- Project documentations (introduced in TypeDoc 0.26) were incorrectly handled and removed by the plugin.
- Merging only happened at the root level and didn't take into account that TypeDoc creates parent modules for projects within monorepos.

## [6.0.0] - 2024-06-30
### BREAKING CHANGES
- Support changed to TypeDoc version 0.26.x due to a breaking change in TypeDoc's API.
Expand Down Expand Up @@ -78,7 +83,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

First release

[unreleased]: https://github.com/krisztianb/typedoc-plugin-merge-modules/compare/v6.0.0...HEAD
[unreleased]: https://github.com/krisztianb/typedoc-plugin-merge-modules/compare/v6.0.1...HEAD
[6.0.1]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v6.0.1
[6.0.0]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v6.0.0
[5.1.0]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v5.1.0
[5.0.1]: https://github.com/krisztianb/typedoc-plugin-merge-modules/releases/tag/v5.0.1
Expand Down
834 changes: 513 additions & 321 deletions package-lock.json

Large diffs are not rendered by default.

11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "typedoc-plugin-merge-modules",
"version": "6.0.0",
"version": "6.0.1",
"description": "Plugin for TypeDoc that merges the content of modules.",
"author": {
"name": "Krisztián Balla",
Expand All @@ -12,19 +12,18 @@
"typedocplugin"
],
"devDependencies": {
"@types/mocha": "10.0.7",
"@types/node": "20.14.9",
"@typescript-eslint/eslint-plugin": "7.14.1",
"@typescript-eslint/parser": "7.14.1",
"cypress": "12.13.0",
"cypress": "13.14.2",
"eslint": "8.56.0",
"eslint-plugin-jsdoc": "48.5.0",
"eslint-plugin-ordered-imports": "0.6.0",
"eslint-plugin-unicorn": "54.0.0",
"prettier": "3.3.2",
"rimraf": "5.0.7",
"prettier": "3.3.3",
"rimraf": "6.0.1",
"typedoc": "0.26.7",
"typescript": "5.5.2"
"typescript": "5.5.4"
},
"peerDependencies": {
"typedoc": "0.26.x"
Expand Down
2 changes: 1 addition & 1 deletion test/merge-module-category/input/project-documents/doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc1.md
# This is the project documentation file doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc1.md
# This is the project documentation file doc1.md
2 changes: 1 addition & 1 deletion test/merge-module-monorepo/input/project2/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @module merged
* @module merged
* @mergeTarget
*/
export { C } from "./c";
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc2.md
# This is the project documentation file doc2.md
2 changes: 1 addition & 1 deletion test/merge-module/input/project-documents/doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc1.md
# This is the project documentation file doc1.md
2 changes: 1 addition & 1 deletion test/merge-off/input/project-documents/doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc1.md
# This is the project documentation file doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc1.md
# This is the project documentation file doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc2.md
# This is the project documentation file doc2.md
2 changes: 1 addition & 1 deletion test/merge-project/input/project-documents/doc1.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# This is the project documentation file doc1.md
# This is the project documentation file doc1.md
56 changes: 28 additions & 28 deletions test/prepare_test.js
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const fs = require("fs");

console.log("=================================== SETTING UP THE TESTS ===========================================");

if (!fs.existsSync("..\\dist")) {
console.error("ERROR: Cannot find 'dist' folder. Did you forget to build the plugin with 'npm run build'?");
process.exit(1);
}

console.log("Copying current build of plugin to node_modules for testing...");

fs.rm("..\\node_modules\\typedoc-plugin-merge-modules", { recursive: true, force: true }, (rmErr) => {
if (rmErr) {
throw rmErr;
} else {
fs.mkdir("..\\node_modules\\typedoc-plugin-merge-modules\\dist", { recursive: true }, (mkDirErr) => {
if (mkDirErr) {
throw mkDirErr;
} else {
fs.copyFileSync("..\\package.json", "..\\node_modules\\typedoc-plugin-merge-modules\\package.json");
fs.cpSync("..\\dist", "..\\node_modules\\typedoc-plugin-merge-modules\\dist", { recursive: true });
}
});
}
});

console.log("DONE\n");
/* eslint-disable @typescript-eslint/no-var-requires */
const fs = require("fs");

console.log("=================================== SETTING UP THE TESTS ===========================================");

if (!fs.existsSync("..\\dist")) {
console.error("ERROR: Cannot find 'dist' folder. Did you forget to build the plugin with 'npm run build'?");
process.exit(1);
}

console.log("Copying current build of plugin to node_modules for testing...");

fs.rm("..\\node_modules\\typedoc-plugin-merge-modules", { recursive: true, force: true }, (rmErr) => {
if (rmErr) {
throw rmErr;
} else {
fs.mkdir("..\\node_modules\\typedoc-plugin-merge-modules\\dist", { recursive: true }, (mkDirErr) => {
if (mkDirErr) {
throw mkDirErr;
} else {
fs.copyFileSync("..\\package.json", "..\\node_modules\\typedoc-plugin-merge-modules\\package.json");
fs.cpSync("..\\dist", "..\\node_modules\\typedoc-plugin-merge-modules\\dist", { recursive: true });
}
});
}
});

console.log("DONE\n");

0 comments on commit 6532dc2

Please sign in to comment.