fix(docs): update plugin docs (340d0ca2) · Commits · html-validate / html-validate

docs/dev/writing-plugins.md

+4 −4

Original line number	Original line	Diff line number	Diff line
	@@ -14,7 +14,7 @@ export interface Plugin {
	*		*
	* Read-only property set by config.		* Read-only property set by config.
	*/		*/
	name: string;		name?: string;

	/**		/**
	* Initialization callback.		* Initialization callback.
	@@ -43,12 +43,12 @@ export interface Plugin {
	*		*
	* "extends": ["my-plugin:foobar"]		* "extends": ["my-plugin:foobar"]
	*/		*/
	configs: { [key: string]: ConfigData };		configs?: { [key: string]: ConfigData };

	/**		/**
	* List of new rules present.		* List of new rules present.
	*/		*/
	rules: { [key: string]: RuleConstructor };		rules?: { [key: string]: RuleConstructor };

	/**		/**
	* Transformer available in this plugin.		* Transformer available in this plugin.
	@@ -72,7 +72,7 @@ export interface Plugin {
	* "^.*\\.foo$": "my-plugin:foobar"		* "^.*\\.foo$": "my-plugin:foobar"
	* }		* }
	*/		*/
	transformer: Transformer \| Record<string, Transformer>;		transformer?: Transformer \| Record<string, Transformer>;

	/**		/**
	* Extend metadata validation schema.		* Extend metadata validation schema.