Conf->config

GMOD · Oct 15, 2022 · f42e908 · f42e908
1 parent a0677df
commit f42e908
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 17 deletions.
diff --git 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<any> }
+  ) as { name: string; Component: React.FC<any> } | undefined
   return (
     <BaseCard title={generateTitle(name, id, type)}>
       <Typography>Core details</Typography>

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -276,7 +276,7 @@ used to extend the session model itself with new features
 
 type: synchronous
 
-- `conf: Record<string,unknown>` - a snapshot of a configuration object that is
+- `config: Record<string,unknown>` - 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.