fix: add warning for deprecated use of CLI options

karma-runner · Mar 5, 2021 · 5d92865 · 5d92865
1 parent 088aa79
commit 5d92865
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/lib/runner.js b/lib/runner.js
@@ -35,6 +35,9 @@ function parseExitCode (buffer, defaultExitCode, failOnEmptyTestSuite) {
 function run (cliOptionsOrConfig, done) {
   cliOptionsOrConfig = cliOptionsOrConfig || {}
 
+  // TODO: Should `const log = logger.create('runner')` be moved into the
+  //     : function for consistency with server.js and stopper.js? or the
+  //     : reverse (make server and stopper consistent with runner?)
   logger.setupFromConfig({
     colors: cliOptionsOrConfig.colors,
     logLevel: cliOptionsOrConfig.logLevel
@@ -46,6 +49,12 @@ function run (cliOptionsOrConfig, done) {
   if (cliOptionsOrConfig instanceof cfg.Config) {
     config = cliOptionsOrConfig
   } else {
+    const deprecatedCliOptionsMessage =
+      'Passing raw CLI options to `runner(config, done)` is deprecated. Use ' +
+      '`parseConfig(configFilePath, cliOptions, {promiseConfig: true, throwErrors: true})` ' +
+      'to prepare a processed `Config` instance and pass that as the ' +
+      '`config` argument instead.'
+    log.warn(deprecatedCliOptionsMessage)
     try {
       config = cfg.parseConfig(
         cliOptionsOrConfig.configFile,

diff --git a/lib/server.js b/lib/server.js
@@ -70,6 +70,13 @@ class Server extends KarmaEventEmitter {
     if (cliOptionsOrConfig instanceof cfg.Config) {
       config = cliOptionsOrConfig
     } else {
+      const deprecatedCliOptionsMessage =
+        'Passing raw CLI options to `new Server(config, done)` is ' +
+        'deprecated. Use ' +
+        '`parseConfig(configFilePath, cliOptions, {promiseConfig: true, throwErrors: true})` ' +
+        'to prepare a processed `Config` instance and pass that as the ' +
+        '`config` argument instead.'
+      this.log.warn(deprecatedCliOptionsMessage)
       try {
         config = cfg.parseConfig(
           cliOptionsOrConfig.configFile,

diff --git a/lib/stopper.js b/lib/stopper.js
@@ -16,6 +16,12 @@ exports.stop = function (cliOptionsOrConfig, done) {
   if (cliOptionsOrConfig instanceof cfg.Config) {
     config = cliOptionsOrConfig
   } else {
+    const deprecatedCliOptionsMessage =
+      'Passing raw CLI options to `stopper(config, done)` is deprecated. Use ' +
+      '`parseConfig(configFilePath, cliOptions, {promiseConfig: true, throwErrors: true})` ' +
+      'to prepare a processed `Config` instance and pass that as the ' +
+      '`config` argument instead.'
+    log.warn(deprecatedCliOptionsMessage)
     try {
       config = cfg.parseConfig(
         cliOptionsOrConfig.configFile,