fix: split by submodule ignores output

cdklabs · Oct 2, 2023 · 9b3ad15 · 9b3ad15
1 parent 6c90770
commit 9b3ad15
Show file tree

Hide file tree

Showing 5 changed files with 1,114 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -34,14 +34,15 @@ Curreently jsii-docgen supports generating documentation in the following langua
 
 ## CLI Options
 
-| Option              | Required | Description                                                                                                                                  |
-|:--------------------| :------- |:---------------------------------------------------------------------------------------------------------------------------------------------|
-| `--output`, `-o`    | optional | Output filename (defaults to API.md if format is markdown, and API.json if format is JSON). <br /><br />`jsii-docgen -o ./docs/API.md`       |
-| `--format`, `-f`    | optional | Output format. Can be `markdown` or `json`. <br /><br />`jsii-docgen -f json`                                                                |
-| `--language`, `-l`  | optional | Language to generate documentation for. Can be `typescript`, `python`, `java`, `csharp` or `go`. <br /><br />`jsii-docgen -l typescript` |
-| `--package`, `-p`   | optional | The name@version of an NPM package to document. <br /><br />`jsii-docgen -p my-package`                                                      |
-| `--submodule`, `-s` | optional | Generate docs for a specific submodule or "root". <br /><br />`jsii-docgen -s my-submodule`                                                  |
-| `--readme`, `-r`    | optional | Generate docs for user specified README.md. <br /><br />`jsii-docgen -r`                                                                     |
+| Option                 | Required | Description                                                                                                                              |
+| :--------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
+| `--output`, `-o`       | optional | Output filename (defaults to API.md if format is markdown, and API.json if format is JSON). <br /><br/>`jsii-docgen -o ./docs/API.md`    |
+| `--format`, `-f`       | optional | Output format. Can be `markdown` or `json`. <br /><br />`jsii-docgen -f json`                                                            |
+| `--language`, `-l`     | optional | Language to generate documentation for. Can be `typescript`, `python`, `java`, `csharp` or `go`. <br /><br />`jsii-docgen -l typescript` |
+| `--package`, `-p`      | optional | The name@version of an NPM package to document. <br /><br />`jsii-docgen -p my-package`                                                  |
+| `--readme`, `-r`       | optional | Generate docs for user specified README.md. <br /><br />`jsii-docgen -r`                                                                 |
+| `--submodule`, `-s`    | optional | Generate docs for a specific submodule or "root". <br /><br />`jsii-docgen -s my-submodule`                                              |
+| `--split-by-submodule` | optional | Generate a separate file for each submodule. <br /><br />`jsii-docgen --split-by-submodule`                                              |
 
 ## Contributions
 

diff --git a/src/cli.ts b/src/cli.ts
@@ -1,4 +1,5 @@
 import * as fs from 'fs/promises';
+import * as path from 'node:path';
 import * as yargs from 'yargs';
 import { Language } from './docgen/transpile/transpile';
 import { Documentation } from './index';
@@ -23,10 +24,14 @@ async function generateForLanguage(docs: Documentation, options: GenerateOptions
     : output;
   // e.g. API.typescript as name
   if (outputFileName.includes('.')) {
-    const languageSeperator = outputFileName.split('.')[1];
-    submoduleSuffix = `${languageSeperator}.${fileSuffix}`;
+    const languageSeparator = outputFileName.split('.')[1];
+    submoduleSuffix = `${languageSeparator}.${fileSuffix}`;
   }
 
+  // Ensure the output path exists
+  const outputPath = path.dirname(outputFileName);
+  await fs.mkdir(outputPath, { recursive: true });
+
   if (options.splitBySubmodules) {
     if (format !== 'md') {
       throw new Error('split-by-submodule is only supported for markdown');
@@ -41,7 +46,7 @@ async function generateForLanguage(docs: Documentation, options: GenerateOptions
         header: { title: `\`${submodule.name}\` Submodule`, id: submodule.fqn },
       });
 
-      await fs.writeFile(`${submodule.name}.${submoduleSuffix}`, content.render());
+      await fs.writeFile(path.join(outputPath, `${submodule.name}.${submoduleSuffix}`), content.render());
     }
 
     await fs.writeFile(`${outputFileName}.${fileSuffix}`, await (await docs.toIndexMarkdown(submoduleSuffix, options)).render());

diff --git a/test/__fixtures__/libraries/construct-library/.gitignore b/test/__fixtures__/libraries/construct-library/.gitignore
@@ -2,6 +2,7 @@
 *.d.ts
 *.jsii
 API.md
+docs/**
 node_modules/
 tsconfig.json
 tsconfig.tsbuildinfo