refactor: Improve JS object naming

Author: NeedleInAJayStack

src/components/ConfigEditor.tsx

@@ -1,9 +1,9 @@
 import React, { ChangeEvent } from 'react';
 import { InlineField, Input, SecretInput } from '@grafana/ui';
 import { DataSourcePluginOptionsEditorProps } from '@grafana/data';
-import { MyDataSourceOptions, MySecureJsonData } from '../types';
+import { HaystackDataSourceOptions, HaystackSecureJsonData } from '../types';
 
-interface Props extends DataSourcePluginOptionsEditorProps<MyDataSourceOptions> {}
+interface Props extends DataSourcePluginOptionsEditorProps<HaystackDataSourceOptions> {}
 
 export function ConfigEditor(props: Props) {
   const { onOptionsChange, options } = props;
@@ -48,7 +48,7 @@ export function ConfigEditor(props: Props) {
   };
 
   const { jsonData, secureJsonFields } = options;
-  const secureJsonData = (options.secureJsonData || {}) as MySecureJsonData;
+  const secureJsonData = (options.secureJsonData || {}) as HaystackSecureJsonData;
 
   return (
     <div className="gf-form-group">

src/components/QueryEditor.tsx

@@ -2,9 +2,9 @@ import React, { ChangeEvent, ReactNode } from 'react';
 import { Button, Field, Form, Icon, InlineField, Input, Select } from '@grafana/ui';
 import { QueryEditorProps, SelectableValue } from '@grafana/data';
 import { DataSource } from '../datasource';
-import { DEFAULT_QUERY, MyDataSourceOptions, MyQuery } from '../types';
+import { DEFAULT_QUERY, HaystackDataSourceOptions, HaystackQuery } from '../types';
 
-type Props = QueryEditorProps<DataSource, MyQuery, MyDataSourceOptions>;
+type Props = QueryEditorProps<DataSource, HaystackQuery, HaystackDataSourceOptions>;
 
 export function QueryEditor({ query, onChange, onRunQuery }: Props) {
   const onTypeChange = (event: SelectableValue<number>) => {
@@ -78,7 +78,7 @@ export function QueryEditor({ query, onChange, onRunQuery }: Props) {
     return <p>Select a query type</p>
   }
 
-  function onSubmit(newQuery: Partial<MyQuery>) {
+  function onSubmit(newQuery: Partial<HaystackQuery>) {
     query = { ...query, ...newQuery }
     onRunQuery();
   }
@@ -88,11 +88,10 @@ export function QueryEditor({ query, onChange, onRunQuery }: Props) {
       <Form
         onSubmit={onSubmit}
       >{({register, errors}) => {
-        let queryComponent = renderQuery();
         return (
           <div>
             <SelectComponent/>
-            {queryComponent}
+            {renderQuery()}
             <Button type="submit">Run</Button>
           </div>
         )

src/datasource.ts

@@ -1,14 +1,14 @@
 import { DataSourceInstanceSettings, CoreApp } from '@grafana/data';
 import { DataSourceWithBackend } from '@grafana/runtime';
 
-import { MyQuery, MyDataSourceOptions, DEFAULT_QUERY } from './types';
+import { HaystackQuery, HaystackDataSourceOptions, DEFAULT_QUERY } from './types';
 
-export class DataSource extends DataSourceWithBackend<MyQuery, MyDataSourceOptions> {
-  constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) {
+export class DataSource extends DataSourceWithBackend<HaystackQuery, HaystackDataSourceOptions> {
+  constructor(instanceSettings: DataSourceInstanceSettings<HaystackDataSourceOptions>) {
     super(instanceSettings);
   }
 
-  getDefaultQuery(_: CoreApp): Partial<MyQuery> {
+  getDefaultQuery(_: CoreApp): Partial<HaystackQuery> {
     return DEFAULT_QUERY
   }
 }

src/module.ts

@@ -2,8 +2,8 @@ import { DataSourcePlugin } from '@grafana/data';
 import { DataSource } from './datasource';
 import { ConfigEditor } from './components/ConfigEditor';
 import { QueryEditor } from './components/QueryEditor';
-import { MyQuery, MyDataSourceOptions } from './types';
+import { HaystackQuery, HaystackDataSourceOptions } from './types';
 
-export const plugin = new DataSourcePlugin<DataSource, MyQuery, MyDataSourceOptions>(DataSource)
+export const plugin = new DataSourcePlugin<DataSource, HaystackQuery, HaystackDataSourceOptions>(DataSource)
   .setConfigEditor(ConfigEditor)
   .setQueryEditor(QueryEditor);

src/types.ts

@@ -1,13 +1,13 @@
 import { DataQuery, DataSourceJsonData } from '@grafana/data';
 
-export interface MyQuery extends DataQuery {
+export interface HaystackQuery extends DataQuery {
   type: string; // Defines the type of query that should be executed
   eval: string;
   hisRead: string;
   read: string;
 }
 
-export const DEFAULT_QUERY: Partial<MyQuery> = {
+export const DEFAULT_QUERY: Partial<HaystackQuery> = {
   type: "Eval",
   eval: "[{ts: $__timeRange_start, v0: 0}, {ts: $__timeRange_end, v0: 10}].toGrid",
   hisRead: "abcdef-123456",
@@ -17,14 +17,14 @@ export const DEFAULT_QUERY: Partial<MyQuery> = {
 /**
  * These are options configured for each DataSource instance
  */
-export interface MyDataSourceOptions extends DataSourceJsonData {
+export interface HaystackDataSourceOptions extends DataSourceJsonData {
   url: string;
   username: string;
 }
 
 /**
  * Value that is used in the backend, but never sent over HTTP to the frontend
  */
-export interface MySecureJsonData {
+export interface HaystackSecureJsonData {
   password: string;
 }