[docs-utils] remove extra api_docs dir

elastic · Jan 10, 2023 · a88a0be · a88a0be
1 parent 30b8a2d
commit a88a0be
Show file tree

Hide file tree

Showing 72 changed files with 149 additions and 149 deletions.
diff --git a/dev_docs/contributing/documentation.mdx b/dev_docs/contributing/documentation.mdx
@@ -171,7 +171,7 @@ There are three great ways to debug issues with the API infrastructure.
 
 1. Write a test
 
-[api_doc_suite.test.ts](https://github.com/elastic/kibana/blob/main/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts) is a pretty comprehensive test suite that builds the test docs inside the [**fixtures** folder](https://github.com/elastic/kibana/tree/main/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src).
+[api_doc_suite.test.ts](https://github.com/elastic/kibana/blob/main/packages/kbn-docs-utils/src/tests/api_doc_suite.test.ts) is a pretty comprehensive test suite that builds the test docs inside the [**fixtures** folder](https://github.com/elastic/kibana/tree/main/packages/kbn-docs-utils/src/tests/__fixtures__/src).
 
 Edit the code inside `__fixtures__` to replicate the bug, write a test to track what should happen, then run `yarn jest api_doc_suite`.
 

diff --git a/packages/kbn-docs-utils/index.ts b/packages/kbn-docs-utils/index.ts
@@ -6,4 +6,4 @@
  * Side Public License, v 1.
  */
 
-export { runBuildApiDocsCli } from './src/api_docs';
+export { runBuildApiDocsCli } from './src';
diff --git a/...ges/kbn-docs-utils/src/api_docs/README.md → packages/kbn-docs-utils/src/README.md b/...ges/kbn-docs-utils/src/api_docs/README.md → packages/kbn-docs-utils/src/README.md
diff --git a/...ls/src/api_docs/auto_generated_warning.ts → ...-docs-utils/src/auto_generated_warning.ts b/...ls/src/api_docs/auto_generated_warning.ts → ...-docs-utils/src/auto_generated_warning.ts
diff --git a/...declarations/buid_api_declaration.test.ts → ...declarations/buid_api_declaration.test.ts b/...declarations/buid_api_declaration.test.ts → ...declarations/buid_api_declaration.test.ts
diff --git a/...api_declarations/build_api_declaration.ts → ...api_declarations/build_api_declaration.ts b/...api_declarations/build_api_declaration.ts → ...api_declarations/build_api_declaration.ts
diff --git a/...ld_api_declarations/build_arrow_fn_dec.ts → ...ld_api_declarations/build_arrow_fn_dec.ts b/...ld_api_declarations/build_arrow_fn_dec.ts → ...ld_api_declarations/build_arrow_fn_dec.ts
diff --git a/...clarations/build_basic_api_declaration.ts → ...clarations/build_basic_api_declaration.ts b/...clarations/build_basic_api_declaration.ts → ...clarations/build_basic_api_declaration.ts
diff --git a/..._declarations/build_call_signature_dec.ts → ..._declarations/build_call_signature_dec.ts b/..._declarations/build_call_signature_dec.ts → ..._declarations/build_call_signature_dec.ts
diff --git a/...build_api_declarations/build_class_dec.ts → ...build_api_declarations/build_class_dec.ts b/...build_api_declarations/build_class_dec.ts → ...build_api_declarations/build_class_dec.ts
diff --git a/...ld_api_declarations/build_function_dec.ts → ...ld_api_declarations/build_function_dec.ts b/...ld_api_declarations/build_function_dec.ts → ...ld_api_declarations/build_function_dec.ts
diff --git a/...i_declarations/build_function_type_dec.ts → ...i_declarations/build_function_type_dec.ts b/...i_declarations/build_function_type_dec.ts → ...i_declarations/build_function_type_dec.ts
diff --git a/...d_api_declarations/build_interface_dec.ts → ...d_api_declarations/build_interface_dec.ts b/...d_api_declarations/build_interface_dec.ts → ...d_api_declarations/build_interface_dec.ts
diff --git a/..._api_declarations/build_parameter_decs.ts → ..._api_declarations/build_parameter_decs.ts b/..._api_declarations/build_parameter_decs.ts → ..._api_declarations/build_parameter_decs.ts
diff --git a/...pi_declarations/build_type_literal_dec.ts → ...pi_declarations/build_type_literal_dec.ts b/...pi_declarations/build_type_literal_dec.ts → ...pi_declarations/build_type_literal_dec.ts
diff --git a/...ld_api_declarations/build_variable_dec.ts → ...ld_api_declarations/build_variable_dec.ts b/...ld_api_declarations/build_variable_dec.ts → ...ld_api_declarations/build_variable_dec.ts
diff --git a/..._declarations/extract_import_refs.test.ts → ..._declarations/extract_import_refs.test.ts b/..._declarations/extract_import_refs.test.ts → ..._declarations/extract_import_refs.test.ts
@@ -135,7 +135,7 @@ it('test full file imports with a matching plugin', () => {
         "pluginId": "pluginA",
         "scope": "public",
         "section": undefined,
-        "text": "packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_a/public/foo/index",
+        "text": "packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_a/public/foo/index",
       },
       " something",
     ]

diff --git a/...d_api_declarations/extract_import_refs.ts → ...d_api_declarations/extract_import_refs.ts b/...d_api_declarations/extract_import_refs.ts → ...d_api_declarations/extract_import_refs.ts
diff --git a/.../build_api_declarations/get_references.ts → .../build_api_declarations/get_references.ts b/.../build_api_declarations/get_references.ts → .../build_api_declarations/get_references.ts
diff --git a/...s/build_api_declarations/get_signature.ts → ...c/build_api_declarations/get_signature.ts b/...s/build_api_declarations/get_signature.ts → ...c/build_api_declarations/get_signature.ts
diff --git a/...s/build_api_declarations/get_type_kind.ts → ...c/build_api_declarations/get_type_kind.ts b/...s/build_api_declarations/get_type_kind.ts → ...c/build_api_declarations/get_type_kind.ts
diff --git a/...cs/build_api_declarations/js_doc_utils.ts → ...rc/build_api_declarations/js_doc_utils.ts b/...cs/build_api_declarations/js_doc_utils.ts → ...rc/build_api_declarations/js_doc_utils.ts
diff --git a/.../api_docs/build_api_declarations/types.ts → ...utils/src/build_api_declarations/types.ts b/.../api_docs/build_api_declarations/types.ts → ...utils/src/build_api_declarations/types.ts
diff --git a/.../api_docs/build_api_declarations/utils.ts → ...utils/src/build_api_declarations/utils.ts b/.../api_docs/build_api_declarations/utils.ts → ...utils/src/build_api_declarations/utils.ts
diff --git a/...-utils/src/api_docs/build_api_docs_cli.ts → .../kbn-docs-utils/src/build_api_docs_cli.ts b/...-utils/src/api_docs/build_api_docs_cli.ts → .../kbn-docs-utils/src/build_api_docs_cli.ts
diff --git a/...src/api_docs/count_eslint_disable.test.ts → ...cs-utils/src/count_eslint_disable.test.ts b/...src/api_docs/count_eslint_disable.test.ts → ...cs-utils/src/count_eslint_disable.test.ts
diff --git a/...tils/src/api_docs/count_eslint_disable.ts → ...bn-docs-utils/src/count_eslint_disable.ts b/...tils/src/api_docs/count_eslint_disable.ts → ...bn-docs-utils/src/count_eslint_disable.ts
diff --git a/...n-docs-utils/src/api_docs/find_plugins.ts → packages/kbn-docs-utils/src/find_plugins.ts b/...n-docs-utils/src/api_docs/find_plugins.ts → packages/kbn-docs-utils/src/find_plugins.ts
diff --git a/..._docs/get_declaration_nodes_for_plugin.ts → ...s/src/get_declaration_nodes_for_plugin.ts b/..._docs/get_declaration_nodes_for_plugin.ts → ...s/src/get_declaration_nodes_for_plugin.ts
diff --git a/...tils/src/api_docs/get_paths_by_package.ts → ...bn-docs-utils/src/get_paths_by_package.ts b/...tils/src/api_docs/get_paths_by_package.ts → ...bn-docs-utils/src/get_paths_by_package.ts
diff --git a/...docs-utils/src/api_docs/get_plugin_api.ts → ...ages/kbn-docs-utils/src/get_plugin_api.ts b/...docs-utils/src/api_docs/get_plugin_api.ts → ...ages/kbn-docs-utils/src/get_plugin_api.ts
diff --git a/...-utils/src/api_docs/get_plugin_api_map.ts → .../kbn-docs-utils/src/get_plugin_api_map.ts b/...-utils/src/api_docs/get_plugin_api_map.ts → .../kbn-docs-utils/src/get_plugin_api_map.ts
diff --git a/...ages/kbn-docs-utils/src/api_docs/index.ts → packages/kbn-docs-utils/src/index.ts b/...ages/kbn-docs-utils/src/api_docs/index.ts → packages/kbn-docs-utils/src/index.ts
diff --git a/...xtures__/src/plugin_a/common/foo/index.ts → ...xtures__/src/plugin_a/common/foo/index.ts b/...xtures__/src/plugin_a/common/foo/index.ts → ...xtures__/src/plugin_a/common/foo/index.ts
diff --git a/...__fixtures__/src/plugin_a/common/index.ts → ...__fixtures__/src/plugin_a/common/index.ts b/...__fixtures__/src/plugin_a/common/index.ts → ...__fixtures__/src/plugin_a/common/index.ts
diff --git a/...sts/__fixtures__/src/plugin_a/kibana.json → ...sts/__fixtures__/src/plugin_a/kibana.json b/...sts/__fixtures__/src/plugin_a/kibana.json → ...sts/__fixtures__/src/plugin_a/kibana.json
diff --git a/...fixtures__/src/plugin_a/public/classes.ts → ...fixtures__/src/plugin_a/public/classes.ts b/...fixtures__/src/plugin_a/public/classes.ts → ...fixtures__/src/plugin_a/public/classes.ts
diff --git a/...tures__/src/plugin_a/public/const_vars.ts → ...tures__/src/plugin_a/public/const_vars.ts b/...tures__/src/plugin_a/public/const_vars.ts → ...tures__/src/plugin_a/public/const_vars.ts
diff --git a/...s/__fixtures__/src/plugin_a/public/fns.ts → ...s/__fixtures__/src/plugin_a/public/fns.ts b/...s/__fixtures__/src/plugin_a/public/fns.ts → ...s/__fixtures__/src/plugin_a/public/fns.ts
diff --git a/...xtures__/src/plugin_a/public/foo/index.ts → ...xtures__/src/plugin_a/public/foo/index.ts b/...xtures__/src/plugin_a/public/foo/index.ts → ...xtures__/src/plugin_a/public/foo/index.ts
diff --git a/...__fixtures__/src/plugin_a/public/index.ts → ...__fixtures__/src/plugin_a/public/index.ts b/...__fixtures__/src/plugin_a/public/index.ts → ...__fixtures__/src/plugin_a/public/index.ts
diff --git a/..._fixtures__/src/plugin_a/public/plugin.ts → ..._fixtures__/src/plugin_a/public/plugin.ts b/..._fixtures__/src/plugin_a/public/plugin.ts → ..._fixtures__/src/plugin_a/public/plugin.ts
diff --git a/...__fixtures__/src/plugin_a/public/types.ts → ...__fixtures__/src/plugin_a/public/types.ts b/...__fixtures__/src/plugin_a/public/types.ts → ...__fixtures__/src/plugin_a/public/types.ts
diff --git a/...sts/__fixtures__/src/plugin_b/kibana.json → ...sts/__fixtures__/src/plugin_b/kibana.json b/...sts/__fixtures__/src/plugin_b/kibana.json → ...sts/__fixtures__/src/plugin_b/kibana.json
diff --git a/...__fixtures__/src/plugin_b/public/index.ts → ...__fixtures__/src/plugin_b/public/index.ts b/...__fixtures__/src/plugin_b/public/index.ts → ...__fixtures__/src/plugin_b/public/index.ts
diff --git a/...tion_tests/__fixtures__/src/tsconfig.json → ...tion_tests/__fixtures__/src/tsconfig.json b/...tion_tests/__fixtures__/src/tsconfig.json → ...tion_tests/__fixtures__/src/tsconfig.json
diff --git a/...s/integration_tests/api_doc_suite.test.ts → ...c/integration_tests/api_doc_suite.test.ts b/...s/integration_tests/api_doc_suite.test.ts → ...c/integration_tests/api_doc_suite.test.ts
diff --git a/...tion_tests/kibana_platform_plugin_mock.ts → ...tion_tests/kibana_platform_plugin_mock.ts b/...tion_tests/kibana_platform_plugin_mock.ts → ...tion_tests/kibana_platform_plugin_mock.ts
diff --git a/...ion_tests/snapshots/plugin_a.devdocs.json → ...ion_tests/snapshots/plugin_a.devdocs.json b/...ion_tests/snapshots/plugin_a.devdocs.json → ...ion_tests/snapshots/plugin_a.devdocs.json
diff --git a/.../integration_tests/snapshots/plugin_a.mdx → .../integration_tests/snapshots/plugin_a.mdx b/.../integration_tests/snapshots/plugin_a.mdx → .../integration_tests/snapshots/plugin_a.mdx
diff --git a/...tests/snapshots/plugin_a_foo.devdocs.json → ...tests/snapshots/plugin_a_foo.devdocs.json b/...tests/snapshots/plugin_a_foo.devdocs.json → ...tests/snapshots/plugin_a_foo.devdocs.json
@@ -13,7 +13,7 @@
         "signature": [
           "() => void"
         ],
-        "path": "packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_a/public/foo/index.ts",
+        "path": "packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_a/public/foo/index.ts",
         "deprecated": false,
         "trackAdoption": false,
         "children": [],
@@ -34,7 +34,7 @@
         "signature": [
           "() => \"foo\""
         ],
-        "path": "packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_a/public/foo/index.ts",
+        "path": "packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_a/public/foo/index.ts",
         "deprecated": false,
         "trackAdoption": false,
         "returnComment": [],
@@ -68,12 +68,12 @@
         "signature": [
           "\"COMMON VAR!\""
         ],
-        "path": "packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_a/common/foo/index.ts",
+        "path": "packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_a/common/foo/index.ts",
         "deprecated": false,
         "trackAdoption": false,
         "initialIsOpen": false
       }
     ],
     "objects": []
   }
-}
+}
diff --git a/...egration_tests/snapshots/plugin_a_foo.mdx → ...egration_tests/snapshots/plugin_a_foo.mdx b/...egration_tests/snapshots/plugin_a_foo.mdx → ...egration_tests/snapshots/plugin_a_foo.mdx
diff --git a/...ion_tests/snapshots/plugin_b.devdocs.json → ...ion_tests/snapshots/plugin_b.devdocs.json b/...ion_tests/snapshots/plugin_b.devdocs.json → ...ion_tests/snapshots/plugin_b.devdocs.json
@@ -29,7 +29,7 @@
           },
           "<any>"
         ],
-        "path": "packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_b/public/index.ts",
+        "path": "packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_b/public/index.ts",
         "deprecated": false,
         "trackAdoption": false,
         "children": [
@@ -50,7 +50,7 @@
               },
               "<any>"
             ],
-            "path": "packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_b/public/index.ts",
+            "path": "packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_b/public/index.ts",
             "deprecated": false,
             "trackAdoption": false,
             "isRequired": true
@@ -81,4 +81,4 @@
     "misc": [],
     "objects": []
   }
-}
+}
diff --git a/.../integration_tests/snapshots/plugin_b.mdx → .../integration_tests/snapshots/plugin_b.mdx b/.../integration_tests/snapshots/plugin_b.mdx → .../integration_tests/snapshots/plugin_b.mdx
diff --git a/...cs/mdx/build_plugin_deprecations_table.ts → ...rc/mdx/build_plugin_deprecations_table.ts b/...cs/mdx/build_plugin_deprecations_table.ts → ...rc/mdx/build_plugin_deprecations_table.ts
diff --git a/.../src/api_docs/mdx/get_all_doc_file_ids.ts → ...ocs-utils/src/mdx/get_all_doc_file_ids.ts b/.../src/api_docs/mdx/get_all_doc_file_ids.ts → ...ocs-utils/src/mdx/get_all_doc_file_ids.ts
diff --git a/...api_docs/mdx/split_apis_by_folder.test.ts → ...tils/src/mdx/split_apis_by_folder.test.ts b/...api_docs/mdx/split_apis_by_folder.test.ts → ...tils/src/mdx/split_apis_by_folder.test.ts
diff --git a/.../kbn-docs-utils/src/api_docs/mdx/types.ts → packages/kbn-docs-utils/src/mdx/types.ts b/.../kbn-docs-utils/src/api_docs/mdx/types.ts → packages/kbn-docs-utils/src/mdx/types.ts
diff --git a/...docs/mdx/write_deprecations_doc_by_api.ts → .../src/mdx/write_deprecations_doc_by_api.ts b/...docs/mdx/write_deprecations_doc_by_api.ts → .../src/mdx/write_deprecations_doc_by_api.ts
diff --git a/...s/mdx/write_deprecations_doc_by_plugin.ts → ...c/mdx/write_deprecations_doc_by_plugin.ts b/...s/mdx/write_deprecations_doc_by_plugin.ts → ...c/mdx/write_deprecations_doc_by_plugin.ts
diff --git a/...ocs/mdx/write_deprecations_due_by_team.ts → ...src/mdx/write_deprecations_due_by_team.ts b/...ocs/mdx/write_deprecations_due_by_team.ts → ...src/mdx/write_deprecations_due_by_team.ts
diff --git a/...pi_docs/mdx/write_plugin_directory_doc.ts → ...ils/src/mdx/write_plugin_directory_doc.ts b/...pi_docs/mdx/write_plugin_directory_doc.ts → ...ils/src/mdx/write_plugin_directory_doc.ts
diff --git a/...src/api_docs/mdx/write_plugin_mdx_docs.ts → ...cs-utils/src/mdx/write_plugin_mdx_docs.ts b/...src/api_docs/mdx/write_plugin_mdx_docs.ts → ...cs-utils/src/mdx/write_plugin_mdx_docs.ts
diff --git a/.../mdx/write_plugin_split_by_folder.test.ts → .../mdx/write_plugin_split_by_folder.test.ts b/.../mdx/write_plugin_split_by_folder.test.ts → .../mdx/write_plugin_split_by_folder.test.ts
diff --git a/..._docs/mdx/write_plugin_split_by_folder.ts → ...s/src/mdx/write_plugin_split_by_folder.ts b/..._docs/mdx/write_plugin_split_by_folder.ts → ...s/src/mdx/write_plugin_split_by_folder.ts
diff --git a/...ages/kbn-docs-utils/src/api_docs/stats.ts → packages/kbn-docs-utils/src/stats.ts b/...ages/kbn-docs-utils/src/api_docs/stats.ts → packages/kbn-docs-utils/src/stats.ts
diff --git a/...rc/api_docs/trim_deleted_docs_from_nav.ts → ...s-utils/src/trim_deleted_docs_from_nav.ts b/...rc/api_docs/trim_deleted_docs_from_nav.ts → ...s-utils/src/trim_deleted_docs_from_nav.ts
diff --git a/...-docs-utils/src/api_docs/tsmorph_utils.ts → packages/kbn-docs-utils/src/tsmorph_utils.ts b/...-docs-utils/src/api_docs/tsmorph_utils.ts → packages/kbn-docs-utils/src/tsmorph_utils.ts
diff --git a/...ages/kbn-docs-utils/src/api_docs/types.ts → packages/kbn-docs-utils/src/types.ts b/...ages/kbn-docs-utils/src/api_docs/types.ts → packages/kbn-docs-utils/src/types.ts
diff --git a/...kbn-docs-utils/src/api_docs/utils.test.ts → packages/kbn-docs-utils/src/utils.test.ts b/...kbn-docs-utils/src/api_docs/utils.test.ts → packages/kbn-docs-utils/src/utils.test.ts
@@ -53,8 +53,8 @@ it('test getServiceForPath', () => {
 
   expect(
     getServiceForPath(
-      '/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_a/public/foo/index',
-      '/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/plugin_a'
+      '/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_a/public/foo/index',
+      '/var/lib/jenkins/workspace/elastic+kibana+pipeline-pull-request/kibana/packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/plugin_a'
     )
   ).toBe('foo');
 });

diff --git a/...ages/kbn-docs-utils/src/api_docs/utils.ts → packages/kbn-docs-utils/src/utils.ts b/...ages/kbn-docs-utils/src/api_docs/utils.ts → packages/kbn-docs-utils/src/utils.ts
diff --git a/packages/kbn-ts-projects/ts_projects.ts b/packages/kbn-ts-projects/ts_projects.ts
@@ -12,7 +12,7 @@ export const TS_PROJECTS = TsProject.loadAll({
   /** Array of repo-relative paths to projects which should be ignored and not treated as a TS project in the repo */
   ignore: [
     'x-pack/plugins/apm/scripts/optimize_tsconfig/tsconfig.json',
-    'packages/kbn-docs-utils/src/api_docs/integration_tests/__fixtures__/src/**/*',
+    'packages/kbn-docs-utils/src/integration_tests/__fixtures__/src/**/*',
   ],
 
   /** Array of repo-relative paths to projects which should have their type-check disabled */