chore(repo): docs and format

nrwl · Apr 5, 2022 · dabb60f · dabb60f
1 parent 44db323
commit dabb60f
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 7 deletions.
diff --git a/docs/generated/api-nx-devkit/index.md b/docs/generated/api-nx-devkit/index.md
@@ -38,6 +38,7 @@ It only uses language primitives and immutable objects
 ### Other Interfaces
 
 - [NxPlugin](../../nx-devkit/index#nxplugin)
+- [PackageJson](../../nx-devkit/index#packagejson)
 
 ### Project Graph Interfaces
 
@@ -226,6 +227,12 @@ A plugin for Nx
 
 ---
 
+### PackageJson
+
+• **PackageJson**: `Object`
+
+---
+
 ## Project Graph Interfaces
 
 ### FileData

diff --git a/docs/generated/packages/nx-plugin.json b/docs/generated/packages/nx-plugin.json
@@ -335,6 +335,40 @@
       "aliases": [],
       "hidden": false,
       "path": "/packages/nx-plugin/src/executors/e2e/schema.json"
+    },
+    {
+      "name": "plugin-lint",
+      "implementation": "/packages/nx-plugin/src/executors/plugin-lint/plugin-lint.impl.ts",
+      "schema": {
+        "title": "Nx Plugin Lint Target",
+        "description": "Checks a Nx Plugin for validity.",
+        "cli": "nx",
+        "type": "object",
+        "properties": {
+          "validateSchemas": {
+            "description": "Should the schema files be validated?",
+            "type": "boolean",
+            "default": true
+          },
+          "validateImplementationLocations": {
+            "type": "boolean",
+            "description": "Should the implementation locations be validated?",
+            "default": true
+          },
+          "packageJson": {
+            "type": "string",
+            "description": "The path to the package.json file for the plugin",
+            "default": "generators.json"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["packageJson"],
+        "presets": []
+      },
+      "description": "Checks a Nx plugin for validity.",
+      "aliases": [],
+      "hidden": false,
+      "path": "/packages/nx-plugin/src/executors/plugin-lint/schema.json"
     }
   ]
 }
diff --git a/docs/map.json b/docs/map.json
@@ -1251,6 +1251,11 @@
             "name": "e2e executor",
             "id": "e2e",
             "path": "/packages/nx-plugin/executors/e2e"
+          },
+          {
+            "name": "plugin-lint executor",
+            "id": "plugin-lint",
+            "path": "/packages/nx-plugin/executors/plugin-lint"
           }
         ]
       },

diff --git a/docs/packages.json b/docs/packages.json
@@ -178,7 +178,7 @@
     "name": "nx-plugin",
     "path": "generated/packages/nx-plugin.json",
     "schemas": {
-      "executors": ["e2e"],
+      "executors": ["e2e", "plugin-lint"],
       "generators": [
         "plugin",
         "e2e-project",

diff --git a/packages/devkit/index.ts b/packages/devkit/index.ts
@@ -47,9 +47,7 @@ export type {
   ProjectTargetConfigurator,
 } from 'nx/src/utils/nx-plugin';
 
-export type {
-  PackageJson
-} from 'nx/src/utils/package-json'
+export type { PackageJson } from 'nx/src/utils/package-json';
 
 /**
  * @category Workspace

diff --git a/packages/linter/src/executors/lint/compat.ts b/packages/linter/src/executors/lint/compat.ts
@@ -1,4 +1,4 @@
-import { convertNxExecutor } from "@nrwl/devkit"
-import executor from './lint.impl'
+import { convertNxExecutor } from '@nrwl/devkit';
+import executor from './lint.impl';
 
-export default convertNxExecutor(executor)
+export default convertNxExecutor(executor);