Class HighlightSourcePlugin

Example

import {IArgdownRequest, IArgdownResponse, IArgdownPlugin, IRequestHandler, IRuleTokenHandler, ArgdownPluginError, RuleNames} from "@argdown/core";

export interface IGreetingSettings{
 addHello?:boolean;
}
// We augment the request and response types from @argdown/core
// to add our plugin settings and data:
declare module "@argdown/core"{
 interface IArgdownRequest{
   greeting?:IGreetingSettings;
 }
 interface IArgdownResponse{
   greeting:string;
 }
}

export class GreetingPlugin implements IArgdownPlugin{
 name = "GreetingPlugin";
 prepare:IRequestHandler = (request, response)=>{
   // check if requirements are met
   if(!response.ast){
     throw new ArgdownPluginError(this.name, "No ast found in response.");
   }
   // create default settings
   if(!request.greeting){
     request.greeting = {};
   }
   if(request.greeting.sayHello === undefined){
     request.greeting.sayHello = true;
   }
 };
 run:IRequestHandler = (request, response)=>{
   if(request.greeting && request.greeting.addHello){
     // adding data to response object
     response.greeting = "Hallo World!";
   }
 };
 ruleListeners = {
   [RuleNames.STATEMENT + "Entry"]: (request, response, node, parentNode, childIndex, logger)=>{
     // use the logger parameter instead of console.log
     logger.log("verbose", `Statement: ${node.statement.text}`);
   }
 }
}
Copy