Convert citation into a keyed plugin (#522)

* Convert citation into a keyed plugin * linting * linting 2 --------- Co-authored-by: Arne Bertrand <[email protected]>
lblod · Dec 18, 2024 · 2332962 · 2332962
1 parent 3188ea3
commit 2332962
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 9 deletions.
diff --git a/.changeset/popular-countries-listen.md b/.changeset/popular-countries-listen.md
@@ -0,0 +1,5 @@
+---
+'@lblod/ember-rdfa-editor-lblod-plugins': patch
+---
+
+Convert citation into a keyed plugin
diff --git a/addon/components/citation-plugin/citation-card.ts b/addon/components/citation-plugin/citation-card.ts
@@ -11,11 +11,12 @@ import {
 } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/option';
 import {
   CitationDecoration,
-  CitationPlugin,
   CitationPluginEmberComponentConfig,
+  CitationPluginState,
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 import {
   DecorationSet,
+  PluginKey,
   SayController,
   Transaction,
 } from '@lblod/ember-rdfa-editor';
@@ -32,10 +33,10 @@ import {
 } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/legal-documents';
 import { cleanCaches } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin/utils/cache';
 import { SearchIcon } from '@appuniversum/ember-appuniversum/components/icons/search';
+import { citationPluginKey } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/citation-plugin';
 
 interface Args {
   controller: SayController;
-  plugin: CitationPlugin;
   config: CitationPluginEmberComponentConfig;
 }
 
@@ -76,8 +77,8 @@ export default class CitationCardComponent extends Component<Args> {
     return !this.controller.inEmbeddedView && this.activeDecoration;
   }
 
-  get plugin() {
-    return this.args.plugin;
+  get plugin(): PluginKey<CitationPluginState> {
+    return citationPluginKey;
   }
 
   get config() {

diff --git a/addon/components/citation-plugin/citations/legal-document-detail.ts b/addon/components/citation-plugin/citations/legal-document-detail.ts
@@ -58,8 +58,6 @@ export default class LegalDocumentDetailComponent extends Component<Args> {
       });
       this.totalCount = results.totalCount;
 
-      console.log({ result: results.articles });
-
       return results.articles;
     } catch (e) {
       console.warn(e); // eslint-ignore-line no-console

diff --git a/addon/plugins/citation-plugin/index.ts b/addon/plugins/citation-plugin/index.ts
@@ -9,6 +9,7 @@ import {
   ProsePlugin,
   ResolvedPos,
   Schema,
+  PluginKey,
 } from '@lblod/ember-rdfa-editor';
 import processMatch, {
   RegexpMatchArrayWithIndices,
@@ -112,7 +113,7 @@ export interface CitationDecoration extends Decoration {
   spec: CitationDecorationSpec;
 }
 
-interface CitationPluginState {
+export interface CitationPluginState {
   highlights: DecorationSet;
   activeRanges: [number, number][];
 }
@@ -153,8 +154,13 @@ export type CitationPluginEmberComponentConfig = CitationPluginConfig & {
   defaultDecisionsGovernmentName?: string;
 };
 
+export const citationPluginKey: PluginKey<CitationPluginState> = new PluginKey(
+  'say-citation-plugin',
+);
+
 export function citationPlugin(config: CitationPluginConfig): CitationPlugin {
   const citation: CitationPlugin = new ProsePlugin({
+    key: citationPluginKey,
     state: {
       init(stateConfig: EditorStateConfig, state: EditorState) {
         return calculateCitationPluginState(state, config);

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/dummy/app/templates/besluit-sample.hbs b/tests/dummy/app/templates/besluit-sample.hbs
@@ -147,7 +147,6 @@
               />
               <CitationPlugin::CitationCard
                 @controller={{this.controller}}
-                @plugin={{this.citationPlugin}}
                 @config={{this.config.citation}}
               />
               <ImportSnippetPlugin::Card @controller={{this.controller}} />