fix: improve typings for plugins-manager

Author: bennypowers

.changeset/mean-hornets-visit.md

@@ -0,0 +1,8 @@
+---
+'@rocket/cli': patch
+'@rocket/eleventy-plugin-mdjs-unified': patch
+'@mdjs/core': patch
+'plugins-manager': patch
+---
+
+Improves typings for `addPlugin`

packages/cli/types/main.d.ts

@@ -1,37 +1,23 @@
 import { DevServerConfig } from '@web/dev-server';
 import { CheckHtmlLinksCliOptions } from 'check-html-links/dist-types/types/main';
 import { WatchOptions } from 'chokidar';
-
-export interface RocketPreset {
-  path: string;
-
-  adjustImagePresets?: (preset: { [key: string]: ImagePreset }) => { [key: string]: ImagePreset };
-
-  before11ty?: () => void | Promise<void>;
-
-  // TODO: improve all setup functions
-  setupUnifiedPlugins?: function[];
-  setupDevAndBuildPlugins?: function[];
-  setupBuildPlugins?: function[];
-  setupDevPlugins?: function[];
-  setupCliPlugins?: function[];
-  setupEleventyPlugins?: function[];
-  setupEleventyComputedConfig?: function[];
-}
+export { ImagePreset, RocketPreset } from './preset';
 
 interface RocketStartConfig {
   createSocialMediaImages?: boolean;
 }
 
-type ImageFormat = 'avif' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'svg';
-
-interface ImagePreset {
-  widths: number[];
-  formats: ImageFormat[];
-  sizes: string;
-}
-
-export interface RocketCliOptions {
+type PresetKeys =
+  | 'before11ty'
+  | 'setupUnifiedPlugins'
+  | 'setupDevAndBuildPlugins'
+  | 'setupBuildPlugins'
+  | 'setupDevPlugins'
+  | 'setupCliPlugins'
+  | 'setupEleventyPlugins'
+  | 'setupEleventyComputedConfig';
+
+export interface RocketCliOptions extends Pick<RocketPreset, PresetKeys> {
   presets?: Array<RocketPreset>;
   pathPrefix?: string;
   serviceWorkerName?: string;
@@ -47,21 +33,10 @@ export interface RocketCliOptions {
 
   chokidarConfig?: WatchOptions;
 
-  before11ty?: () => void | Promise<void>;
-
   checkLinks?: Partial<CheckHtmlLinksCliOptions>;
 
   start?: RocketStartConfig;
 
-  // TODO: improve all setup functions
-  setupUnifiedPlugins?: function[];
-  setupDevAndBuildPlugins?: function[];
-  setupBuildPlugins?: function[];
-  setupDevPlugins?: function[];
-  setupCliPlugins?: function[];
-  setupEleventyPlugins?: function[];
-  setupEleventyComputedConfig?: function[];
-
   // advanced
   devServer?: DevServerConfig;
   eleventy?: (eleventyConfig: any) => void; // TODO: improve

packages/cli/types/preset.d.ts

@@ -0,0 +1,29 @@
+import { MetaPlugin } from 'plugins-manager';
+
+type ImageFormat = 'avif' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'svg';
+
+export interface ImagePreset {
+  widths: number[];
+  formats: ImageFormat[];
+  sizes: string;
+}
+
+type ImagePresetHook = (preset: { [key: string]: ImagePreset }) => { [key: string]: ImagePreset };
+
+export interface RocketPreset {
+  path: string;
+
+  adjustImagePresets?: ImagePresetHook;
+
+  /** Hook that runs before rocket starts 11ty. Can be sync or async */
+  before11ty?: () => void | Promise<void>;
+
+  // TODO: improve all setup functions
+  setupUnifiedPlugins?: MetaPlugin[];
+  setupDevAndBuildPlugins?: MetaPlugin[];
+  setupBuildPlugins?: MetaPlugin[];
+  setupDevPlugins?: MetaPlugin[];
+  setupCliPlugins?: MetaPlugin[];
+  setupEleventyPlugins?: MetaPlugin[];
+  setupEleventyComputedConfig?: MetaPlugin[];
+}

packages/eleventy-plugin-mdjs-unified/types/code.d.ts

@@ -1,10 +1,10 @@
 import { MdjsProcessPlugin } from '@mdjs/core';
 import { Node } from 'unist';
 
-export const setupUnifiedPluginsFn: (plugins: MdjsProcessPlugin[]) => MdjsProcessPlugin[];
+export type SetupUnifiedPluginsFn = (plugins: MdjsProcessPlugin[]) => MdjsProcessPlugin[];
 
 export interface EleventyPluginMdjsUnified {
-  setupUnifiedPlugins?: setupUnifiedPluginsFn[];
+  setupUnifiedPlugins?: SetupUnifiedPluginsFn[];
 }
 
 export interface NodeChildren extends Node {

packages/mdjs-core/types/code.d.ts

@@ -1,5 +1,7 @@
 import unified from 'unified';
 
+import { MetaPlugin } from 'plugins-manager';
+
 export type StoryTypes = 'js' | 'html';
 
 export interface MarkdownResult {
@@ -29,8 +31,4 @@ export interface ParseResult {
   };
 }
 
-export interface MdjsProcessPlugin {
-  name: string;
-  plugin: unified.Plugin;
-  options?: unified.Settings;
-}
+export type MdjsProcessPlugin = MetaPlugin<unified.Plugin, unified.Settings>;

packages/plugins-manager/src/addPlugin.js

@@ -1,20 +1,14 @@
 /** @typedef {import('../types/main').MetaPlugin} MetaPlugin */
 
-/**
- * @param {object} options
- * @param {string} options.name
- * @param {any} options.plugin
- * @param {any} [options.options]
- * @param {string} [options.how]
- * @param {string} [options.location]
- */
-export function addPlugin({
-  name,
-  plugin,
-  options = undefined,
-  how = 'after',
-  location = 'bottom',
-}) {
+/** @type {import('../types/main').AddPluginType} */
+export function addPlugin(metaPluginAndOptions) {
+  const {
+    name,
+    plugin,
+    options = undefined,
+    how = 'after',
+    location = 'bottom',
+  } = metaPluginAndOptions;
   /**
    * @param {MetaPlugin[]} plugins
    */

packages/plugins-manager/types/main.d.ts

@@ -1,9 +1,22 @@
-export interface MetaPlugin {
+type AnyFn = (...args: any[]) => any;
+
+export interface MetaPlugin<F = AnyFn> {
   name: string;
-  plugin: any;
-  options?: any;
+  plugin: F extends (options?: infer O) => P ? F : any;
+  options?: F extends (options: infer O) => P ? O : any;
 }
 
 export interface MetaPluginWrapable extends MetaPlugin {
   __noWrap?: boolean;
 }
+
+interface AddPluginOptions {
+  how?: 'after' | 'before' | 'fixed';
+  location?: 'top' | 'bottom' | string;
+}
+
+type AddPluginFn = (plugins: MetaPlugin[]) => MetaPlugin[];
+
+export type AddPluginType = <F>(
+  metaPluginAndOptions: MetaPlugin<F> & AddPluginOptions,
+) => AddPluginFn;