feat: Adding new checkup package to provide plugin utils. Generates d…

…ocs.

packages/checkup-plugin-ember/docs/tasks/ember-dependencies-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-dependencies
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Finds Ember-specific dependencies and their versions in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-dependencies
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/docs/tasks/ember-in-repo-addons-engines-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-in-repo-addons-engines
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Finds all in-repo engines and addons in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-in-repo-addons-engines
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/docs/tasks/ember-octane-migration-status-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-octane-migration-status
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Tracks the migration status when moving from Ember Classic to Ember Octane in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-octane-migration-status
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/docs/tasks/ember-template-lint-disable-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-template-lint-disables
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Finds all disabled ember-template-lint rules in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-template-lint-disables
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/docs/tasks/ember-template-lint-summary-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-template-lint-summary
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Gets a summary of all ember-template-lint results in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-template-lint-summary
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/docs/tasks/ember-test-types-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-test-types
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Gets a breakdown of all test types in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-test-types
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/docs/tasks/ember-types-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# ember/ember-types
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Gets a breakdown of all Ember types in an Ember.js project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task ember/ember-types
+```
+<!--RUN_END-->

packages/checkup-plugin-ember/package.json

@@ -14,6 +14,7 @@
     "tslib": "^2"
   },
   "devDependencies": {
+    "@checkup/plugin": "^0.13.2",
     "@checkup/test-helpers": "^0.13.2",
     "fixturify-project": "^2.1.0",
     "rimraf": "^3.0.2"
@@ -37,7 +38,7 @@
   "scripts": {
     "build": "tsc --build",
     "test": "jest --no-cache",
-    "version": "git add README.md"
+    "docs:generate": "checkup-plugin docs"
   },
   "types": "lib/index.d.ts",
   "main": "lib/index.js"

packages/checkup-plugin-ember/src/tasks/ember-dependencies-task.ts

@@ -11,6 +11,7 @@ type Dependency = {
 export default class EmberDependenciesTask extends BaseTask implements Task {
   taskName = 'ember-dependencies';
   taskDisplayName = 'Ember Dependencies';
+  description = 'Finds Ember-specific dependencies and their versions in an Ember.js project';
   category = 'dependencies';
   group = 'ember';
 

packages/checkup-plugin-ember/src/tasks/ember-in-repo-addons-engines-task.ts

@@ -8,6 +8,7 @@ import { Result } from 'sarif';
 export default class EmberInRepoAddonsEnginesTask extends BaseTask implements Task {
   taskName = 'ember-in-repo-addons-engines';
   taskDisplayName = 'Ember In-Repo Addons / Engines';
+  description = 'Finds all in-repo engines and addons in an Ember.js project';
   category = 'metrics';
   group = 'ember';
 

packages/checkup-plugin-ember/src/tasks/ember-octane-migration-status-task.ts

@@ -105,6 +105,8 @@ const CUSTOM_RULE_MESSAGES = {
 export default class EmberOctaneMigrationStatusTask extends BaseTask implements Task {
   taskName = 'ember-octane-migration-status';
   taskDisplayName = 'Ember Octane Migration Status';
+  description =
+    'Tracks the migration status when moving from Ember Classic to Ember Octane in an Ember.js project';
   category = 'migrations';
   group = 'ember';
 

packages/checkup-plugin-ember/src/tasks/ember-template-lint-disable-task.ts

@@ -9,6 +9,7 @@ const TEMPLATE_LINT_DISABLE = 'template-lint-disable';
 export default class EmberTemplateLintDisableTask extends BaseTask implements Task {
   taskName = 'ember-template-lint-disables';
   taskDisplayName = 'Number of template-lint-disable Usages';
+  description = 'Finds all disabled ember-template-lint rules in an Ember.js project';
   category = 'linting';
   group = 'disabled-lint-rules';
 

packages/checkup-plugin-ember/src/tasks/ember-template-lint-summary-task.ts

@@ -17,6 +17,7 @@ import { Result } from 'sarif';
 export default class TemplateLintSummaryTask extends BaseTask implements Task {
   taskName = 'ember-template-lint-summary';
   taskDisplayName = 'Template Lint Summary';
+  description = 'Gets a summary of all ember-template-lint results in an Ember.js project';
   category = 'linting';
   group = 'ember';
 

packages/checkup-plugin-ember/src/tasks/ember-test-types-task.ts

@@ -14,6 +14,7 @@ import { EMBER_TEST_TYPES } from '../utils/lint-configs';
 export default class EmberTestTypesTask extends BaseTask implements Task {
   taskName = 'ember-test-types';
   taskDisplayName = 'Test Types';
+  description = 'Gets a breakdown of all test types in an Ember.js project';
   category = 'testing';
   group = 'ember';
 

packages/checkup-plugin-ember/src/tasks/ember-types-task.ts

@@ -17,6 +17,7 @@ const SEARCH_PATTERNS = [
 export default class EmberTypesTask extends BaseTask implements Task {
   taskName = 'ember-types';
   taskDisplayName = 'Ember Types';
+  description = 'Gets a breakdown of all Ember types in an Ember.js project';
   category = 'metrics';
   group = 'ember';
 

packages/checkup-plugin-javascript/docs/tasks/eslint-disable-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# javascript/eslint-disables
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Finds all disabled eslint rules in a project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task javascript/eslint-disables
+```
+<!--RUN_END-->

packages/checkup-plugin-javascript/docs/tasks/eslint-summary-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# javascript/eslint-summary
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Gets a summary of all eslint results in a project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task javascript/eslint-summary
+```
+<!--RUN_END-->

packages/checkup-plugin-javascript/docs/tasks/outdated-dependencies-task.md

@@ -0,0 +1,15 @@
+<!--TASK_NAME_START-->
+# javascript/outdated-dependencies
+<!--TASK_NAME_END-->
+
+<!--TASK_DESCRIPTION_START-->
+Gets a summary of all outdated dependencies in a project
+<!--TASK_DESCRIPTION_END-->
+
+<!--RUN_START-->
+## To run this task
+
+```bash
+checkup run --task javascript/outdated-dependencies
+```
+<!--RUN_END-->

packages/checkup-plugin-javascript/package.json

@@ -13,6 +13,7 @@
     "tslib": "^2"
   },
   "devDependencies": {
+    "@checkup/plugin": "^0.13.2",
     "@checkup/test-helpers": "^0.13.2",
     "fixturify-project": "^2.1.0",
     "rimraf": "^3.0.2"
@@ -36,7 +37,7 @@
   "scripts": {
     "build": "tsc --build",
     "test": "jest --no-cache",
-    "version": "git add README.md"
+    "docs:generate": "checkup-plugin docs"
   },
   "types": "lib/index.d.ts",
   "main": "lib/index.js"

packages/checkup-plugin-javascript/src/tasks/eslint-disable-task.ts

@@ -12,6 +12,7 @@ const ESLINT_DISABLE_REGEX = /^eslint-disable(?:-next-line|-line)*/gi;
 export default class EslintDisableTask extends BaseTask implements Task {
   taskName = 'eslint-disables';
   taskDisplayName = 'Number of eslint-disable Usages';
+  description = 'Finds all disabled eslint rules in a project';
   category = 'linting';
   group = 'disabled-lint-rules';
 

packages/checkup-plugin-javascript/src/tasks/eslint-summary-task.ts

@@ -35,6 +35,7 @@ export const ACCEPTED_ESLINT_CONFIG_FILES = [
 export default class EslintSummaryTask extends BaseTask implements Task {
   taskName = 'eslint-summary';
   taskDisplayName = 'Eslint Summary';
+  description = 'Gets a summary of all eslint results in a project';
   category = 'linting';
 
   private _eslintParser: Parser<ESLintReport>;

packages/checkup-plugin-javascript/src/tasks/outdated-dependencies-task.ts

@@ -35,6 +35,7 @@ interface OutdatedDependency {
 export default class OutdatedDependenciesTask extends BaseTask implements Task {
   taskName = 'outdated-dependencies';
   taskDisplayName = 'Outdated Dependencies';
+  description = 'Gets a summary of all outdated dependencies in a project';
   category = 'dependencies';
 
   async run(): Promise<Result[]> {

packages/cli/__tests__/checkup-task-runner-test.ts

@@ -7,6 +7,7 @@ import { sarifLogMatcher } from './__utils__/sarif-match-object';
 class FooTask extends BaseTask implements Task {
   taskName = 'foo';
   taskDisplayName = 'Foo Task';
+  description = 'description';
   category = 'fake1';
   group = 'group1';
 
@@ -21,6 +22,7 @@ class FooTask extends BaseTask implements Task {
 class FileCountTask extends BaseTask implements Task {
   taskName = 'file-count';
   taskDisplayName = 'File Count Task';
+  description = 'description';
   category = 'fake2';
   group = 'group2';
 

packages/cli/__tests__/task-list-test.ts

@@ -8,6 +8,7 @@ const STABLE_ERROR = new Error('Something went wrong in this task');
 class InsightsTaskHigh extends BaseTask implements Task {
   taskName = 'insights-task-high';
   taskDisplayName = 'Insights Task High';
+  description = 'description';
   category = 'bar';
   group = 'group1';
 
@@ -33,6 +34,7 @@ class InsightsTaskHigh extends BaseTask implements Task {
 class InsightsTaskLow extends BaseTask implements Task {
   taskName = 'insights-task-low';
   taskDisplayName = 'Insights Task Low';
+  description = 'description';
   category = 'foo';
   group = 'group2';
 
@@ -57,7 +59,7 @@ class InsightsTaskLow extends BaseTask implements Task {
 class RecommendationsTaskHigh extends BaseTask implements Task {
   taskName = 'recommendations-task-high';
   taskDisplayName = 'Recommendations Task High';
-
+  description = 'description';
   category = 'baz';
 
   constructor(context: TaskContext) {
@@ -81,7 +83,7 @@ class RecommendationsTaskHigh extends BaseTask implements Task {
 class RecommendationsTaskLow extends BaseTask implements Task {
   taskName = 'recommendations-task-low';
   taskDisplayName = 'Recommendations Task Low';
-
+  description = 'description';
   category = 'bar';
 
   constructor(context: TaskContext) {
@@ -105,7 +107,7 @@ class RecommendationsTaskLow extends BaseTask implements Task {
 class MigrationTaskHigh extends BaseTask implements Task {
   taskName = 'migration-task-high';
   taskDisplayName = 'Migration Task High';
-
+  description = 'description';
   category = 'foo';
 
   constructor(context: TaskContext) {
@@ -129,7 +131,7 @@ class MigrationTaskHigh extends BaseTask implements Task {
 class MigrationTaskLow extends BaseTask implements Task {
   taskName = 'migration-task-low';
   taskDisplayName = 'Migration Task Low';
-
+  description = 'description';
   category = 'baz';
 
   constructor(context: TaskContext) {
@@ -153,7 +155,7 @@ class MigrationTaskLow extends BaseTask implements Task {
 class ErrorTask extends BaseTask implements Task {
   taskName = 'error-task';
   taskDisplayName = 'Error Task';
-
+  description = 'description';
   category = 'bar';
 
   constructor(context: TaskContext) {
@@ -167,7 +169,7 @@ class ErrorTask extends BaseTask implements Task {
 class TaskWithoutCategory extends BaseTask implements Task {
   taskName = 'task-without-category';
   taskDisplayName = 'Task Without Category';
-
+  description = 'description';
   category = '';
 
   constructor(context: TaskContext) {

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

@@ -33,15 +33,6 @@ import { getLog } from '../get-log';
 import TaskListImpl from '../task-list';
 import { getPackageJson } from '../utils/get-package-json';
 import PluginRegistrationProvider from './registration-provider';
-
-let __tasksForTesting: Set<Task> = new Set<Task>();
-
-export function _registerTaskForTesting(task: Task) {
-  __tasksForTesting.add(task);
-}
-export function _resetTasksForTesting() {
-  __tasksForTesting = new Set<Task>();
-}
 export default class CheckupTaskRunner {
   actions: Action[] = [];
   config!: CheckupConfig;
@@ -217,10 +208,6 @@ export default class CheckupTaskRunner {
         registeredTasks: this.tasks,
       }),
     });
-
-    __tasksForTesting.forEach((task: Task) => {
-      this.tasks.registerTask(task);
-    });
   }
 
   private async loadFromPlugin(registrationArgs: RegistrationArgs) {

packages/core/__tests__/base-task-test.ts

@@ -6,6 +6,7 @@ import { TaskContext } from '../src/types/tasks';
 class FakeTask extends BaseTask {
   taskName = 'my-fake';
   taskDisplayName = 'Fake';
+  description = 'description';
   category = 'foo';
 }