From f42e9087c0a4240eb3a3f27854c7aca518ed38b5 Mon Sep 17 00:00:00 2001 From: Colin Date: Fri, 14 Oct 2022 11:04:31 -0600 Subject: [PATCH] Conf->config --- .../core/BaseFeatureWidget/BaseFeatureDetail.tsx | 4 ++-- .../models/baseTrackConfig.ts | 4 ++-- .../src/ReferenceSequenceTrack/configSchema.ts | 4 ++-- .../src/createModel/createConfigModel.ts | 4 ++-- .../src/createModel/createConfigModel.ts | 4 ++-- .../src/__snapshots__/jbrowseModel.test.ts.snap | 1 + website/docs/api_guide.md | 14 +++++++------- 7 files changed, 18 insertions(+), 17 deletions(-) diff --git a/packages/core/BaseFeatureWidget/BaseFeatureDetail.tsx b/packages/core/BaseFeatureWidget/BaseFeatureDetail.tsx index b33d338741..d52cd85210 100644 --- a/packages/core/BaseFeatureWidget/BaseFeatureDetail.tsx +++ b/packages/core/BaseFeatureWidget/BaseFeatureDetail.tsx @@ -572,11 +572,11 @@ export const FeatureDetails = (props: { const { pluginManager } = getEnv(model) const session = getSession(model) - const ExtraPanel = pluginManager.evaluateExtensionPoint( + const ExtraPanel = pluginManager?.evaluateExtensionPoint( 'Core-extraFeaturePanel', null, { session, feature, model }, - ) as { name: string; Component: React.FC } + ) as { name: string; Component: React.FC } | undefined return ( Core details diff --git a/packages/core/pluggableElementTypes/models/baseTrackConfig.ts b/packages/core/pluggableElementTypes/models/baseTrackConfig.ts index d53dd820b4..3c9e4643fe 100644 --- a/packages/core/pluggableElementTypes/models/baseTrackConfig.ts +++ b/packages/core/pluggableElementTypes/models/baseTrackConfig.ts @@ -71,11 +71,11 @@ export function createBaseTrackConfig(pluginManager: PluginManager) { }, }), formatAbout: ConfigurationSchema('FormatAbout', { - conf: { + config: { type: 'frozen', description: 'formats configuration object in about dialog', defaultValue: {}, - contextVariable: ['conf'], + contextVariable: ['config'], }, hideUris: { type: 'boolean', diff --git a/plugins/sequence/src/ReferenceSequenceTrack/configSchema.ts b/plugins/sequence/src/ReferenceSequenceTrack/configSchema.ts index 5cfb9b3d8a..3f6c2c8386 100644 --- a/plugins/sequence/src/ReferenceSequenceTrack/configSchema.ts +++ b/plugins/sequence/src/ReferenceSequenceTrack/configSchema.ts @@ -26,11 +26,11 @@ export function createReferenceSeqTrackConfig(pluginManager: PluginManager) { }, formatAbout: ConfigurationSchema('FormatAbout', { - conf: { + config: { type: 'frozen', description: 'formats configuration in about dialog', defaultValue: {}, - contextVariable: ['conf'], + contextVariable: ['config'], }, hideUris: { type: 'boolean', diff --git a/products/jbrowse-react-circular-genome-view/src/createModel/createConfigModel.ts b/products/jbrowse-react-circular-genome-view/src/createModel/createConfigModel.ts index 975f13ba9c..62e4215a04 100644 --- a/products/jbrowse-react-circular-genome-view/src/createModel/createConfigModel.ts +++ b/products/jbrowse-react-circular-genome-view/src/createModel/createConfigModel.ts @@ -39,11 +39,11 @@ export default function createConfigModel( }, }), formatAbout: ConfigurationSchema('FormatAbout', { - conf: { + config: { type: 'frozen', description: 'formats configuration object in about dialog', defaultValue: {}, - contextVariable: ['conf'], + contextVariable: ['config'], }, hideUris: { type: 'boolean', diff --git a/products/jbrowse-react-linear-genome-view/src/createModel/createConfigModel.ts b/products/jbrowse-react-linear-genome-view/src/createModel/createConfigModel.ts index c02c09a0ee..d4aa6be367 100644 --- a/products/jbrowse-react-linear-genome-view/src/createModel/createConfigModel.ts +++ b/products/jbrowse-react-linear-genome-view/src/createModel/createConfigModel.ts @@ -44,11 +44,11 @@ export default function createConfigModel( }, }), formatAbout: ConfigurationSchema('FormatAbout', { - conf: { + config: { type: 'frozen', description: 'formats configuration object in about dialog', defaultValue: {}, - contextVariable: ['conf'], + contextVariable: ['config'], }, hideUris: { type: 'boolean', diff --git a/products/jbrowse-web/src/__snapshots__/jbrowseModel.test.ts.snap b/products/jbrowse-web/src/__snapshots__/jbrowseModel.test.ts.snap index 689613d6a7..9761f530e1 100644 --- a/products/jbrowse-web/src/__snapshots__/jbrowseModel.test.ts.snap +++ b/products/jbrowse-web/src/__snapshots__/jbrowseModel.test.ts.snap @@ -97,6 +97,7 @@ Object { }, ], "formatAbout": Object { + "config": "jexl:{extraField:'important data'}", "hideUris": true, }, "metadata": Object { diff --git a/website/docs/api_guide.md b/website/docs/api_guide.md index 9c345b84ac..81361f3c59 100644 --- a/website/docs/api_guide.md +++ b/website/docs/api_guide.md @@ -276,7 +276,7 @@ used to extend the session model itself with new features type: synchronous -- `conf: Record` - a snapshot of a configuration object that is +- `config: Record` - a snapshot of a configuration object that is displayed in the about dialog ### TrackSelector-multiTrackMenuItems @@ -503,10 +503,10 @@ pluginManager.addToExtensionPoint( ### Extension point footnote -Users that want to add further extension points can do so. The naming system, -"Core-" just refers to the fact that these extension points are from our core -codebase. Plugin developers may choose their own prefix to avoid collisions. +Users that want to add further extension points can do so, by simply calling +`pluginManager.evaluateExtensionPoint('YourCustomNameHere', args1, args2). Then, any code that had used `pluginManager.addToExtensionPoint('YourCustomNameHere', ...) will receive be +evaluated. -``` - -``` +The naming system, "Core-" just refers to the fact that these extension points +are from our core codebase. Plugin developers may choose their own prefix to +avoid collisions.