зеркало из https://github.com/microsoft/fast.git
Add api-extractor generated docs for di and context export paths (#6979)
# Pull Request ## 📖 Description This change points the `api-extractor` to the `di` and `context` export paths and adds this generated documentation to the documentation site. ### 🎫 Issues Resolves #6090 ## 👩💻 Reviewer Notes This is was a little fiddly as the `api-extractor` does not export export paths, additionally the way the `api-documentor` works assumes a single entry path. This is why if any additions need to be made to expose more export paths, we will need to edit 3 different files to get the documentation to show up on the documentation website. ## ✅ Checklist ### General <!--- Review the list and put an x in the boxes that apply. --> - [x] I have included a change request file using `$ yarn change` - [ ] I have added tests for my changes. - [x] I have tested my changes. - [x] I have updated the project documentation to reflect my changes. - [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.
This commit is contained in:
Jane Chu
GitHub
Родитель
4f166dc4fb
Коммит
97bf7097a3
|
|
@ -0,0 +1,7 @@
|
|||
{
|
||||
"type": "none",
|
||||
"comment": "Add api-extractor generated docs for di and context export paths",
|
||||
"packageName": "@microsoft/fast-element",
|
||||
"email": "7559015+janechu@users.noreply.github.com",
|
||||
"dependentChangeType": "none"
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
||||
"extends": "../../../api-extractor.json",
|
||||
"mainEntryPointFilePath": "./dist/dts/context.d.ts",
|
||||
"apiReport": {
|
||||
"enabled": true,
|
||||
"reportFolder": "<projectFolder>/docs/context",
|
||||
"reportFileName": "api-report.md"
|
||||
},
|
||||
"docModel": {
|
||||
"enabled": true,
|
||||
"apiJsonFilePath": "<projectFolder>/dist/context/context.api.json"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
||||
"extends": "../../../api-extractor.json",
|
||||
"mainEntryPointFilePath": "./dist/dts/di/di.d.ts",
|
||||
"apiReport": {
|
||||
"enabled": true,
|
||||
"reportFolder": "<projectFolder>/docs/di",
|
||||
"reportFileName": "api-report.md"
|
||||
},
|
||||
"docModel": {
|
||||
"enabled": true,
|
||||
"apiJsonFilePath": "<projectFolder>/dist/di/di.api.json"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
## API Report File for "@microsoft/fast-element"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
// @public
|
||||
export type Context<T> = {
|
||||
readonly name: string;
|
||||
readonly initialValue?: T;
|
||||
};
|
||||
|
||||
// @public
|
||||
export const Context: Readonly<{
|
||||
eventType: "context-request";
|
||||
for<T = unknown>(name: string): FASTContext<T>;
|
||||
create<T_1 = unknown>(name: string, initialValue?: T_1 | undefined): FASTContext<T_1>;
|
||||
setDefaultRequestStrategy(strategy: FASTContextRequestStrategy): void;
|
||||
get<T_2 extends UnknownContext>(target: EventTarget, context: T_2): ContextType<T_2>;
|
||||
request<T_3 extends UnknownContext>(target: EventTarget, context: T_3, callback: ContextCallback<ContextType<T_3>>, multiple?: boolean): void;
|
||||
dispatch<T_4 extends UnknownContext>(target: EventTarget, context: T_4, callback: ContextCallback<ContextType<T_4>>, multiple?: boolean): void;
|
||||
provide<T_5 extends UnknownContext>(target: EventTarget, context: T_5, value: ContextType<T_5>): void;
|
||||
handle<T_6 extends UnknownContext>(target: EventTarget, callback: (event: ContextEvent<T_6>) => void, context?: T_6 | undefined): void;
|
||||
defineProperty<T_7 extends UnknownContext>(target: Constructable<EventTarget> | EventTarget, propertyName: string, context: T_7): void;
|
||||
}>;
|
||||
|
||||
// @public
|
||||
export type ContextCallback<ValueType> = (value: ValueType, dispose?: () => void) => void;
|
||||
|
||||
// Warning: (ae-forgotten-export) The symbol "ParameterDecorator" needs to be exported by the entry point context.d.ts
|
||||
//
|
||||
// @public
|
||||
export type ContextDecorator<T = any> = Readonly<Context<T>> & PropertyDecorator & ParameterDecorator_2;
|
||||
|
||||
// @public
|
||||
export class ContextEvent<T extends UnknownContext> extends Event {
|
||||
constructor(context: T, callback: ContextCallback<ContextType<T>>, multiple?: boolean | undefined);
|
||||
// (undocumented)
|
||||
readonly callback: ContextCallback<ContextType<T>>;
|
||||
// (undocumented)
|
||||
readonly context: T;
|
||||
// (undocumented)
|
||||
readonly multiple?: boolean | undefined;
|
||||
}
|
||||
|
||||
// @public
|
||||
export type ContextType<T extends UnknownContext> = T extends Context<infer Y> ? Y : never;
|
||||
|
||||
// @public
|
||||
export type FASTContext<T> = ContextDecorator<T> & {
|
||||
get(target: EventTarget): T;
|
||||
provide(target: EventTarget, value: T): void;
|
||||
request(target: EventTarget, callback: ContextCallback<T>, multiple?: boolean): void;
|
||||
handle(target: EventTarget, callback: (event: ContextEvent<FASTContext<T>>) => void): void;
|
||||
};
|
||||
|
||||
// @public
|
||||
export type FASTContextRequestStrategy = <T extends UnknownContext>(target: EventTarget, context: T, callback: ContextCallback<ContextType<T>>, multiple: any) => void;
|
||||
|
||||
// @public
|
||||
export type UnknownContext = Context<unknown>;
|
||||
|
||||
// Warnings were encountered during analysis:
|
||||
//
|
||||
// dist/dts/context.d.ts:127:5 - (ae-forgotten-export) The symbol "Constructable" needs to be exported by the entry point context.d.ts
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
|
|
@ -0,0 +1,315 @@
|
|||
## API Report File for "@microsoft/fast-element"
|
||||
|
||||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||||
|
||||
```ts
|
||||
|
||||
// @public
|
||||
export const all: (key: any, searchAncestors?: boolean) => ReturnType<typeof DI.inject>;
|
||||
|
||||
// @public
|
||||
export type AsyncRegistrationLocator = (key: Key) => Promise<Registration | null>;
|
||||
|
||||
// @public
|
||||
export interface Container extends ServiceLocator {
|
||||
createChild(config?: Partial<Omit<ContainerConfiguration, "parentLocator">>): Container;
|
||||
getFactory<T extends Constructable>(key: T): Factory<T>;
|
||||
getResolver<K extends Key, T = K>(key: K | Key, autoRegister?: boolean): Resolver<T> | null;
|
||||
register(...params: any[]): Container;
|
||||
// Warning: (ae-forgotten-export) The symbol "Constructable" needs to be exported by the entry point di.d.ts
|
||||
registerFactory<T extends Constructable>(key: T, factory: Factory<T>): void;
|
||||
registerResolver<K extends Key, T = K>(key: K, resolver: Resolver<T>): Resolver<T>;
|
||||
registerTransformer<K extends Key, T = K>(key: K, transformer: Transformer_2<T>): boolean;
|
||||
}
|
||||
|
||||
// Warning: (ae-forgotten-export) The symbol "ContextDecorator" needs to be exported by the entry point di.d.ts
|
||||
//
|
||||
// @public
|
||||
export const Container: ContextDecorator<Container>;
|
||||
|
||||
// @public
|
||||
export interface ContainerConfiguration {
|
||||
asyncRegistrationLocator: AsyncRegistrationLocator;
|
||||
defaultResolver(key: Key, handler: Container): Resolver;
|
||||
parentLocator: ParentLocator;
|
||||
responsibleForOwnerRequests: boolean;
|
||||
}
|
||||
|
||||
// @public
|
||||
export const ContainerConfiguration: Readonly<{
|
||||
default: Readonly<ContainerConfiguration>;
|
||||
}>;
|
||||
|
||||
// Warning: (ae-internal-missing-underscore) The name "ContainerImpl" should be prefixed with an underscore because the declaration is marked as @internal
|
||||
//
|
||||
// @internal (undocumented)
|
||||
export class ContainerImpl implements DOMContainer {
|
||||
constructor(owner: any, config: ContainerConfiguration);
|
||||
// (undocumented)
|
||||
protected config: ContainerConfiguration;
|
||||
// (undocumented)
|
||||
createChild(config?: Partial<Omit<ContainerConfiguration, "parentLocator">>): Container;
|
||||
// (undocumented)
|
||||
get depth(): number;
|
||||
// (undocumented)
|
||||
get<K extends Key>(key: K): Resolved<K>;
|
||||
// (undocumented)
|
||||
getAll<K extends Key>(key: K, searchAncestors?: boolean): readonly Resolved<K>[];
|
||||
// (undocumented)
|
||||
getAsync<K extends Key>(key: K): Promise<Resolved<K>>;
|
||||
// (undocumented)
|
||||
getFactory<K extends Constructable>(Type: K): Factory<K>;
|
||||
// (undocumented)
|
||||
getResolver<K extends Key, T = K>(key: K | Key, autoRegister?: boolean): Resolver<T> | null;
|
||||
// (undocumented)
|
||||
handleContextRequests(enable: boolean): void;
|
||||
// (undocumented)
|
||||
has<K extends Key>(key: K, searchAncestors?: boolean): boolean;
|
||||
// (undocumented)
|
||||
protected owner: any;
|
||||
// (undocumented)
|
||||
get parent(): ContainerImpl | null;
|
||||
// (undocumented)
|
||||
register(...params: any[]): Container;
|
||||
// (undocumented)
|
||||
registerFactory<K extends Constructable>(key: K, factory: Factory<K>): void;
|
||||
// (undocumented)
|
||||
registerResolver<K extends Key, T = K>(key: K, resolver: Resolver<T>): Resolver<T>;
|
||||
// (undocumented)
|
||||
registerTransformer<K extends Key, T = K>(key: K, transformer: Transformer_2<T>): boolean;
|
||||
// (undocumented)
|
||||
get responsibleForOwnerRequests(): boolean;
|
||||
}
|
||||
|
||||
// @public
|
||||
export const DefaultResolver: Readonly<{
|
||||
none(key: Key): Resolver;
|
||||
singleton(key: Key): Resolver;
|
||||
transient(key: Key): Resolver;
|
||||
}>;
|
||||
|
||||
// @public
|
||||
export const DI: Readonly<{
|
||||
installAsContextRequestStrategy(fallback?: () => DOMContainer): void;
|
||||
createContainer(config?: Partial<ContainerConfiguration>): Container;
|
||||
findResponsibleContainer(target: EventTarget, fallback?: () => DOMContainer): DOMContainer;
|
||||
findParentContainer(target: EventTarget, fallback?: () => DOMContainer): DOMContainer;
|
||||
getOrCreateDOMContainer(target?: EventTarget, config?: Partial<Omit<ContainerConfiguration, "parentLocator">>): DOMContainer;
|
||||
getDependencies(Type: Constructable | Injectable): Key[];
|
||||
defineProperty(target: {}, propertyName: string, key: Key, respectConnection?: boolean): void;
|
||||
createContext: typeof createContext;
|
||||
inject(...dependencies: Key[]): (target: any, key?: string | number, descriptor?: PropertyDescriptor | number) => void;
|
||||
transient<T extends Constructable<{}>>(target: T & Partial<RegisterSelf<T>>): T & RegisterSelf<T>;
|
||||
singleton<T_1 extends Constructable<{}>>(target: T_1 & Partial<RegisterSelf<T_1>>, options?: SingletonOptions): T_1 & RegisterSelf<T_1>;
|
||||
}>;
|
||||
|
||||
// @public
|
||||
export interface DOMContainer extends Container {
|
||||
// @beta
|
||||
handleContextRequests(enable: boolean): void;
|
||||
}
|
||||
|
||||
// @public
|
||||
export const DOMContainer: ContextDecorator<DOMContainer>;
|
||||
|
||||
// @public
|
||||
export interface Factory<T extends Constructable = any> {
|
||||
construct(container: Container, dynamicDependencies?: Key[]): Resolved<T>;
|
||||
constructAsync(container: Container, dynamicDependencies?: Key[]): Promise<Resolved<T>>;
|
||||
registerTransformer(transformer: Transformer_2<T>): void;
|
||||
readonly Type: T;
|
||||
}
|
||||
|
||||
// Warning: (ae-internal-missing-underscore) The name "FactoryImpl" should be prefixed with an underscore because the declaration is marked as @internal
|
||||
//
|
||||
// @internal (undocumented)
|
||||
export class FactoryImpl<T extends Constructable = any> implements Factory<T> {
|
||||
constructor(Type: T, dependencies: Key[]);
|
||||
// (undocumented)
|
||||
construct(container: Container, dynamicDependencies?: Key[]): Resolved<T>;
|
||||
// (undocumented)
|
||||
constructAsync(container: Container, dynamicDependencies?: Key[]): Promise<Resolved<T>>;
|
||||
// (undocumented)
|
||||
registerTransformer(transformer: (instance: any) => any): void;
|
||||
// (undocumented)
|
||||
Type: T;
|
||||
}
|
||||
|
||||
// @public
|
||||
export function ignore(target: Injectable, property?: string | number, descriptor?: PropertyDescriptor | number): void;
|
||||
|
||||
// @public
|
||||
export const inject: (...dependencies: Key[]) => (target: any, key?: string | number, descriptor?: PropertyDescriptor | number) => void;
|
||||
|
||||
// @public
|
||||
export type Injectable<T = {}> = Constructable<T> & {
|
||||
inject?: Key[];
|
||||
};
|
||||
|
||||
// @public
|
||||
export interface InterfaceConfiguration {
|
||||
friendlyName?: string;
|
||||
respectConnection?: boolean;
|
||||
}
|
||||
|
||||
// @public
|
||||
export type Key = PropertyKey | object | ContextDecorator | Constructable | Resolver;
|
||||
|
||||
// @public
|
||||
export const lazy: (key: any) => any;
|
||||
|
||||
// @public
|
||||
export const newInstanceForScope: (key: any) => any;
|
||||
|
||||
// @public
|
||||
export const newInstanceOf: (key: any) => any;
|
||||
|
||||
// @public
|
||||
export const optional: (key: any) => any;
|
||||
|
||||
// @public
|
||||
export type ParentLocator = (owner: any) => Container | null;
|
||||
|
||||
// @public
|
||||
export type RegisterSelf<T extends Constructable> = {
|
||||
register(container: Container): Resolver<InstanceType<T>>;
|
||||
registerInRequestor: boolean;
|
||||
};
|
||||
|
||||
// @public
|
||||
export interface Registration<K = any> {
|
||||
register(container: Container): Resolver<K>;
|
||||
}
|
||||
|
||||
// @public
|
||||
export const Registration: Readonly<{
|
||||
instance<T>(key: Key, value: T): Registration<T>;
|
||||
singleton<T_1 extends Constructable<{}>>(key: Key, value: T_1): Registration<InstanceType<T_1>>;
|
||||
transient<T_2 extends Constructable<{}>>(key: Key, value: T_2): Registration<InstanceType<T_2>>;
|
||||
callback<T_3>(key: Key, callback: ResolveCallback<T_3>): Registration<Resolved<T_3>>;
|
||||
cachedCallback<T_4>(key: Key, callback: ResolveCallback<T_4>): Registration<Resolved<T_4>>;
|
||||
aliasTo<T_5>(originalKey: T_5, aliasKey: Key): Registration<Resolved<T_5>>;
|
||||
}>;
|
||||
|
||||
// @public
|
||||
export interface Registry {
|
||||
register(container: Container, ...params: unknown[]): void | Resolver;
|
||||
}
|
||||
|
||||
// @public
|
||||
export type ResolveCallback<T = any> = (handler: Container, requestor: Container, resolver: Resolver<T>) => T;
|
||||
|
||||
// Warning: (ae-forgotten-export) The symbol "ResolverLike" needs to be exported by the entry point di.d.ts
|
||||
//
|
||||
// @public
|
||||
export type Resolved<K> = K extends ContextDecorator<infer T> ? T : K extends Constructable ? InstanceType<K> : K extends ResolverLike<any, infer T1> ? T1 extends Constructable ? InstanceType<T1> : T1 : K;
|
||||
|
||||
// @public
|
||||
export interface Resolver<K = any> extends ResolverLike<Container, K> {
|
||||
}
|
||||
|
||||
// @public
|
||||
export class ResolverBuilder<K> {
|
||||
constructor(container: Container, key: Key);
|
||||
aliasTo(destinationKey: Key): Resolver<K>;
|
||||
cachedCallback(value: ResolveCallback<K>): Resolver<K>;
|
||||
callback(value: ResolveCallback<K>): Resolver<K>;
|
||||
instance(value: K): Resolver<K>;
|
||||
singleton(value: Constructable): Resolver<K>;
|
||||
transient(value: Constructable): Resolver<K>;
|
||||
}
|
||||
|
||||
// Warning: (ae-internal-missing-underscore) The name "ResolverImpl" should be prefixed with an underscore because the declaration is marked as @internal
|
||||
//
|
||||
// @internal (undocumented)
|
||||
export class ResolverImpl implements Resolver, Registration {
|
||||
// (undocumented)
|
||||
get $isResolver(): true;
|
||||
constructor(key: Key, strategy: ResolverStrategy, state: any);
|
||||
// (undocumented)
|
||||
getFactory(container: Container): Factory | null;
|
||||
// (undocumented)
|
||||
key: Key;
|
||||
// (undocumented)
|
||||
register(container: Container): Resolver;
|
||||
// (undocumented)
|
||||
resolve(handler: Container, requestor: Container): any;
|
||||
// (undocumented)
|
||||
resolveAsync(handler: Container, requestor: Container): Promise<any>;
|
||||
// (undocumented)
|
||||
state: any;
|
||||
// (undocumented)
|
||||
strategy: ResolverStrategy;
|
||||
}
|
||||
|
||||
// Warning: (ae-internal-missing-underscore) The name "ResolverStrategy" should be prefixed with an underscore because the declaration is marked as @internal
|
||||
//
|
||||
// @internal (undocumented)
|
||||
export const enum ResolverStrategy {
|
||||
// (undocumented)
|
||||
alias = 5,
|
||||
// (undocumented)
|
||||
array = 4,
|
||||
// (undocumented)
|
||||
callback = 3,
|
||||
// (undocumented)
|
||||
instance = 0,
|
||||
// (undocumented)
|
||||
singleton = 1,
|
||||
// (undocumented)
|
||||
transient = 2
|
||||
}
|
||||
|
||||
// @public
|
||||
export interface ServiceLocator {
|
||||
get<K extends Key>(key: K): Resolved<K>;
|
||||
get<K extends Key>(key: Key): Resolved<K>;
|
||||
get<K extends Key>(key: K | Key): Resolved<K>;
|
||||
getAll<K extends Key>(key: K, searchAncestors?: boolean): readonly Resolved<K>[];
|
||||
getAll<K extends Key>(key: Key, searchAncestors?: boolean): readonly Resolved<K>[];
|
||||
getAll<K extends Key>(key: K | Key, searchAncestors?: boolean): readonly Resolved<K>[];
|
||||
getAsync<K extends Key>(key: K): Promise<Resolved<K>>;
|
||||
getAsync<K extends Key>(key: Key): Promise<Resolved<K>>;
|
||||
getAsync<K extends Key>(key: K | Key): Promise<Resolved<K>>;
|
||||
has<K extends Key>(key: K | Key, searchAncestors: boolean): boolean;
|
||||
}
|
||||
|
||||
// @public
|
||||
export const ServiceLocator: ContextDecorator<ServiceLocator>;
|
||||
|
||||
// Warning: (ae-forgotten-export) The symbol "singletonDecorator" needs to be exported by the entry point di.d.ts
|
||||
//
|
||||
// @public
|
||||
export function singleton<T extends Constructable>(): typeof singletonDecorator;
|
||||
|
||||
// @public (undocumented)
|
||||
export function singleton<T extends Constructable>(options?: SingletonOptions): typeof singletonDecorator;
|
||||
|
||||
// @public
|
||||
export function singleton<T extends Constructable>(target: T & Partial<RegisterSelf<T>>): T & RegisterSelf<T>;
|
||||
|
||||
// @public
|
||||
type Transformer_2<K> = (instance: Resolved<K>) => Resolved<K>;
|
||||
export { Transformer_2 as Transformer }
|
||||
|
||||
// Warning: (ae-forgotten-export) The symbol "transientDecorator" needs to be exported by the entry point di.d.ts
|
||||
//
|
||||
// @public
|
||||
export function transient<T extends Constructable>(): typeof transientDecorator;
|
||||
|
||||
// @public
|
||||
export function transient<T extends Constructable>(target: T & Partial<RegisterSelf<T>>): T & RegisterSelf<T>;
|
||||
|
||||
// Warning: (ae-internal-missing-underscore) The name "validateKey" should be prefixed with an underscore because the declaration is marked as @internal
|
||||
//
|
||||
// @internal (undocumented)
|
||||
export function validateKey(key: any): void;
|
||||
|
||||
// Warnings were encountered during analysis:
|
||||
//
|
||||
// dist/dts/di/di.d.ts:479:5 - (ae-forgotten-export) The symbol "createContext" needs to be exported by the entry point di.d.ts
|
||||
// dist/dts/di/di.d.ts:540:5 - (ae-forgotten-export) The symbol "SingletonOptions" needs to be exported by the entry point di.d.ts
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
|
|
@ -95,7 +95,9 @@
|
|||
"clean:dist": "node ../../../build/clean.js dist",
|
||||
"doc": "api-extractor run --local",
|
||||
"doc:ci": "api-extractor run",
|
||||
"build": "npm run build:tsc && npm run build:rollup && npm run doc",
|
||||
"doc:exports": "node ./scripts/run-api-extractor.js",
|
||||
"doc:exports:ci": "node ./scripts/run-api-extractor.js ci",
|
||||
"build": "npm run build:tsc && npm run build:rollup && npm run doc && npm run doc:exports",
|
||||
"build:rollup": "rollup -c",
|
||||
"build:tsc": "tsc -p ./tsconfig.json",
|
||||
"dev": "tsc -p ./tsconfig.json -w",
|
||||
|
|
@ -105,7 +107,7 @@
|
|||
"prettier:diff": "prettier --config ../../../.prettierrc \"**/*.ts\" --list-different",
|
||||
"eslint": "eslint . --ext .ts",
|
||||
"eslint:fix": "eslint . --ext .ts --fix",
|
||||
"test": "npm run eslint && npm run test-chrome:verbose && npm run doc:ci",
|
||||
"test": "npm run eslint && npm run test-chrome:verbose && npm run doc:ci && npm run doc:exports:ci",
|
||||
"test-node": "mocha --reporter min --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'",
|
||||
"test-node:verbose": "mocha --reporter spec --exit dist/esm/__test__/setup-node.js './dist/esm/**/*.spec.js'",
|
||||
"test-chrome": "karma start karma.conf.cjs --browsers=ChromeHeadlessOpt --single-run --coverage",
|
||||
|
|
|
|||
|
|
@ -0,0 +1,51 @@
|
|||
import path from "path";
|
||||
import fs from "fs";
|
||||
import { fileURLToPath } from 'url';
|
||||
import { Extractor, ExtractorConfig } from '@microsoft/api-extractor';
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = path.dirname(__filename);
|
||||
|
||||
export const exportPaths = [
|
||||
{
|
||||
path: "./context.js",
|
||||
docsFolder: "context",
|
||||
configPath: path.resolve(__dirname, "../api-extractor.context.json")
|
||||
},
|
||||
{
|
||||
path: "./di.js",
|
||||
docsFolder: "di",
|
||||
configPath: path.resolve(__dirname, "../api-extractor.di.json")
|
||||
}
|
||||
];
|
||||
|
||||
(function() {
|
||||
exportPaths.forEach((exportPath) => {
|
||||
const docsFolder = path.resolve(__dirname, `../docs/${exportPath.docsFolder}`);
|
||||
// Create folders in the docs directory
|
||||
if (!fs.existsSync(docsFolder)) {
|
||||
fs.mkdirSync(docsFolder);
|
||||
}
|
||||
|
||||
// Load and parse the api-extractor.json file
|
||||
const extractorConfig = ExtractorConfig.loadFileAndPrepare(exportPath.configPath);
|
||||
|
||||
// Invoke API Extractor
|
||||
const extractorResult = Extractor.invoke(
|
||||
extractorConfig,
|
||||
{
|
||||
// Equivalent to the "--local" command-line parameter
|
||||
localBuild: process.argv[2] !== "ci",
|
||||
}
|
||||
);
|
||||
|
||||
if (extractorResult.succeeded) {
|
||||
console.log(`API Extractor completed successfully for ${exportPath.configPath}`);
|
||||
} else {
|
||||
console.error(
|
||||
`API Extractor completed with ${extractorResult.errorCount} errors` +
|
||||
` and ${extractorResult.warningCount} warnings for ${exportPath.configPath}`
|
||||
);
|
||||
}
|
||||
});
|
||||
})();
|
||||
|
|
@ -54,6 +54,7 @@ module.exports = {
|
|||
items: [
|
||||
{
|
||||
type: "doc",
|
||||
label: "@microsoft/fast-element",
|
||||
id: "api/fast-element",
|
||||
customProps: {
|
||||
description:
|
||||
|
|
@ -61,6 +62,22 @@ module.exports = {
|
|||
keywords: ["fast-element"],
|
||||
},
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
label: "@microsoft/fast-element/context.js",
|
||||
id: "api/fast-element/context/fast-element",
|
||||
customProps: {
|
||||
keywords: ["context"],
|
||||
},
|
||||
},
|
||||
{
|
||||
type: "doc",
|
||||
label: "@microsoft/fast-element/di.js",
|
||||
id: "api/fast-element/di/fast-element",
|
||||
customProps: {
|
||||
keywords: ["dependency injection"],
|
||||
},
|
||||
}
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -31,17 +31,15 @@ function findFiles(startPath, filter, paths = []) {
|
|||
return paths;
|
||||
}
|
||||
|
||||
const packages = ["fast-element"];
|
||||
|
||||
function identifyPackage(path) {
|
||||
for (const pkg of packages) {
|
||||
if (path.indexOf(pkg) !== -1) {
|
||||
return pkg;
|
||||
}
|
||||
const packages = [
|
||||
{
|
||||
main: "fast-element",
|
||||
exports: [
|
||||
"context",
|
||||
"di"
|
||||
]
|
||||
}
|
||||
|
||||
return "";
|
||||
}
|
||||
];
|
||||
|
||||
function updateContentForMdx(content) {
|
||||
content = content.replace("{", "{");
|
||||
|
|
@ -222,40 +220,32 @@ async function copyArticleMarkdown() {
|
|||
}
|
||||
}
|
||||
|
||||
// Copy the api.json files from the web-components packages.
|
||||
// Copy the api.json files from the packages.
|
||||
async function copyAPI() {
|
||||
for (const pkg of packages) {
|
||||
await safeCopy(
|
||||
path.resolve(
|
||||
getPackageJsonDir(`@microsoft/${pkg}`),
|
||||
`./dist/${pkg}.api.json`
|
||||
getPackageJsonDir(`@microsoft/${pkg.main}`),
|
||||
`./dist/${pkg.main}.api.json`
|
||||
),
|
||||
// require.resolve(`@microsoft/${pkg}/dist/${pkg}.api.json`),
|
||||
`./src/docs/api/${pkg}.api.json`
|
||||
`./src/docs/api/${pkg.main}.api.json`
|
||||
);
|
||||
|
||||
if (Array.isArray(pkg.exports)) {
|
||||
for (const pkgExport of pkg.exports) {
|
||||
await safeCopy(
|
||||
path.resolve(
|
||||
getPackageJsonDir(`@microsoft/${pkg.main}`),
|
||||
`./dist/${pkgExport}/${pkgExport}.api.json`
|
||||
),
|
||||
`./src/docs/api/${pkg.main}/${pkgExport}/${pkgExport}.api.json`
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function buildAPIMarkdown() {
|
||||
await copyAPI();
|
||||
|
||||
await new Promise((resolve, reject) =>
|
||||
exec(
|
||||
"api-documenter markdown -i src/docs/api -o docs/api",
|
||||
(err, stdout, stderr) => {
|
||||
console.log(stdout);
|
||||
console.error(stderr);
|
||||
if (err) {
|
||||
return reject(err);
|
||||
}
|
||||
|
||||
return resolve();
|
||||
}
|
||||
)
|
||||
);
|
||||
|
||||
const dir = "./docs/api";
|
||||
const docFiles = await fs.readdir(dir);
|
||||
async function convertDocFiles(dir, docFiles, package, exportPath) {
|
||||
for (const docFile of docFiles) {
|
||||
try {
|
||||
const { name: id, ext } = path.parse(docFile);
|
||||
|
|
@ -263,8 +253,7 @@ async function buildAPIMarkdown() {
|
|||
continue;
|
||||
}
|
||||
|
||||
const pkg = identifyPackage(docFile);
|
||||
const isAPIHome = id === pkg;
|
||||
const isAPIHome = !id.includes(".");
|
||||
const docPath = path.join(dir, docFile);
|
||||
const input = fs.createReadStream(docPath);
|
||||
const output = [];
|
||||
|
|
@ -290,6 +279,10 @@ async function buildAPIMarkdown() {
|
|||
}
|
||||
}
|
||||
|
||||
if (package && exportPath) {
|
||||
line = line.replace(package, `${package}/${exportPath}`);
|
||||
}
|
||||
|
||||
const homeLink = line.match(/\[Home\]\(.\/index\.md\) > (.*)/);
|
||||
|
||||
if (homeLink) {
|
||||
|
|
@ -313,7 +306,7 @@ async function buildAPIMarkdown() {
|
|||
"---",
|
||||
`id: ${id}`,
|
||||
`title: ${title}`,
|
||||
`hide_title: ${!isAPIHome}`,
|
||||
`hide_title: ${isAPIHome}`,
|
||||
"---",
|
||||
];
|
||||
|
||||
|
|
@ -324,6 +317,58 @@ async function buildAPIMarkdown() {
|
|||
}
|
||||
}
|
||||
|
||||
async function buildAPIMarkdown() {
|
||||
await copyAPI();
|
||||
|
||||
await new Promise((resolve, reject) =>
|
||||
exec(
|
||||
"api-documenter markdown -i src/docs/api -o docs/api",
|
||||
(err, stdout, stderr) => {
|
||||
console.log(stdout);
|
||||
console.error(stderr);
|
||||
if (err) {
|
||||
return reject(err);
|
||||
}
|
||||
|
||||
return resolve();
|
||||
}
|
||||
)
|
||||
);
|
||||
|
||||
for (const pkg of packages) {
|
||||
for (const pkgExport of pkg.exports) {
|
||||
await new Promise((resolve, reject) =>
|
||||
exec(
|
||||
`api-documenter markdown -i src/docs/api/${pkg.main}/${pkgExport} -o docs/api/${pkg.main}/${pkgExport}`,
|
||||
(err, stdout, stderr) => {
|
||||
console.log(stdout);
|
||||
console.error(stderr);
|
||||
if (err) {
|
||||
return reject(err);
|
||||
}
|
||||
|
||||
return resolve();
|
||||
}
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const dir = "./docs/api";
|
||||
const docFiles = await fs.readdir(dir);
|
||||
|
||||
convertDocFiles(dir, docFiles);
|
||||
|
||||
for (const pkg of packages) {
|
||||
for (const pkgExport of pkg.exports) {
|
||||
const exportDir = `./docs/api/${pkg.main}/${pkgExport}`;
|
||||
const exportDocFiles = await fs.readdir(exportDir);
|
||||
|
||||
convertDocFiles(exportDir, exportDocFiles, `@microsoft/${pkg.main}`, `${pkgExport}.js`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function main() {
|
||||
await Promise.all([copyArticleMarkdown(), buildAPIMarkdown()]);
|
||||
}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче