@enjoys/context-engine 1.4.1 → 1.4.2

package/data/signatureHelp/react.json

@@ -1,281 +1,285 @@
-{
-  "language": "react",
-  "signatureHelp": {
-    "triggerCharacters": ["(", ",", "<"],
-    "retriggerCharacters": [","],
-    "signatures": [
-      {
-        "label": "useState<S>(initialState: S | (() => S)): [S, Dispatch<SetStateAction<S>>]",
-        "documentation": "Returns a stateful value and a function to update it. During the initial render, the returned state is the same as the value passed as the first argument. The setState function accepts a new state value or a function that receives the previous state.",
-        "parameters": [
-          {
-            "label": "initialState: S | (() => S)",
-            "documentation": "The value used for the initial state. Can also be a function that returns the initial state (lazy initialization)."
-          }
-        ]
-      },
-      {
-        "label": "useEffect(effect: EffectCallback, deps?: DependencyList): void",
-        "documentation": "Accepts a function that contains imperative, possibly effectful code. Runs the effect after every completed render unless a dependency array is provided.",
-        "parameters": [
-          {
-            "label": "effect: EffectCallback",
-            "documentation": "The effect function to run. May return a cleanup function."
-          },
-          {
-            "label": "deps?: DependencyList",
-            "documentation": "Optional array of dependencies. Effect re-runs only when dependencies change."
-          }
-        ]
-      },
-      {
-        "label": "useContext<T>(context: Context<T>): T",
-        "documentation": "Accepts a context object (the value returned from React.createContext) and returns the current context value. The current context value is determined by the nearest Provider above.",
-        "parameters": [
-          {
-            "label": "context: Context<T>",
-            "documentation": "Context object created by React.createContext."
-          }
-        ]
-      },
-      {
-        "label": "useReducer<R>(reducer: R, initialState: ReducerState<R>, init?: (initial: ReducerState<R>) => ReducerState<R>): [ReducerState<R>, Dispatch<ReducerAction<R>>]",
-        "documentation": "An alternative to useState. Accepts a reducer of type (state, action) => newState, and returns the current state paired with a dispatch method.",
-        "parameters": [
-          {
-            "label": "reducer: R",
-            "documentation": "A function of type (state, action) => newState."
-          },
-          {
-            "label": "initialState: ReducerState<R>",
-            "documentation": "Initial state value for the reducer."
-          },
-          {
-            "label": "init?: (initial: ReducerState<R>) => ReducerState<R>",
-            "documentation": "Optional lazy initializer function."
-          }
-        ]
-      },
-      {
-        "label": "useMemo<T>(factory: () => T, deps: DependencyList): T",
-        "documentation": "Returns a memoized value. Pass a \"create\" function and an array of dependencies. useMemo will only recompute the memoized value when one of the dependencies has changed.",
-        "parameters": [
-          {
-            "label": "factory: () => T",
-            "documentation": "Function that computes and returns the memoized value."
-          },
-          {
-            "label": "deps: DependencyList",
-            "documentation": "Array of dependencies that trigger recomputation."
-          }
-        ]
-      },
-      {
-        "label": "useCallback<T extends Function>(callback: T, deps: DependencyList): T",
-        "documentation": "Returns a memoized callback. Pass an inline callback and an array of dependencies. useCallback will return a memoized version of the callback that only changes if one of the dependencies has changed.",
-        "parameters": [
-          {
-            "label": "callback: T",
-            "documentation": "The callback function to memoize."
-          },
-          {
-            "label": "deps: DependencyList",
-            "documentation": "Array of dependencies that trigger re-creation of the callback."
-          }
-        ]
-      },
-      {
-        "label": "useRef<T>(initialValue: T): MutableRefObject<T>",
-        "documentation": "Returns a mutable ref object whose .current property is initialized to the passed argument. The returned object will persist for the full lifetime of the component.",
-        "parameters": [
-          {
-            "label": "initialValue: T",
-            "documentation": "Initial value for the ref's .current property. Commonly null for DOM refs."
-          }
-        ]
-      },
-      {
-        "label": "useImperativeHandle<T, R>(ref: Ref<T>, createHandle: () => R, deps?: DependencyList): void",
-        "documentation": "Customizes the instance value that is exposed to parent components when using ref. Should be used with forwardRef.",
-        "parameters": [
-          {
-            "label": "ref: Ref<T>",
-            "documentation": "The ref forwarded from a parent component."
-          },
-          {
-            "label": "createHandle: () => R",
-            "documentation": "Function returning the handle object to expose."
-          },
-          {
-            "label": "deps?: DependencyList",
-            "documentation": "Optional dependency array for recomputing the handle."
-          }
-        ]
-      },
-      {
-        "label": "useLayoutEffect(effect: EffectCallback, deps?: DependencyList): void",
-        "documentation": "The signature is identical to useEffect, but it fires synchronously after all DOM mutations. Use this to read layout from the DOM and synchronously re-render.",
-        "parameters": [
-          {
-            "label": "effect: EffectCallback",
-            "documentation": "Effect function that runs synchronously after DOM mutations."
-          },
-          {
-            "label": "deps?: DependencyList",
-            "documentation": "Optional dependency array."
-          }
-        ]
-      },
-      {
-        "label": "useDebugValue<T>(value: T, format?: (value: T) => any): void",
-        "documentation": "Used to display a label for custom hooks in React DevTools. Optionally accepts a formatting function.",
-        "parameters": [
-          {
-            "label": "value: T",
-            "documentation": "The debug value to display."
-          },
-          {
-            "label": "format?: (value: T) => any",
-            "documentation": "Optional formatting function for expensive computations."
-          }
-        ]
-      },
-      {
-        "label": "useDeferredValue<T>(value: T): T",
-        "documentation": "Accepts a value and returns a deferred version of it that may lag behind the original. Useful for deferring expensive re-renders.",
-        "parameters": [
-          {
-            "label": "value: T",
-            "documentation": "The value to defer."
-          }
-        ]
-      },
-      {
-        "label": "useSyncExternalStore<T>(subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => T, getServerSnapshot?: () => T): T",
-        "documentation": "Subscribe to an external store. Returns the current snapshot of the store's state.",
-        "parameters": [
-          {
-            "label": "subscribe: (onStoreChange: () => void) => () => void",
-            "documentation": "Function to subscribe to the store. Returns an unsubscribe function."
-          },
-          {
-            "label": "getSnapshot: () => T",
-            "documentation": "Function that returns the current snapshot of the store."
-          },
-          {
-            "label": "getServerSnapshot?: () => T",
-            "documentation": "Optional function returning snapshot for server rendering."
-          }
-        ]
-      },
-      {
-        "label": "useInsertionEffect(effect: EffectCallback, deps?: DependencyList): void",
-        "documentation": "Fires synchronously before all DOM mutations. Used for injecting styles into the DOM before layout effects read them.",
-        "parameters": [
-          {
-            "label": "effect: EffectCallback",
-            "documentation": "Effect for injecting styles or similar pre-layout operations."
-          },
-          {
-            "label": "deps?: DependencyList",
-            "documentation": "Optional dependency array."
-          }
-        ]
-      },
-      {
-        "label": "createContext<T>(defaultValue: T): Context<T>",
-        "documentation": "Creates a Context object. When React renders a component that subscribes to this Context object, it will read the current value from the closest matching Provider.",
-        "parameters": [
-          {
-            "label": "defaultValue: T",
-            "documentation": "The default value used when no Provider is found above in the tree."
-          }
-        ]
-      },
-      {
-        "label": "createElement(type: string | ComponentType, props?: object, ...children: ReactNode[]): ReactElement",
-        "documentation": "Create and return a new React element of the given type. Type can be a tag name string or a React component type.",
-        "parameters": [
-          {
-            "label": "type: string | ComponentType",
-            "documentation": "HTML tag name or React component."
-          },
-          {
-            "label": "props?: object",
-            "documentation": "Props to pass to the element."
-          },
-          {
-            "label": "...children: ReactNode[]",
-            "documentation": "Child elements."
-          }
-        ]
-      },
-      {
-        "label": "memo<P>(Component: FunctionComponent<P>, areEqual?: (prev: Readonly<P>, next: Readonly<P>) => boolean): NamedExoticComponent<P>",
-        "documentation": "If your component renders the same result given the same props, wrap it in React.memo for a performance boost by memoizing the result.",
-        "parameters": [
-          {
-            "label": "Component: FunctionComponent<P>",
-            "documentation": "The component to memoize."
-          },
-          {
-            "label": "areEqual?: (prev: Readonly<P>, next: Readonly<P>) => boolean",
-            "documentation": "Optional custom comparison function. Defaults to shallow comparison."
-          }
-        ]
-      },
-      {
-        "label": "forwardRef<T, P>(render: ForwardRefRenderFunction<T, P>): ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>",
-        "documentation": "Creates a component that forwards ref to a child. Useful for passing refs to DOM elements or class components inside function components.",
-        "parameters": [
-          {
-            "label": "render: ForwardRefRenderFunction<T, P>",
-            "documentation": "Render function that receives props and ref as arguments."
-          }
-        ]
-      },
-      {
-        "label": "lazy<T extends ComponentType<any>>(factory: () => Promise<{ default: T }>): LazyExoticComponent<T>",
-        "documentation": "Lets you define a component that is loaded dynamically. Helps reduce bundle size by code-splitting components that aren't needed during initial render.",
-        "parameters": [
-          {
-            "label": "factory: () => Promise<{ default: T }>",
-            "documentation": "Function returning a dynamic import() of a module with a default export."
-          }
-        ]
-      },
-      {
-        "label": "createPortal(children: ReactNode, container: Element, key?: string): ReactPortal",
-        "documentation": "Creates a portal. Portals provide a way to render children into a DOM node that exists outside the parent component's DOM hierarchy.",
-        "parameters": [
-          {
-            "label": "children: ReactNode",
-            "documentation": "The React elements to render."
-          },
-          {
-            "label": "container: Element",
-            "documentation": "The DOM element to render into."
-          },
-          {
-            "label": "key?: string",
-            "documentation": "Optional unique key for the portal."
-          }
-        ]
-      },
-      {
-        "label": "createRoot(container: Element | DocumentFragment, options?: RootOptions): Root",
-        "documentation": "Create a React root for a browser DOM element. Use it to display React content inside a browser DOM element. After creating a root, call root.render() to display a React component inside it.",
-        "parameters": [
-          {
-            "label": "container: Element | DocumentFragment",
-            "documentation": "The DOM element to mount the React application into."
-          },
-          {
-            "label": "options?: RootOptions",
-            "documentation": "Optional configuration for the root (identifierPrefix, onRecoverableError, etc.)."
-          }
-        ]
-      }
-    ]
-  }
-}
+{
+  "language": "react",
+  "triggerCharacters": [
+    "(",
+    ",",
+    "<"
+  ],
+  "retriggerCharacters": [
+    ","
+  ],
+  "signatures": [
+    {
+      "label": "useState<S>(initialState: S | (() => S)): [S, Dispatch<SetStateAction<S>>]",
+      "documentation": "Returns a stateful value and a function to update it. During the initial render, the returned state is the same as the value passed as the first argument. The setState function accepts a new state value or a function that receives the previous state.",
+      "parameters": [
+        {
+          "label": "initialState: S | (() => S)",
+          "documentation": "The value used for the initial state. Can also be a function that returns the initial state (lazy initialization)."
+        }
+      ]
+    },
+    {
+      "label": "useEffect(effect: EffectCallback, deps?: DependencyList): void",
+      "documentation": "Accepts a function that contains imperative, possibly effectful code. Runs the effect after every completed render unless a dependency array is provided.",
+      "parameters": [
+        {
+          "label": "effect: EffectCallback",
+          "documentation": "The effect function to run. May return a cleanup function."
+        },
+        {
+          "label": "deps?: DependencyList",
+          "documentation": "Optional array of dependencies. Effect re-runs only when dependencies change."
+        }
+      ]
+    },
+    {
+      "label": "useContext<T>(context: Context<T>): T",
+      "documentation": "Accepts a context object (the value returned from React.createContext) and returns the current context value. The current context value is determined by the nearest Provider above.",
+      "parameters": [
+        {
+          "label": "context: Context<T>",
+          "documentation": "Context object created by React.createContext."
+        }
+      ]
+    },
+    {
+      "label": "useReducer<R>(reducer: R, initialState: ReducerState<R>, init?: (initial: ReducerState<R>) => ReducerState<R>): [ReducerState<R>, Dispatch<ReducerAction<R>>]",
+      "documentation": "An alternative to useState. Accepts a reducer of type (state, action) => newState, and returns the current state paired with a dispatch method.",
+      "parameters": [
+        {
+          "label": "reducer: R",
+          "documentation": "A function of type (state, action) => newState."
+        },
+        {
+          "label": "initialState: ReducerState<R>",
+          "documentation": "Initial state value for the reducer."
+        },
+        {
+          "label": "init?: (initial: ReducerState<R>) => ReducerState<R>",
+          "documentation": "Optional lazy initializer function."
+        }
+      ]
+    },
+    {
+      "label": "useMemo<T>(factory: () => T, deps: DependencyList): T",
+      "documentation": "Returns a memoized value. Pass a \"create\" function and an array of dependencies. useMemo will only recompute the memoized value when one of the dependencies has changed.",
+      "parameters": [
+        {
+          "label": "factory: () => T",
+          "documentation": "Function that computes and returns the memoized value."
+        },
+        {
+          "label": "deps: DependencyList",
+          "documentation": "Array of dependencies that trigger recomputation."
+        }
+      ]
+    },
+    {
+      "label": "useCallback<T extends Function>(callback: T, deps: DependencyList): T",
+      "documentation": "Returns a memoized callback. Pass an inline callback and an array of dependencies. useCallback will return a memoized version of the callback that only changes if one of the dependencies has changed.",
+      "parameters": [
+        {
+          "label": "callback: T",
+          "documentation": "The callback function to memoize."
+        },
+        {
+          "label": "deps: DependencyList",
+          "documentation": "Array of dependencies that trigger re-creation of the callback."
+        }
+      ]
+    },
+    {
+      "label": "useRef<T>(initialValue: T): MutableRefObject<T>",
+      "documentation": "Returns a mutable ref object whose .current property is initialized to the passed argument. The returned object will persist for the full lifetime of the component.",
+      "parameters": [
+        {
+          "label": "initialValue: T",
+          "documentation": "Initial value for the ref's .current property. Commonly null for DOM refs."
+        }
+      ]
+    },
+    {
+      "label": "useImperativeHandle<T, R>(ref: Ref<T>, createHandle: () => R, deps?: DependencyList): void",
+      "documentation": "Customizes the instance value that is exposed to parent components when using ref. Should be used with forwardRef.",
+      "parameters": [
+        {
+          "label": "ref: Ref<T>",
+          "documentation": "The ref forwarded from a parent component."
+        },
+        {
+          "label": "createHandle: () => R",
+          "documentation": "Function returning the handle object to expose."
+        },
+        {
+          "label": "deps?: DependencyList",
+          "documentation": "Optional dependency array for recomputing the handle."
+        }
+      ]
+    },
+    {
+      "label": "useLayoutEffect(effect: EffectCallback, deps?: DependencyList): void",
+      "documentation": "The signature is identical to useEffect, but it fires synchronously after all DOM mutations. Use this to read layout from the DOM and synchronously re-render.",
+      "parameters": [
+        {
+          "label": "effect: EffectCallback",
+          "documentation": "Effect function that runs synchronously after DOM mutations."
+        },
+        {
+          "label": "deps?: DependencyList",
+          "documentation": "Optional dependency array."
+        }
+      ]
+    },
+    {
+      "label": "useDebugValue<T>(value: T, format?: (value: T) => any): void",
+      "documentation": "Used to display a label for custom hooks in React DevTools. Optionally accepts a formatting function.",
+      "parameters": [
+        {
+          "label": "value: T",
+          "documentation": "The debug value to display."
+        },
+        {
+          "label": "format?: (value: T) => any",
+          "documentation": "Optional formatting function for expensive computations."
+        }
+      ]
+    },
+    {
+      "label": "useDeferredValue<T>(value: T): T",
+      "documentation": "Accepts a value and returns a deferred version of it that may lag behind the original. Useful for deferring expensive re-renders.",
+      "parameters": [
+        {
+          "label": "value: T",
+          "documentation": "The value to defer."
+        }
+      ]
+    },
+    {
+      "label": "useSyncExternalStore<T>(subscribe: (onStoreChange: () => void) => () => void, getSnapshot: () => T, getServerSnapshot?: () => T): T",
+      "documentation": "Subscribe to an external store. Returns the current snapshot of the store's state.",
+      "parameters": [
+        {
+          "label": "subscribe: (onStoreChange: () => void) => () => void",
+          "documentation": "Function to subscribe to the store. Returns an unsubscribe function."
+        },
+        {
+          "label": "getSnapshot: () => T",
+          "documentation": "Function that returns the current snapshot of the store."
+        },
+        {
+          "label": "getServerSnapshot?: () => T",
+          "documentation": "Optional function returning snapshot for server rendering."
+        }
+      ]
+    },
+    {
+      "label": "useInsertionEffect(effect: EffectCallback, deps?: DependencyList): void",
+      "documentation": "Fires synchronously before all DOM mutations. Used for injecting styles into the DOM before layout effects read them.",
+      "parameters": [
+        {
+          "label": "effect: EffectCallback",
+          "documentation": "Effect for injecting styles or similar pre-layout operations."
+        },
+        {
+          "label": "deps?: DependencyList",
+          "documentation": "Optional dependency array."
+        }
+      ]
+    },
+    {
+      "label": "createContext<T>(defaultValue: T): Context<T>",
+      "documentation": "Creates a Context object. When React renders a component that subscribes to this Context object, it will read the current value from the closest matching Provider.",
+      "parameters": [
+        {
+          "label": "defaultValue: T",
+          "documentation": "The default value used when no Provider is found above in the tree."
+        }
+      ]
+    },
+    {
+      "label": "createElement(type: string | ComponentType, props?: object, ...children: ReactNode[]): ReactElement",
+      "documentation": "Create and return a new React element of the given type. Type can be a tag name string or a React component type.",
+      "parameters": [
+        {
+          "label": "type: string | ComponentType",
+          "documentation": "HTML tag name or React component."
+        },
+        {
+          "label": "props?: object",
+          "documentation": "Props to pass to the element."
+        },
+        {
+          "label": "...children: ReactNode[]",
+          "documentation": "Child elements."
+        }
+      ]
+    },
+    {
+      "label": "memo<P>(Component: FunctionComponent<P>, areEqual?: (prev: Readonly<P>, next: Readonly<P>) => boolean): NamedExoticComponent<P>",
+      "documentation": "If your component renders the same result given the same props, wrap it in React.memo for a performance boost by memoizing the result.",
+      "parameters": [
+        {
+          "label": "Component: FunctionComponent<P>",
+          "documentation": "The component to memoize."
+        },
+        {
+          "label": "areEqual?: (prev: Readonly<P>, next: Readonly<P>) => boolean",
+          "documentation": "Optional custom comparison function. Defaults to shallow comparison."
+        }
+      ]
+    },
+    {
+      "label": "forwardRef<T, P>(render: ForwardRefRenderFunction<T, P>): ForwardRefExoticComponent<PropsWithoutRef<P> & RefAttributes<T>>",
+      "documentation": "Creates a component that forwards ref to a child. Useful for passing refs to DOM elements or class components inside function components.",
+      "parameters": [
+        {
+          "label": "render: ForwardRefRenderFunction<T, P>",
+          "documentation": "Render function that receives props and ref as arguments."
+        }
+      ]
+    },
+    {
+      "label": "lazy<T extends ComponentType<any>>(factory: () => Promise<{ default: T }>): LazyExoticComponent<T>",
+      "documentation": "Lets you define a component that is loaded dynamically. Helps reduce bundle size by code-splitting components that aren't needed during initial render.",
+      "parameters": [
+        {
+          "label": "factory: () => Promise<{ default: T }>",
+          "documentation": "Function returning a dynamic import() of a module with a default export."
+        }
+      ]
+    },
+    {
+      "label": "createPortal(children: ReactNode, container: Element, key?: string): ReactPortal",
+      "documentation": "Creates a portal. Portals provide a way to render children into a DOM node that exists outside the parent component's DOM hierarchy.",
+      "parameters": [
+        {
+          "label": "children: ReactNode",
+          "documentation": "The React elements to render."
+        },
+        {
+          "label": "container: Element",
+          "documentation": "The DOM element to render into."
+        },
+        {
+          "label": "key?: string",
+          "documentation": "Optional unique key for the portal."
+        }
+      ]
+    },
+    {
+      "label": "createRoot(container: Element | DocumentFragment, options?: RootOptions): Root",
+      "documentation": "Create a React root for a browser DOM element. Use it to display React content inside a browser DOM element. After creating a root, call root.render() to display a React component inside it.",
+      "parameters": [
+        {
+          "label": "container: Element | DocumentFragment",
+          "documentation": "The DOM element to mount the React application into."
+        },
+        {
+          "label": "options?: RootOptions",
+          "documentation": "Optional configuration for the root (identifierPrefix, onRecoverableError, etc.)."
+        }
+      ]
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enjoys/context-engine",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Comprehensive CLI command context engine with 135 tools — subcommands, options, examples, and runtime context detectors for intelligent terminal autocomplete",
   "main": "index.js",
   "types": "index.d.ts",