fix(rosetta): 'extract' does not translate samples in submodule READM…

…Es (#2712) --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
aws · Mar 18, 2021 · ccac1bd · ccac1bd
1 parent 4d5c546
commit ccac1bd
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/packages/jsii-rosetta/lib/jsii/assemblies.ts b/packages/jsii-rosetta/lib/jsii/assemblies.ts
@@ -68,6 +68,18 @@ export function allSnippetSources(
     });
   }
 
+  for (const [submoduleFqn, submodule] of Object.entries(
+    assembly.submodules ?? {},
+  )) {
+    if (submodule.readme) {
+      ret.push({
+        type: 'markdown',
+        markdown: submodule.readme.markdown,
+        where: removeSlashes(`${submoduleFqn}-README`),
+      });
+    }
+  }
+
   if (assembly.types) {
     Object.values(assembly.types).forEach((type) => {
       emitDocs(type.docs, `${assembly.name}.${type.name}`);

diff --git a/packages/jsii-rosetta/test/jsii/assemblies.test.ts b/packages/jsii-rosetta/test/jsii/assemblies.test.ts
@@ -29,6 +29,33 @@ test('Extract snippet from README', () => {
   expect(snippets[0].visibleSource).toEqual('someExample();');
 });
 
+test('Extract snippet from submodule READMEs', () => {
+  const snippets = Array.from(
+    allTypeScriptSnippets([
+      {
+        assembly: fakeAssembly({
+          submodules: {
+            'my.submodule': {
+              readme: {
+                markdown: [
+                  'Before the example.',
+                  '```ts',
+                  'someExample();',
+                  '```',
+                  'After the example.',
+                ].join('\n'),
+              },
+            },
+          },
+        }),
+        directory: path.join(__dirname, 'fixtures'),
+      },
+    ]),
+  );
+
+  expect(snippets[0].visibleSource).toEqual('someExample();');
+});
+
 test('Extract snippet from type docstring', () => {
   const snippets = Array.from(
     allTypeScriptSnippets([