Merge pull request #69 from arshad-yaseen/improve-deprecated-logging

Improve deprecated logger

CHANGELOG.md

@@ -1,11 +1,8 @@
-
-
 ## [0.12.9](https://github.com/arshad-yaseen/monacopilot/compare/v0.12.8...v0.12.9) (2024-10-27)
 
-
 ### 📚 Documentation
 
-* mention to always specify provider and model ([8edf342](https://github.com/arshad-yaseen/monacopilot/commit/8edf3424869a6325e2ef3a01c63ba48826180e22))
+- mention to always specify provider and model ([8edf342](https://github.com/arshad-yaseen/monacopilot/commit/8edf3424869a6325e2ef3a01c63ba48826180e22))
 
 ## [0.12.8](https://github.com/arshad-yaseen/monacopilot/compare/v0.12.7...v0.12.8) (2024-10-26)
 

src/classes/copilot.ts

@@ -145,9 +145,7 @@ export class Copilot {
     if (typeof this.model === 'object' && 'transformResponse' in this.model) {
       const transformedResponse = this.model.transformResponse(chatCompletion);
       if ('completion' in transformedResponse) {
-        deprecated(
-          'The `completion` property in `transformResponse` function is deprecated. Please use `text` instead.',
-        );
+        deprecated('completion', 'text', 'Copilot.model.transformResponse');
       }
       return {
         completion:

src/core/completion/register.ts

@@ -164,9 +164,7 @@ const handleTriggerCompletion = (editor: StandaloneCodeEditor) => {
 export const registerCopilot = (
   ...args: Parameters<typeof registerCompletion>
 ) => {
-  deprecated(
-    'The `registerCopilot` function is deprecated. Use `registerCompletion` instead.',
-  );
+  deprecated('registerCopilot', 'registerCompletion');
 
   return registerCompletion(...args);
 };

src/logger.ts

@@ -28,14 +28,20 @@ export const report = (error: unknown): {message: string; stack?: string} => {
   return {message: errorMessage, stack: errorStack};
 };
 
-export const deprecated = (message: string): void => {
-  console.warn(`${YELLOW}${BOLD}[MONACOPILOT DEPRECATED] ${message}${RESET}`);
-};
-
 export const warn = (message: string): void => {
   console.warn(`${YELLOW}${BOLD}[MONACOPILOT WARN] ${message}${RESET}`);
 };
 
 export const log = (message: string): void => {
   console.log(`${BOLD}[MONACOPILOT] ${message}${RESET}`);
 };
+
+export const deprecated = (
+  oldFeature: string,
+  newFeature: string,
+  location?: string,
+): void =>
+  console.warn(
+    `${YELLOW}${BOLD}[MONACOPILOT DEPRECATED] "${oldFeature}" is deprecated${location ? ` in ${location}` : ''}. ` +
+      `Please use "${newFeature}" instead. It will be removed in a future version.${RESET}`,
+  );

tests/ui/src/app/page.tsx

@@ -4,7 +4,7 @@ import {useEffect, useState} from 'react';
 
 import Editor from '@monaco-editor/react';
 import {
-  registerCompletion,
+  registerCopilot,
   type Monaco,
   type StandaloneCodeEditor,
 } from 'monacopilot';
@@ -16,7 +16,7 @@ export default function Home() {
   useEffect(() => {
     if (!monaco || !editor) return;
 
-    const completion = registerCompletion(monaco, editor, {
+    const completion = registerCopilot(monaco, editor, {
       endpoint: '/api/complete',
       language: 'javascript',
       maxContextLines: 60,