linting

Author: AbanoubGhadban

knip.ts

@@ -39,7 +39,7 @@ const config: KnipConfig = {
 
     // React on Rails core package workspace
     'packages/react-on-rails': {
-      entry: ['src/ReactOnRails.node.ts!'],
+      entry: ['src/ReactOnRails.full.ts!', 'src/ReactOnRails.client.ts!'],
       project: ['src/**/*.[jt]s{x,}!', 'tests/**/*.[jt]s{x,}', '!lib/**'],
       ignore: [
         // Jest setup and test utilities - not detected by Jest plugin in workspace setup

packages/react-on-rails-pro/src/ComponentRegistry.ts

@@ -20,6 +20,7 @@ const componentRegistry = new CallbackRegistry<RegisteredComponent>('component')
 
 /**
  * @param components { component1: component1, component2: component2, etc. }
+ * @public
  */
 export function register(components: Record<string, ReactComponentOrRenderFunction>): void {
   Object.keys(components).forEach((name) => {
@@ -57,6 +58,7 @@ export const getOrWaitForComponent = (name: string): Promise<RegisteredComponent
  * Get a Map containing all registered components. Useful for debugging.
  * @returns Map where key is the component name and values are the
  * { name, component, renderFunction, isRenderer}
+ * @public
  */
 export const components = (): Map<string, RegisteredComponent> => componentRegistry.getAll();
 

packages/react-on-rails-pro/src/StoreRegistry.ts

@@ -21,6 +21,7 @@ const hydratedStoreRegistry = new CallbackRegistry<Store>('hydrated store');
 /**
  * Register a store generator, a function that takes props and returns a store.
  * @param storeGenerators { name1: storeGenerator1, name2: storeGenerator2 }
+ * @public
  */
 export function register(storeGenerators: Record<string, StoreGenerator>): void {
   Object.keys(storeGenerators).forEach((name) => {
@@ -46,6 +47,7 @@ export function register(storeGenerators: Record<string, StoreGenerator>): void
  * @param throwIfMissing Defaults to true. Set to false to have this call return undefined if
  *        there is no store with the given name.
  * @returns Redux Store, possibly hydrated
+ * @public
  */
 export function getStore(name: string, throwIfMissing = true): Store | undefined {
   try {
@@ -71,6 +73,7 @@ This can happen if you are server rendering and either:
  * Internally used function to get the store creator that was passed to `register`.
  * @param name
  * @returns storeCreator with given name
+ * @public
  */
 export const getStoreGenerator = (name: string): StoreGenerator => storeGeneratorRegistry.get(name);
 
@@ -85,6 +88,7 @@ export function setStore(name: string, store: Store): void {
 
 /**
  * Internally used function to completely clear hydratedStores Map.
+ * @public
  */
 export function clearHydratedStores(): void {
   hydratedStoreRegistry.clear();
@@ -93,12 +97,14 @@ export function clearHydratedStores(): void {
 /**
  * Get a Map containing all registered store generators. Useful for debugging.
  * @returns Map where key is the component name and values are the store generators.
+ * @public
  */
 export const storeGenerators = (): Map<string, StoreGenerator> => storeGeneratorRegistry.getAll();
 
 /**
  * Get a Map containing all hydrated stores. Useful for debugging.
  * @returns Map where key is the component name and values are the hydrated stores.
+ * @public
  */
 export const stores = (): Map<string, Store> => hydratedStoreRegistry.getAll();
 

packages/react-on-rails-pro/src/createReactOnRailsPro.ts

@@ -144,13 +144,15 @@ export default function createReactOnRailsPro(
   const reactOnRailsPro = baseObject as unknown as ReactOnRailsInternal;
 
   if (reactOnRailsPro.streamServerRenderedReactComponent) {
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    reactOnRailsProSpecificFunctions.streamServerRenderedReactComponent = reactOnRailsPro.streamServerRenderedReactComponent;
+    reactOnRailsProSpecificFunctions.streamServerRenderedReactComponent =
+      // eslint-disable-next-line @typescript-eslint/unbound-method
+      reactOnRailsPro.streamServerRenderedReactComponent;
   }
 
   if (reactOnRailsPro.serverRenderRSCReactComponent) {
-    // eslint-disable-next-line @typescript-eslint/unbound-method
-    reactOnRailsProSpecificFunctions.serverRenderRSCReactComponent = reactOnRailsPro.serverRenderRSCReactComponent;
+    reactOnRailsProSpecificFunctions.serverRenderRSCReactComponent =
+      // eslint-disable-next-line @typescript-eslint/unbound-method
+      reactOnRailsPro.serverRenderRSCReactComponent;
   }
 
   // Assign Pro-specific functions to the ReactOnRailsPro object using Object.assign

packages/react-on-rails/src/ClientRenderer.ts

@@ -116,6 +116,7 @@ You should return a React.Component always for the client side entry point.`);
 /**
  * Render a single component by its DOM ID.
  * This is the main entry point for rendering individual components.
+ * @public
  */
 export function renderComponent(domId: string): void {
   const railsContext = getRailsContext();

packages/react-on-rails/src/ReactOnRails.node.ts

@@ -24,6 +24,7 @@ type ReactOnRailsFullSpecificFunctions = Pick<
 /**
  * Full object type that includes all base methods plus real SSR implementations.
  * Derived from ReactOnRailsInternal by picking base methods and SSR methods.
+ * @public
  */
 export type BaseFullObjectType = Pick<
   ReactOnRailsInternal,