Removing debuggers (#1009)

packages/cli/__tests__/__utils__/fake-project.ts

@@ -7,15 +7,20 @@ import type { Answers } from 'inquirer';
 import { generatePlugin, generateTask } from './generator-utils';
 
 export class FakeProject extends CheckupProject {
-  async addPlugin(options: helpers.Dictionary<any> = {}, prompts: Answers = {}) {
-    let pluginDir = await generatePlugin(options, prompts, join(this.baseDir, 'node_modules'));
+  symlinkCorePackage(baseDir: string = this.baseDir) {
     let source = join(__dirname, '../../..', 'core');
-    let target = join(pluginDir, 'node_modules', '@checkup', 'core');
+    let target = join(baseDir, 'node_modules', '@checkup', 'core');
 
     // we create a self-referential link to the core package within the generated plugin. This
     // allows us to generate plugins, and test the APIs for the latest version of core that is
     // referenced via the plugins' node_modules.
     this.symlinkPackage(source, target);
+  }
+
+  async addPlugin(options: helpers.Dictionary<any> = {}, prompts: Answers = {}) {
+    let pluginDir = await generatePlugin(options, prompts, join(this.baseDir, 'node_modules'));
+
+    this.symlinkCorePackage(pluginDir);
 
     return pluginDir;
   }

packages/cli/__tests__/cli-test.ts

@@ -129,11 +129,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run(['run', '--list-tasks']);
@@ -238,11 +234,7 @@ describe('cli-test', () => {
       );
 
       project.addCheckupConfig({
-        $schema:
-          'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-        excludePaths: [],
         plugins: ['checkup-plugin-fake'],
-        tasks: {},
       });
 
       project.write({
@@ -279,11 +271,7 @@ describe('cli-test', () => {
       );
 
       project.addCheckupConfig({
-        $schema:
-          'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-        excludePaths: [],
         plugins: ['checkup-plugin-fake'],
-        tasks: {},
       });
 
       let fixturePath = resolve(__dirname, '__fixtures__', 'checkup-formatter-test');
@@ -312,11 +300,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run(['run', '.', '--task', 'fake/file-count', '--format', 'pretty']);
@@ -356,11 +340,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run(['run', '.', '--format', 'pretty'], {
@@ -389,11 +369,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run([
@@ -451,11 +427,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run(['run', '.', '--category', 'files', '--format', 'pretty']);
@@ -500,11 +472,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run([
@@ -564,11 +532,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run(['run', '.', '--group', 'group1', '--format', 'pretty']);
@@ -613,11 +577,7 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
 
     let result = await run([
@@ -670,9 +630,6 @@ describe('cli-test', () => {
     );
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
       tasks: { 'fake/file-count': 'off' },
     });
@@ -857,7 +814,7 @@ describe('cli-test', () => {
     expect(result.stderr).toContain('Cannot find the foo task.');
   });
 
-  it('can load plugins from pluginBaseDir, if provided', async () => {
+  it('can load plugins from pluginBaseDir with a node_modules', async () => {
     let newProject = new FakeProject('random-app', '0.0.0', () => {});
     newProject.files['index.js'] = 'module.exports = {};';
     newProject.files['index.hbs'] = '<div>Random App</div>';
@@ -874,11 +831,7 @@ describe('cli-test', () => {
     newProject.writeSync();
 
     project.addCheckupConfig({
-      $schema:
-        'https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json',
-      excludePaths: [],
       plugins: ['checkup-plugin-fake'],
-      tasks: {},
     });
     project.chdir();
 
@@ -887,6 +840,71 @@ describe('cli-test', () => {
     expect(result.stdout).toMatch('✔ foo');
   });
 
+  it('can load plugins from nested (non-node_modules) pluginBaseDir', async () => {
+    project.addCheckupConfig({
+      plugins: ['checkup-plugin-nested'],
+    });
+
+    project.write({
+      lib: {
+        'checkup-plugin-nested': {
+          'index.js': `
+const FooTask = require('./tasks/foo-task');
+module.exports = {
+  register: function(args) {
+    let pluginName = 'checkup-plugin-nested';
+
+    args.register.task(new FooTask(pluginName, args.context));
+  }
+}
+`,
+          'package.json': `{
+  "name": "checkup-plugin-nested",
+  "description": "",
+  "version": "0.0.1",
+  "dependencies": {
+    "@checkup/core": "*"
+  },
+  "devDependencies": {},
+  "keywords": [
+    "checkup-plugin"
+  ]
+}
+`,
+          tasks: {
+            'foo-task.js': `const { BaseTask } = require('@checkup/core');
+
+module.exports = class FooTask extends BaseTask {
+  taskName = 'foo';
+  taskDisplayName = 'Foo';
+  category = 'best practices';
+
+  async run() {
+    return [
+      {
+        message: { text: 'foo' },
+        ruleId: this.taskName,
+        properties: {
+          taskDisplayName: this.taskDisplayName,
+          category: this.category,
+        },
+      },
+    ];
+  }
+}
+`,
+          },
+        },
+      },
+    });
+
+    project.symlinkCorePackage();
+
+    let result = await run(['run', '.', '--plugin-base-dir', join(project.baseDir, 'lib')]);
+    expect(result.exitCode).toEqual(0);
+    expect(result.stdout).toMatch('✔ foo');
+  });
+
   function run(args: string[], options: execa.Options = {}) {
     let defaults = {
       reject: false,

packages/cli/src/api/checkup-task-runner.ts

@@ -1,3 +1,4 @@
+import { join } from 'path';
 import {
   Action,
   CheckupError,
@@ -192,10 +193,23 @@ export default class CheckupTaskRunner {
     let pluginBaseDir = this.options.pluginBaseDir || this.options.cwd;
 
     for (let pluginName of this.config.plugins) {
-      this.debug('Loading plugin from %s', pluginName);
+      let pluginDir;
+
+      try {
+        // We first attempt to resolve from a node_modules location, which is either
+        // the project's node_modules directory or an alternative location that contains
+        // a node_modules.
+        pluginDir = resolve.sync(pluginName, { basedir: pluginBaseDir });
+      } catch {
+        // If we're trying to load from a pluginBaseDir that doesn't contain a node_modules,
+        // we assume we're trying to load plugins from a simple directory, and therefore
+        // simply require the entry point file.
+        pluginDir = join(pluginBaseDir, pluginName);
+      }
 
-      let { register } = require(resolve.sync(pluginName, { basedir: pluginBaseDir }));
+      this.debug('Loading plugin from %s', pluginDir);
 
+      let { register } = require(pluginDir);
       await register(registrationArgs);
     }
   }