chore: add deprecation warnings for legacy runASTAnalysis and `runA…

…STAnalysisOnFile`. (#276)

These warnings are added to inform users that these APIs will be removed in v8 and encourage them to use `AstAnalyser` instead.

Fixes #266

index.js

@@ -8,6 +8,14 @@ function runASTAnalysis(
   str,
   options = Object.create(null)
 ) {
+  process.emitWarning(
+    'The runASTAnalysis API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.',
+    {
+      code: 'DeprecationWarning',
+      detail: 'The runASTAnalysis API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.'
+    }
+  );
+
   const {
     customParser = new JsSourceParser(),
     customProbes = [],
@@ -28,6 +36,14 @@ async function runASTAnalysisOnFile(
   pathToFile,
   options = {}
 ) {
+  process.emitWarning(
+    'The runASTAnalysisOnFile API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.',
+    {
+      code: 'DeprecationWarning',
+      detail: 'The runASTAnalysisOnFile API is deprecated and will be removed in v8. Please use the AstAnalyser class instead.'
+    }
+  );
+
   const {
     customProbes = [],
     customParser = new JsSourceParser(),