in repo-scripts/api-documenter/src/plugin/PluginLoader.ts [43:160]
public load(
documenterConfig: DocumenterConfig,
createContext: () => MarkdownDocumenterFeatureContext
): void {
const configFileFolder: string = path.dirname(
documenterConfig.configFilePath
);
for (const configPlugin of documenterConfig.configFile.plugins || []) {
try {
// Look for the package name in the same place as the config file
const resolvedEntryPointPath: string = resolve.sync(
configPlugin.packageName,
{
basedir: configFileFolder
}
);
// Load the package
const entryPoint:
| { apiDocumenterPluginManifest?: IApiDocumenterPluginManifest }
| undefined = require(resolvedEntryPointPath);
if (!entryPoint) {
throw new Error('Invalid entry point');
}
if (!entryPoint.apiDocumenterPluginManifest) {
throw new Error(
`The package is not an API documenter plugin;` +
` the "apiDocumenterPluginManifest" export was not found`
);
}
const manifest: IApiDocumenterPluginManifest =
entryPoint.apiDocumenterPluginManifest;
if (manifest.manifestVersion !== 1000) {
throw new Error(
`The plugin is not compatible with this version of API Documenter;` +
` unsupported manifestVersion`
);
}
const loadedPlugin: ILoadedPlugin = {
packageName: configPlugin.packageName,
manifest
};
const featureDefinitionsByName: Map<string, IFeatureDefinition> =
new Map<string, IFeatureDefinition>();
for (const featureDefinition of manifest.features) {
featureDefinitionsByName.set(
featureDefinition.featureName,
featureDefinition
);
}
for (const featureName of configPlugin.enabledFeatureNames) {
const featureDefinition: IFeatureDefinition | undefined =
featureDefinitionsByName.get(featureName);
if (!featureDefinition) {
throw new Error(
`The plugin ${loadedPlugin.packageName} does not have a feature with name "${featureName}"`
);
}
if (featureDefinition.kind === 'MarkdownDocumenterFeature') {
if (this.markdownDocumenterFeature) {
throw new Error('A MarkdownDocumenterFeature is already loaded');
}
const initialization: PluginFeatureInitialization =
new PluginFeatureInitialization();
initialization._context = createContext();
let markdownDocumenterFeature:
| MarkdownDocumenterFeature
| undefined = undefined;
try {
markdownDocumenterFeature = new featureDefinition.subclass(
initialization
);
} catch (e) {
throw new Error(
`Failed to construct feature subclass:\n` + e.toString()
);
}
if (
!(markdownDocumenterFeature instanceof MarkdownDocumenterFeature)
) {
throw new Error(
'The constructed subclass was not an instance of MarkdownDocumenterFeature'
);
}
try {
markdownDocumenterFeature.onInitialized();
} catch (e) {
throw new Error(
'Error occurred during the onInitialized() event: ' +
e.toString()
);
}
this.markdownDocumenterFeature = markdownDocumenterFeature;
} else {
throw new Error(
`Unknown feature definition kind: "${featureDefinition.kind}"`
);
}
}
} catch (e) {
throw new Error(
`Error loading plugin ${configPlugin.packageName}: ` + e.message
);
}
}
}