added warning message that package is deprecated (#152)

* added warning message that package is deprecated

* comments updated

* added unused binaries in knip ignore binaries

* changed the message

---------

Co-authored-by: Alem Tuzlak <[email protected]>

.gitignore

@@ -135,4 +135,4 @@ dist
 
 # IDE
 .idea
-.tsup
+.tsup

src/vite/plugin.tsx

@@ -32,6 +32,12 @@ type RemixViteConfig = {
 	/** The directory where the remix app is located. Defaults to the "./app" relative to where vite.config is being defined. */
 	remixDir?: string
 	editor?: EditorConfig
+	/**
+	 * If the package is marked as deprecated, a warning will be logged in the console
+	 * To disable this warning, set the option to true
+	 * @default false
+	 */
+	suppressDeprecationWarning?: boolean
 }
 
 export const defineRdtConfig = (config: RemixViteConfig) => config
@@ -167,6 +173,14 @@ export const remixDevTools: (args?: RemixViteConfig) => Plugin[] = (args) => {
 				return shouldInject(config.mode)
 			},
 			async configResolved(resolvedViteConfig) {
+				if (!args?.suppressDeprecationWarning && resolvedViteConfig.appType === "custom") {
+					// Log a warning message
+					console.log(
+						`\n\n⚠️  ${chalk.yellowBright("remix-development-tools")} are going to be deprecated and will be renamed to ${chalk.greenBright("react-router-devtools ")} when React Router v7 is released ⚠️`,
+						`\n⚠️  Set suppressDeprecationWarning to true in your ${chalk.greenBright("vite.config.ts")} file to silence this warning ⚠️`
+					)
+				}
+
 				const remixIndex = resolvedViteConfig.plugins.findIndex((p) => p.name === "remix")
 				const devToolsIndex = resolvedViteConfig.plugins.findIndex((p) => p.name === "remix-development-tools")
 

test-apps/remix-vite/vite.config.ts

@@ -18,8 +18,10 @@ const config = defineRdtConfig({
   },
   pluginDir: "./plugins",
   includeInProd: true,
+    // Set this option to true to suppress deprecation warnings
+    // suppressDeprecationWarning: true,
   server:  {
-    serverTimingThreshold: 250
+    serverTimingThreshold: 250,
   }
 });
 
@@ -35,6 +37,6 @@ export default defineConfig({
   ],
   server: {
     open: true,
-    port: 3005 ,
+    port: 3005,
   },
 });