* Generate core API docs from TSDoc comments Uses api-extractor and api-documenter to generate documentation for the Kibana core API from TSDoc comments in the source code. Documentation can be generated using `npm run docs:api`. I used --no-verify to ignore the following pre-commit hook errors: 1. Filenames MUST use snake_case - api-extractor.json It's possible to specify a different config file, but I prefer to keep the "standard" config file name. 2. UNHANDLED ERROR: Unable to find tsconfig.json file selecting "common/core_api_review/kibana.api.ts". Ensure one exists and it is listed in "src/dev/typescript/projects.ts" This is not a source file, so safe to ignore. * Flesh out API docs a little bit * Ignore snake_case check for api-extractor.json * Ignore api-extractor's review file from pre-commit check * Try to fix build failing by using masters yarn.lock * I'm being stupid * Found a better home for ignoring common/core_api_review/kibana.api.ts * Node script for detecting core API changes I initially wanted to include this as a precommit hook, but it takes quite long to execute (~12s) so might be better suited as a test or as part of the release process. The script currently fails because api-extractor uses an older version of typescript. * Fix tslint precommit hook ignore condition * Write tsdoc-metadata.json into ./build * Add LogMeta and ElasticSearch to exported types & docs * Suppress logging when running api-extractor from script * Improve check_core_api_changes script and run as test * Inline api-extractor.json config * Fix check_core_api_changes --help flag * LogMeta TSDoc comments * check_core_api_changes: fail if api-extractor produces warnings or errors And print more useful messages to the console * Move ignored ts files list into dev/file * Add back build:types since api-exporter cannot operate on source files * Upgrade api-exporter/documenter * api-extractor: independantly analyze core/public and core/server Becasue of https://github.com/Microsoft/web-build-tools/issues/1029 api-extractor can't use core/index.ts as a single entry point for analyzing the public and server API's as isolated namespaces. Instead we analyze these projects separately. This introduces other problems like the api review files and documentation always being called "kibana." from the package.json filename. * Build types as part of build task * Include types in typescript browser compilation * Force inclusion of core/public for building types * Fix api review filename in api-exporter errors * Update docs and API review files * Fix api-extractor warnings * Remove ts file ignored list since it's no longer necessary * Rename exported api package name * Review comments * Export other missing types * Upgrade api-documenter to latest beta * Export more missing types * Fix warnings and add api-exporter to Jenkins tests * Correctly handle runBuildTypes() exceptions * Fix another swallowed exception * Fix api-extractor warnings after master merge
61 lines
2.5 KiB
TypeScript
61 lines
2.5 KiB
TypeScript
/*
|
|
* Licensed to Elasticsearch B.V. under one or more contributor
|
|
* license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright
|
|
* ownership. Elasticsearch B.V. licenses this file to you under
|
|
* the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
|
|
/**
|
|
* All exports from TS source files (where the implementation is actually done in TS).
|
|
*/
|
|
import * as Public from 'target/types/public';
|
|
import * as Server from 'target/types/server';
|
|
|
|
export { Public, Server };
|
|
|
|
/**
|
|
* All exports from TS ambient definitions (where types are added for JS source in a .d.ts file).
|
|
*/
|
|
import * as LegacyElasticsearch from './src/legacy/core_plugins/elasticsearch';
|
|
import * as LegacyKibanaPluginSpec from './src/legacy/plugin_discovery/plugin_spec/plugin_spec_options';
|
|
import * as LegacyKibanaServer from './src/legacy/server/kbn_server';
|
|
|
|
/**
|
|
* Re-export legacy types under a namespace.
|
|
*/
|
|
// tslint:disable:no-namespace
|
|
export namespace Legacy {
|
|
export type IndexPatternsService = LegacyKibanaServer.IndexPatternsService;
|
|
export type KibanaConfig = LegacyKibanaServer.KibanaConfig;
|
|
export type Request = LegacyKibanaServer.Request;
|
|
export type ResponseToolkit = LegacyKibanaServer.ResponseToolkit;
|
|
export type SavedObjectsClient = LegacyKibanaServer.SavedObjectsClient;
|
|
export type SavedObjectsService = LegacyKibanaServer.SavedObjectsService;
|
|
export type Server = LegacyKibanaServer.Server;
|
|
|
|
export type InitPluginFunction = LegacyKibanaPluginSpec.InitPluginFunction;
|
|
export type UiExports = LegacyKibanaPluginSpec.UiExports;
|
|
export type PluginSpecOptions = LegacyKibanaPluginSpec.PluginSpecOptions;
|
|
|
|
export namespace Plugins {
|
|
export namespace elasticsearch {
|
|
export type Plugin = LegacyElasticsearch.ElasticsearchPlugin;
|
|
export type Cluster = LegacyElasticsearch.Cluster;
|
|
export type ClusterConfig = LegacyElasticsearch.ClusterConfig;
|
|
export type CallClusterOptions = LegacyElasticsearch.CallClusterOptions;
|
|
}
|
|
}
|
|
}
|