@rxap/plugin-utilities 16.1.0-dev.5 → 16.1.0-dev.6

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [16.1.0-dev.6](https://gitlab.com/rxap/packages/compare/@rxap/plugin-utilities@16.1.0-dev.5...@rxap/plugin-utilities@16.1.0-dev.6) (2023-08-06)
+
+### Bug Fixes
+
+- ensure new line ([5562c46](https://gitlab.com/rxap/packages/commit/5562c46fbbb5705a4b383a9ea4ceb3945071b659))
+- expose generators as schematics ([679ca36](https://gitlab.com/rxap/packages/commit/679ca36d3712a11e4dc838762bca2f7c471e1e04))
+
 # [16.1.0-dev.5](https://gitlab.com/rxap/packages/compare/@rxap/plugin-utilities@16.1.0-dev.4...@rxap/plugin-utilities@16.1.0-dev.5) (2023-08-05)
 
 ### Bug Fixes

package/README.md

@@ -17,5 +17,5 @@ yarn add @rxap/plugin-utilities
 ```
 **Install peer dependencies:**
 ```bash
-yarn add @nx/devkit@^16.5.0 @rxap/node-utilities@^1.1.0-dev.1 @rxap/workspace-utilities@^0.1.0-dev.2 
+yarn add @nx/devkit@^16.5.0 @rxap/generator-utilities@* @rxap/node-utilities@^1.1.0-dev.1 @rxap/workspace-utilities@^0.1.0-dev.2 
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rxap/plugin-utilities",
-  "version": "16.1.0-dev.5",
+  "version": "16.1.0-dev.6",
   "type": "commonjs",
   "publishConfig": {
     "access": "public",
@@ -29,6 +29,7 @@
   },
   "peerDependencies": {
     "@nx/devkit": "^16.5.0",
+    "@rxap/generator-utilities": "*",
     "@rxap/node-utilities": "^1.1.0-dev.1",
     "@rxap/workspace-utilities": "^0.1.0-dev.2",
     "@rxap/utilities": "16.0.0-dev.6"
@@ -51,7 +52,7 @@
       }
     ]
   },
-  "gitHead": "935f06ea33643b9821e0f49464a7ade7477972a5",
+  "gitHead": "8f010d8945a8bd56c8968c2af129b1e0b2f656cf",
   "main": "./src/index.js",
   "types": "./src/index.d.ts"
 }

package/src/index.d.ts

@@ -8,3 +8,5 @@ export * from './lib/guess-output-path';
 export * from './lib/yarn-run';
 export * from './lib/project-target';
 export * from './lib/project-package-name-mapping';
+export * from './lib/skip-non-generators-project';
+export * from './lib/generators';

package/src/index.js

@@ -11,4 +11,6 @@ tslib_1.__exportStar(require("./lib/guess-output-path"), exports);
 tslib_1.__exportStar(require("./lib/yarn-run"), exports);
 tslib_1.__exportStar(require("./lib/project-target"), exports);
 tslib_1.__exportStar(require("./lib/project-package-name-mapping"), exports);
+tslib_1.__exportStar(require("./lib/skip-non-generators-project"), exports);
+tslib_1.__exportStar(require("./lib/generators"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/plugin/utilities/src/index.ts"],"names":[],"mappings":";;;AAAA,4FAAkE;AAClE,yFAA+D;AAC/D,qEAA2C;AAC3C,wDAA8B;AAC9B,mEAAyC;AACzC,mFAAyD;AACzD,kEAAwC;AACxC,yDAA+B;AAC/B,+DAAqC;AACrC,6EAAmD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/plugin/utilities/src/index.ts"],"names":[],"mappings":";;;AAAA,4FAAkE;AAClE,yFAA+D;AAC/D,qEAA2C;AAC3C,wDAA8B;AAC9B,mEAAyC;AACzC,mFAAyD;AACzD,kEAAwC;AACxC,yDAA+B;AAC/B,+DAAqC;AACrC,6EAAmD;AACnD,4EAAkD;AAClD,2DAAiC"}

package/src/lib/generators.d.ts

@@ -0,0 +1,25 @@
+import { ProjectConfiguration, Tree } from '@nx/devkit';
+import { PackageJson } from '@rxap/workspace-utilities';
+export interface PackageJsonWithGenerators extends PackageJson {
+    generators: string;
+}
+export declare function HasGeneratorProperty(packageJson: PackageJson): packageJson is PackageJsonWithGenerators;
+export declare function GetGeneratorFilePath(projectRoot: string, packageJson: PackageJsonWithGenerators): string;
+export declare function ExistsGeneratorFile(tree: Tree, projectRoot: string, packageJson: PackageJsonWithGenerators): boolean;
+export interface GeneratorFile {
+    generators: Record<string, {
+        factory: string;
+        schema: string;
+        description: string;
+    }>;
+    schematics?: Record<string, {
+        factory: string;
+        schema: string;
+        description: string;
+    }>;
+}
+export declare function GetGeneratorFile(tree: Tree, projectRoot: string, packageJson: PackageJsonWithGenerators): GeneratorFile;
+export declare function ProjectRootOrNameOrConfigurationToProjectRoot(tree: Tree, projectRootOrNameOrConfiguration: string | ProjectConfiguration): string;
+export declare function GetGenerators(tree: Tree, projectRootOrNameOrConfiguration: string | ProjectConfiguration): GeneratorFile;
+export declare function UpdateGenerators(tree: Tree, projectRootOrNameOrConfiguration: string | ProjectConfiguration, update: (generators: GeneratorFile) => GeneratorFile): void;
+export declare function HasGenerators(tree: Tree, projectRootOrNameOrConfiguration: string | ProjectConfiguration): boolean;

package/src/lib/generators.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HasGenerators = exports.UpdateGenerators = exports.GetGenerators = exports.ProjectRootOrNameOrConfigurationToProjectRoot = exports.GetGeneratorFile = exports.ExistsGeneratorFile = exports.GetGeneratorFilePath = exports.HasGeneratorProperty = void 0;
+const workspace_utilities_1 = require("@rxap/workspace-utilities");
+const path_1 = require("path");
+function HasGeneratorProperty(packageJson) {
+    return !!packageJson['generators'];
+}
+exports.HasGeneratorProperty = HasGeneratorProperty;
+function GetGeneratorFilePath(projectRoot, packageJson) {
+    if (!packageJson['generators']) {
+        throw new Error(`The package.json of the project ${projectRoot} does not contains a generators property!`);
+    }
+    return (0, path_1.join)(projectRoot, packageJson['generators']);
+}
+exports.GetGeneratorFilePath = GetGeneratorFilePath;
+function ExistsGeneratorFile(tree, projectRoot, packageJson) {
+    return tree.exists(GetGeneratorFilePath(projectRoot, packageJson));
+}
+exports.ExistsGeneratorFile = ExistsGeneratorFile;
+function GetGeneratorFile(tree, projectRoot, packageJson) {
+    var _a;
+    const generatorFile = GetGeneratorFilePath(projectRoot, packageJson);
+    const content = (_a = tree.read(generatorFile)) === null || _a === void 0 ? void 0 : _a.toString('utf-8');
+    if (!content) {
+        throw new Error(`The generator file ${generatorFile} does not exists!`);
+    }
+    try {
+        return JSON.parse(content);
+    }
+    catch (e) {
+        throw new Error(`The generator file ${generatorFile} is not valid json!: ${e.message}`);
+    }
+}
+exports.GetGeneratorFile = GetGeneratorFile;
+function ProjectRootOrNameOrConfigurationToProjectRoot(tree, projectRootOrNameOrConfiguration) {
+    if (typeof projectRootOrNameOrConfiguration === 'string') {
+        if (projectRootOrNameOrConfiguration.match(/^\/?([^/]+\/)+[^/]+/)) {
+            return projectRootOrNameOrConfiguration;
+        }
+        else {
+            const project = (0, workspace_utilities_1.GetProject)(tree, projectRootOrNameOrConfiguration);
+            if (project) {
+                return project.root;
+            }
+            else {
+                throw new Error(`The project ${projectRootOrNameOrConfiguration} does not exists!`);
+            }
+        }
+    }
+    else {
+        return projectRootOrNameOrConfiguration.root;
+    }
+}
+exports.ProjectRootOrNameOrConfigurationToProjectRoot = ProjectRootOrNameOrConfigurationToProjectRoot;
+function GetGenerators(tree, projectRootOrNameOrConfiguration) {
+    const projectRoot = ProjectRootOrNameOrConfigurationToProjectRoot(tree, projectRootOrNameOrConfiguration);
+    const packageJson = (0, workspace_utilities_1.GetPackageJson)(tree, projectRoot);
+    if (!HasGeneratorProperty(packageJson)) {
+        throw new Error(`The project ${projectRoot} does not contains a generators property!`);
+    }
+    if (!ExistsGeneratorFile(tree, projectRoot, packageJson)) {
+        throw new Error(`The generator file ${GetGeneratorFilePath(projectRoot, packageJson)} does not exists!`);
+    }
+    return GetGeneratorFile(tree, projectRoot, packageJson);
+}
+exports.GetGenerators = GetGenerators;
+function UpdateGenerators(tree, projectRootOrNameOrConfiguration, update) {
+    const projectRoot = ProjectRootOrNameOrConfigurationToProjectRoot(tree, projectRootOrNameOrConfiguration);
+    const packageJson = (0, workspace_utilities_1.GetPackageJson)(tree, projectRoot);
+    if (!HasGeneratorProperty(packageJson)) {
+        throw new Error(`The project ${projectRoot} does not contains a generators property!`);
+    }
+    if (!ExistsGeneratorFile(tree, projectRoot, packageJson)) {
+        throw new Error(`The generator file ${GetGeneratorFilePath(projectRoot, packageJson)} does not exists!`);
+    }
+    const generators = GetGeneratorFile(tree, projectRoot, packageJson);
+    tree.write(GetGeneratorFilePath(projectRoot, packageJson), JSON.stringify(update(generators), null, 2) + '\n');
+}
+exports.UpdateGenerators = UpdateGenerators;
+function HasGenerators(tree, projectRootOrNameOrConfiguration) {
+    const projectRoot = ProjectRootOrNameOrConfigurationToProjectRoot(tree, projectRootOrNameOrConfiguration);
+    const packageJson = (0, workspace_utilities_1.GetPackageJson)(tree, projectRoot);
+    if (!HasGeneratorProperty(packageJson)) {
+        return false;
+    }
+    if (!ExistsGeneratorFile(tree, projectRoot, packageJson)) {
+        return false;
+    }
+    const generators = GetGeneratorFile(tree, projectRoot, packageJson);
+    if (!Object.keys(generators.generators).length) {
+        return false;
+    }
+    return true;
+}
+exports.HasGenerators = HasGenerators;
+//# sourceMappingURL=generators.js.map

package/src/lib/generators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generators.js","sourceRoot":"","sources":["../../../../../../packages/plugin/utilities/src/lib/generators.ts"],"names":[],"mappings":";;;AAIA,mEAImC;AACnC,+BAA4B;AAM5B,SAAgB,oBAAoB,CAAC,WAAwB;IAC3D,OAAO,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;AACrC,CAAC;AAFD,oDAEC;AAED,SAAgB,oBAAoB,CAAC,WAAmB,EAAE,WAAsC;IAE9F,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,mCAAoC,WAAY,2CAA2C,CAAC,CAAC;KAC9G;IAED,OAAO,IAAA,WAAI,EAAC,WAAW,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;AAEtD,CAAC;AARD,oDAQC;AAED,SAAgB,mBAAmB,CAAC,IAAU,EAAE,WAAmB,EAAE,WAAsC;IACzG,OAAO,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;AACrE,CAAC;AAFD,kDAEC;AAOD,SAAgB,gBAAgB,CAC9B,IAAU,EACV,WAAmB,EACnB,WAAsC;;IAEtC,MAAM,aAAa,GAAG,oBAAoB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IAErE,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,0CAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE5D,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,sBAAuB,aAAc,mBAAmB,CAAC,CAAC;KAC3E;IACD,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KAC5B;IAAC,OAAO,CAAM,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,sBAAuB,aAAc,wBAAyB,CAAC,CAAC,OAAQ,EAAE,CAAC,CAAC;KAC7F;AAEH,CAAC;AAlBD,4CAkBC;AAED,SAAgB,6CAA6C,CAC3D,IAAU,EACV,gCAA+D;IAE/D,IAAI,OAAO,gCAAgC,KAAK,QAAQ,EAAE;QACxD,IAAI,gCAAgC,CAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE;YACjE,OAAO,gCAAgC,CAAC;SACzC;aAAM;YACL,MAAM,OAAO,GAAG,IAAA,gCAAU,EAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;YACnE,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,CAAC,IAAI,CAAC;aACrB;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,eAAgB,gCAAiC,mBAAmB,CAAC,CAAC;aACvF;SACF;KACF;SAAM;QACL,OAAO,gCAAgC,CAAC,IAAI,CAAC;KAC9C;AACH,CAAC;AAlBD,sGAkBC;AAED,SAAgB,aAAa,CAC3B,IAAU,EACV,gCAA+D;IAG/D,MAAM,WAAW,GAAG,6CAA6C,CAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;IAE1G,MAAM,WAAW,GAAG,IAAA,oCAAc,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEtD,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,eAAgB,WAAY,2CAA2C,CAAC,CAAC;KAC1F;IAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE;QACxD,MAAM,IAAI,KAAK,CAAC,sBAAuB,oBAAoB,CAAC,WAAW,EAAE,WAAW,CAAE,mBAAmB,CAAC,CAAC;KAC5G;IAED,OAAO,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AAC1D,CAAC;AAlBD,sCAkBC;AAED,SAAgB,gBAAgB,CAC9B,IAAU,EACV,gCAA+D,EAC/D,MAAoD;IAGpD,MAAM,WAAW,GAAG,6CAA6C,CAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;IAE1G,MAAM,WAAW,GAAG,IAAA,oCAAc,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEtD,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,eAAgB,WAAY,2CAA2C,CAAC,CAAC;KAC1F;IAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE;QACxD,MAAM,IAAI,KAAK,CAAC,sBAAuB,oBAAoB,CAAC,WAAW,EAAE,WAAW,CAAE,mBAAmB,CAAC,CAAC;KAC5G;IAED,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IAEpE,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAEjH,CAAC;AAtBD,4CAsBC;AAED,SAAgB,aAAa,CAAC,IAAU,EAAE,gCAA+D;IAEvG,MAAM,WAAW,GAAG,6CAA6C,CAAC,IAAI,EAAE,gCAAgC,CAAC,CAAC;IAE1G,MAAM,WAAW,GAAG,IAAA,oCAAc,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEtD,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE;QACtC,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE;QACxD,OAAO,KAAK,CAAC;KACd;IAED,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IAEpE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE;QAC9C,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC;AAEd,CAAC;AAtBD,sCAsBC"}

package/src/lib/skip-non-generators-project.d.ts

@@ -0,0 +1,3 @@
+import { ProjectConfiguration, Tree } from '@nx/devkit';
+import { SkipProjectOptions } from '@rxap/generator-utilities';
+export declare function SkipNonGeneratorsProject(tree: Tree, options: SkipProjectOptions, project: ProjectConfiguration, projectName: string): boolean;

package/src/lib/skip-non-generators-project.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipNonGeneratorsProject = void 0;
+const generator_utilities_1 = require("@rxap/generator-utilities");
+const generators_1 = require("./generators");
+function SkipNonGeneratorsProject(tree, options, project, projectName) {
+    var _a;
+    if ((0, generator_utilities_1.SkipProject)(tree, options, project, projectName)) {
+        return true;
+    }
+    if (!((_a = project.tags) === null || _a === void 0 ? void 0 : _a.includes('plugin'))) {
+        return true;
+    }
+    if (!(0, generators_1.HasGenerators)(tree, project)) {
+        return true;
+    }
+    return false;
+}
+exports.SkipNonGeneratorsProject = SkipNonGeneratorsProject;
+//# sourceMappingURL=skip-non-generators-project.js.map

package/src/lib/skip-non-generators-project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"skip-non-generators-project.js","sourceRoot":"","sources":["../../../../../../packages/plugin/utilities/src/lib/skip-non-generators-project.ts"],"names":[],"mappings":";;;AAIA,mEAGmC;AACnC,6CAA6C;AAE7C,SAAgB,wBAAwB,CACtC,IAAU,EACV,OAA2B,EAC3B,OAA6B,EAC7B,WAAmB;;IAEnB,IAAI,IAAA,iCAAW,EAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE;QACpD,OAAO,IAAI,CAAC;KACb;IACD,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,IAAI,0CAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA,EAAE;QACrC,OAAO,IAAI,CAAC;KACb;IACD,IAAI,CAAC,IAAA,0BAAa,EAAC,IAAI,EAAE,OAAO,CAAC,EAAE;QACjC,OAAO,IAAI,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAjBD,4DAiBC"}