@rxap/plugin-library 16.0.0-dev.2 → 16.0.0-dev.20

package/README.md

@@ -1,5 +1,4 @@
-@rxap/plugin-library (Nx/Ng Plugin)
-======
+# @rxap/plugin-library
 
 [![npm version](https://img.shields.io/npm/v/@rxap/plugin-library?style=flat-square)](https://www.npmjs.com/package/@rxap/plugin-library)
 [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
@@ -8,154 +7,192 @@
 ![npm](https://img.shields.io/npm/dm/@rxap/plugin-library)
 ![NPM](https://img.shields.io/npm/l/@rxap/plugin-library)
 
-> A Nx/Ng plugin for build many library types.
-
 - [Installation](#installation)
-- [Schematics](#schematics)
-- [Builder](#builder)
+- [Generators](#generators)
+- [Executors](#executors)
 
 # Installation
 
-Add the plugin to your workspace:
-
+**Add the package to your workspace:**
+```bash
+yarn add @rxap/plugin-library
 ```
-ng add @rxap/plugin-library
+**Install peer dependencies:**
+```bash
+yarn add @nx/devkit@^16.5.0 @rxap/generator-ts-morph@^1.0.1-dev.6 @rxap/generator-utilities@^1.1.0-dev.7 @rxap/node-utilities@^1.1.0-dev.4 @rxap/plugin-angular@^16.1.0-dev.13 @rxap/plugin-nestjs@^16.1.0-dev.12 @rxap/plugin-utilities@^16.1.0-dev.9 @rxap/workspace-utilities@^0.1.0-dev.7 nx@^16.5.0 semver@^7.3.5 ts-morph@^18.0.0 
 ```
+**Execute the init generator:**
+```bash
+yarn nx g @rxap/plugin-library:init
+```
+# Generators
 
-> Setup the package @rxap/plugin-library for the workspace.
-
-
-*Configure the builder @rxap/plugin-library for a project:*
+## init
+> Create and update configurations to use rxap package publish concept
 
-```
-ng g @rxap/plugin-library:config [project]
+```bash
+yarn nx g @rxap/plugin-library:init
 ```
 
-> Adds @rxap/plugin-library builder to the specified project
+## fix-dependencies
+> Adds missing dependencies and removes redudant dependencies of a project
 
-# Schematics
+```bash
+yarn nx g @rxap/plugin-library:fix-dependencies
+```
 
-## config-schematics
-> Adds the builder @rxap/pack-library:build-schematics to the specified project
+## index-export
+> Generate index exports for each directory and in the src root
 
-```
-ng g @rxap/plugin-library:config-schematics
+```bash
+yarn nx g @rxap/plugin-library:index-export
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-project | string |  | The name of the project.
-type | string |  | 
+## init-plugin
+> init-plugin generator
 
-| Required |
-| --- |
-| project |
-| type |
+```bash
+yarn nx g @rxap/plugin-library:init-plugin
+```
 
-## config
-> Adds @rxap/plugin-library builder to the specified project
+## init-buildable
+> init-buildable generator
 
-```
-ng g @rxap/plugin-library:config
+```bash
+yarn nx g @rxap/plugin-library:init-buildable
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-project | string |  | The name of the project.
-schematics | boolean | true | Whether to add the build-schematics for schematics
-migrations | boolean | true | Whether to add the build-schematics for migrations
-builders | boolean | false | Whether to add the build-schematics for builders
-updatePackageGroup | boolean | true | Whether to add the update-package-group builder to the project
-updatePeerDependencies | boolean | true | Whether to add the update-peer-dependencies for builder to the project
+## init-publishable
+> init-publishable generator
 
-| Required |
-| --- |
-| project |
+```bash
+yarn nx g @rxap/plugin-library:init-publishable
+```
 
-## config-update-package-group
-> Adds @rxap/plugin-library:update-package-group builder to the specified project
+## expose-as-schematic
+> expose-as-schematic generator
 
-```
-ng g @rxap/plugin-library:config-update-package-group
+```bash
+yarn nx g @rxap/plugin-library:expose-as-schematic
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-project | string |  | The name of the project.
+## init
+> Create and update configurations to use rxap package publish concept
 
-| Required |
-| --- |
-| project |
+```bash
+yarn nx g @rxap/plugin-library:init
+```
 
-## config-update-peer-dependencies
-> Adds the builder @rxap/plugin-library:update-peer-dependencies to the specified project.
+## fix-dependencies
+> Adds missing dependencies and removes redudant dependencies of a project
 
-```
-ng g @rxap/plugin-library:config-update-peer-dependencies
+```bash
+yarn nx g @rxap/plugin-library:fix-dependencies
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-project | string |  | The name of the project.
-ignore | array |  | A list of package name regex that should not be included as peer dependencies
+## index-export
+> Generate index exports for each directory and in the src root
 
-| Required |
-| --- |
-| project |
+```bash
+yarn nx g @rxap/plugin-library:index-export
+```
 
-## ng-add
-> Setup the package @rxap/plugin-library for the workspace.
+## init-plugin
+> init-plugin generator
 
-```
-ng g @rxap/plugin-library:ng-add
+```bash
+yarn nx g @rxap/plugin-library:init-plugin
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-project | string |  | Name of the project
+## init-buildable
+> init-buildable generator
 
-# Builder
+```bash
+yarn nx g @rxap/plugin-library:init-buildable
+```
 
-## build-schematics
-> Builds the library schematics and copy all files into the out path
+## init-publishable
+> init-publishable generator
 
-**Builder name**
-```
-@rxap/plugin-library:build-schematics
+```bash
+yarn nx g @rxap/plugin-library:init-publishable
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-tsConfig | string |  | The name of the Typescript configuration file.
-outputPath | string |  | The output path of the generated files.
-assets | array |  | List of static library assets.
-type | string |  | 
+## expose-as-schematic
+> expose-as-schematic generator
 
-| Required |
-| --- |
-| tsConfig |
-| outputPath |
-| type |
-## update-package-group
-> Updates the package-group in the project package.json
-
-**Builder name**
-```
-@rxap/plugin-library:update-package-group
+```bash
+yarn nx g @rxap/plugin-library:expose-as-schematic
 ```
+# Executors
 
-Option | Type | Default | Description
---- | --- | --- | ---
-## update-peer-dependencies
-> Updates the package.json peerDependencies and will predict the next version of local dependencies.
+## update-dependencies
+> Update the local dependencies in the dist package.json. Replaces the atarix with the current package version of local dependency
 
-**Builder name**
+**project.json**
+```json
+{
+  "targets": {
+    "update-dependencies": {
+      "executor": "@rxap/plugin-library:update-dependencies"
+    }
+  }
+}
 ```
-@rxap/plugin-library:update-peer-dependencies
+
+## update-package-group
+> Update the packageGroup array with all direct depedent projects
+
+**project.json**
+```json
+{
+  "targets": {
+    "update-package-group": {
+      "executor": "@rxap/plugin-library:update-package-group"
+    }
+  }
+}
+```
+
+## readme
+> Readme generator for libraries.
+
+**project.json**
+```json
+{
+  "targets": {
+    "readme": {
+      "executor": "@rxap/plugin-library:readme"
+    }
+  }
+}
+```
+
+## run-generator
+> Executes a generator for the project
+
+**project.json**
+```json
+{
+  "targets": {
+    "run-generator": {
+      "executor": "@rxap/plugin-library:run-generator"
+    }
+  }
+}
+```
+
+## check-version
+> check-version executor
+
+**project.json**
+```json
+{
+  "targets": {
+    "check-version": {
+      "executor": "@rxap/plugin-library:check-version"
+    }
+  }
+}
 ```
 
-Option | Type | Default | Description
---- | --- | --- | ---
-ignore | array |  | A list of package name regex that should not be included as peer dependencies
-dependencies | array |  | A list of package name should be included as dependencies
-includeIndirectDependencies | boolean | false | Whether the dependencies of the direct dependencies are include in the peer dependencies list

package/executors.json

@@ -0,0 +1,29 @@
+{
+  "executors": {
+    "update-dependencies": {
+      "implementation": "./src/executors/update-dependencies/executor",
+      "schema": "./src/executors/update-dependencies/schema.json",
+      "description": "Update the local dependencies in the dist package.json. Replaces the atarix with the current package version of local dependency"
+    },
+    "update-package-group": {
+      "implementation": "./src/executors/update-package-group/executor",
+      "schema": "./src/executors/update-package-group/schema.json",
+      "description": "Update the packageGroup array with all direct depedent projects"
+    },
+    "readme": {
+      "implementation": "./src/executors/readme/executor",
+      "schema": "./src/executors/readme/schema.json",
+      "description": "Readme generator for libraries."
+    },
+    "run-generator": {
+      "implementation": "./src/executors/run-generator/executor",
+      "schema": "./src/executors/run-generator/schema.json",
+      "description": "Executes a generator for the project"
+    },
+    "check-version": {
+      "implementation": "./src/executors/check-version/executor",
+      "schema": "./src/executors/check-version/schema.json",
+      "description": "check-version executor"
+    }
+  }
+}

package/generators.json

@@ -0,0 +1,76 @@
+{
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/generator",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Create and update configurations to use rxap package publish concept"
+    },
+    "fix-dependencies": {
+      "factory": "./src/generators/fix-dependencies/generator",
+      "schema": "./src/generators/fix-dependencies/schema.json",
+      "description": "Adds missing dependencies and removes redudant dependencies of a project"
+    },
+    "index-export": {
+      "factory": "./src/generators/index-export/generator",
+      "schema": "./src/generators/index-export/schema.json",
+      "description": "Generate index exports for each directory and in the src root"
+    },
+    "init-plugin": {
+      "factory": "./src/generators/init-plugin/generator",
+      "schema": "./src/generators/init-plugin/schema.json",
+      "description": "init-plugin generator"
+    },
+    "init-buildable": {
+      "factory": "./src/generators/init-buildable/generator",
+      "schema": "./src/generators/init-buildable/schema.json",
+      "description": "init-buildable generator"
+    },
+    "init-publishable": {
+      "factory": "./src/generators/init-publishable/generator",
+      "schema": "./src/generators/init-publishable/schema.json",
+      "description": "init-publishable generator"
+    },
+    "expose-as-schematic": {
+      "factory": "./src/generators/expose-as-schematic/generator",
+      "schema": "./src/generators/expose-as-schematic/schema.json",
+      "description": "expose-as-schematic generator"
+    }
+  },
+  "schematics": {
+    "init": {
+      "factory": "./src/generators/init/index",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Create and update configurations to use rxap package publish concept"
+    },
+    "fix-dependencies": {
+      "factory": "./src/generators/fix-dependencies/index",
+      "schema": "./src/generators/fix-dependencies/schema.json",
+      "description": "Adds missing dependencies and removes redudant dependencies of a project"
+    },
+    "index-export": {
+      "factory": "./src/generators/index-export/index",
+      "schema": "./src/generators/index-export/schema.json",
+      "description": "Generate index exports for each directory and in the src root"
+    },
+    "init-plugin": {
+      "factory": "./src/generators/init-plugin/index",
+      "schema": "./src/generators/init-plugin/schema.json",
+      "description": "init-plugin generator"
+    },
+    "init-buildable": {
+      "factory": "./src/generators/init-buildable/index",
+      "schema": "./src/generators/init-buildable/schema.json",
+      "description": "init-buildable generator"
+    },
+    "init-publishable": {
+      "factory": "./src/generators/init-publishable/index",
+      "schema": "./src/generators/init-publishable/schema.json",
+      "description": "init-publishable generator"
+    },
+    "expose-as-schematic": {
+      "factory": "./src/generators/expose-as-schematic/index",
+      "schema": "./src/generators/expose-as-schematic/schema.json",
+      "description": "expose-as-schematic generator"
+    }
+  }
+}

package/package.json

@@ -1,52 +1,97 @@
 {
   "name": "@rxap/plugin-library",
-  "version": "16.0.0-dev.2",
-  "author": "Merzough Münker",
-  "homepage": "https://gitlab.com/rxap/plugins/libs/library",
-  "repository": "git@gitlab.com:rxap/schematics.git",
+  "version": "16.0.0-dev.20",
+  "type": "commonjs",
+  "executors": "./executors.json",
+  "generators": "./generators.json",
+  "publishConfig": {
+    "access": "public",
+    "directory": "../../../dist/packages/plugin/library"
+  },
+  "nx-migrations": {
+    "packageGroup": [
+      {
+        "package": "@rxap/generator-ts-morph",
+        "version": "1.0.1-dev.6"
+      },
+      {
+        "package": "@rxap/generator-utilities",
+        "version": "1.1.0-dev.7"
+      },
+      {
+        "package": "@rxap/node-utilities",
+        "version": "1.1.0-dev.4"
+      },
+      {
+        "package": "@rxap/plugin-angular",
+        "version": "16.1.0-dev.13"
+      },
+      {
+        "package": "@rxap/plugin-nestjs",
+        "version": "16.1.0-dev.12"
+      },
+      {
+        "package": "@rxap/plugin-utilities",
+        "version": "16.1.0-dev.9"
+      },
+      {
+        "package": "@rxap/workspace-utilities",
+        "version": "0.1.0-dev.7"
+      },
+      {
+        "package": "@rxap/schematics-utilities",
+        "version": "16.0.0-dev.4"
+      }
+    ]
+  },
   "keywords": [
     "rxap",
+    "packages",
     "plugin",
-    "nrwl",
-    "builder",
-    "angular",
-    "automation"
+    "library",
+    "plugin-library"
   ],
-  "license": "GPL-3.0",
-  "private": false,
+  "homepage": "https:/gitlab.com/rxap/packages/packages/plugin/library",
   "bugs": {
-    "url": "https://gitlab.com/rxap/plugins/-/issues",
-    "email": "incoming+rxap-plugins-27276642-issue-@incoming.gitlab.com"
+    "url": "https://gitlab.com/rxap/packages/-/issues",
+    "email": "incoming+rxap-packages-14898188-issue-@incoming.gitlab.com"
   },
-  "description": "A Nx/Ng plugin for build many library types.",
-  "main": "src/index.js",
-  "schematics": "./collection.json",
-  "builders": "./builders.json",
-  "ng-add": {
-    "save": "devDependencies"
+  "license": "GPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/rxap/packages.git",
+    "directory": "packages/plugin/library"
   },
-  "dependencies": {
-    "@angular-devkit/architect": "^0.1600.1",
-    "@angular-devkit/core": "^16.0.1",
-    "@angular-devkit/schematics": "^16.0.1",
-    "@rxap/schematics-utilities": "^16.0.0-dev.0",
-    "fs-extra": "9.1.0",
-    "glob": "7.1.7",
-    "nx": "16.2.1",
-    "tslib": "^2.3.1",
-    "typescript": "^5.0.4"
+  "author": {
+    "name": "Merzough Münker",
+    "email": "mmuenker@digitaix.com"
   },
-  "publishConfig": {
-    "directory": "../../dist/libs/library",
-    "access": "public"
+  "dependencies": {
+    "handlebars": "4.7.7",
+    "ignore": "^5.2.4",
+    "process": "0.11.10",
+    "tslib": "2.5.3",
+    "yaml": "2.3.1"
   },
-  "ng-update": {
-    "migrations": "./migration.json",
-    "packageGroup": [
-      "@rxap/plugin-library"
-    ]
+  "peerDependencies": {
+    "@nx/devkit": "^16.5.0",
+    "@rxap/generator-ts-morph": "^1.0.1-dev.6",
+    "@rxap/generator-utilities": "^1.1.0-dev.7",
+    "@rxap/node-utilities": "^1.1.0-dev.4",
+    "@rxap/plugin-angular": "^16.1.0-dev.13",
+    "@rxap/plugin-nestjs": "^16.1.0-dev.12",
+    "@rxap/plugin-utilities": "^16.1.0-dev.9",
+    "@rxap/workspace-utilities": "^0.1.0-dev.7",
+    "nx": "^16.5.0",
+    "semver": "^7.3.5",
+    "ts-morph": "^18.0.0",
+    "@rxap/plugin-localazy": "16.1.0-dev.6",
+    "@rxap/ts-morph": "0.1.0-dev.2",
+    "@rxap/utilities": "16.0.0-dev.13",
+    "@rxap/workspace-ts-morph": "0.1.0-dev.3"
   },
-  "gitHead": "4d5539102ddcfc828e6d22e8a15beb42e326ca12",
-  "peerDependencies": {},
+  "schematics": "./generators.json",
+  "gitHead": "baf0566162b7bd806644ee954015e7753d236911",
+  "main": "./src/index.js",
   "types": "./src/index.d.ts"
 }

package/src/executors/check-version/executor.d.ts

@@ -0,0 +1,5 @@
+import { ExecutorContext } from '@nx/devkit';
+import { CheckVersionExecutorSchema } from './schema';
+export default function runExecutor(options: CheckVersionExecutorSchema, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;

package/src/executors/check-version/executor.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const plugin_utilities_1 = require("@rxap/plugin-utilities");
+const semver_1 = require("semver");
+function runExecutor(options, context) {
+    var _a;
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        console.log('Executor ran for CheckVersion', options);
+        const projectJson = (0, plugin_utilities_1.readPackageJsonForProject)(context);
+        const rootPackageJson = (0, plugin_utilities_1.readPackageJsonForProject)(context, 'packages');
+        const targetVersion = (_a = rootPackageJson.devDependencies[options.packageName]) !== null && _a !== void 0 ? _a : rootPackageJson.dependencies[options.packageName];
+        if (!targetVersion) {
+            console.error(`The package ${options.packageName} is not installed in the root package.json`);
+            return {
+                success: false,
+            };
+        }
+        console.log(`Current '${options.packageName}' version: ${targetVersion}`);
+        console.log(`Project version: ${projectJson.version}`);
+        const version = (0, semver_1.parse)(targetVersion);
+        const versionRange = `>=${version.major}`;
+        const normalizedVersion = projectJson.version.replace(/-.*$/, '');
+        if (!(0, semver_1.satisfies)(normalizedVersion, versionRange)) {
+            console.error(`The project version '${projectJson.version}' normalized '${normalizedVersion}' is not compatible with the '${options.packageName}' version '${targetVersion}' with the range '${versionRange}'`);
+            return {
+                success: false,
+            };
+        }
+        return {
+            success: true,
+        };
+    });
+}
+exports.default = runExecutor;
+//# sourceMappingURL=executor.js.map

package/src/executors/check-version/executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/library/src/executors/check-version/executor.ts"],"names":[],"mappings":";;;AACA,6DAAmE;AACnE,mCAGgB;AAGhB,SAA8B,WAAW,CACvC,OAAmC,EACnC,OAAwB;;;QAExB,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,OAAO,CAAC,CAAC;QAEtD,MAAM,WAAW,GAAG,IAAA,4CAAyB,EAAC,OAAO,CAAC,CAAC;QACvD,MAAM,eAAe,GAAG,IAAA,4CAAyB,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEvE,MAAM,aAAa,GAAG,MAAA,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,mCACxE,eAAe,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEpD,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO,CAAC,KAAK,CAAC,eAAgB,OAAO,CAAC,WAAY,4CAA4C,CAAC,CAAC;YAChG,OAAO;gBACL,OAAO,EAAE,KAAK;aACf,CAAC;SACH;QAED,OAAO,CAAC,GAAG,CAAC,YAAa,OAAO,CAAC,WAAY,cAAe,aAAc,EAAE,CAAC,CAAC;QAC9E,OAAO,CAAC,GAAG,CAAC,oBAAqB,WAAW,CAAC,OAAQ,EAAE,CAAC,CAAC;QAEzD,MAAM,OAAO,GAAG,IAAA,cAAK,EAAC,aAAa,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,KAAM,OAAO,CAAC,KAAM,EAAE,CAAC;QAE5C,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAElE,IAAI,CAAC,IAAA,kBAAS,EAAC,iBAAiB,EAAE,YAAY,CAAC,EAAE;YAC/C,OAAO,CAAC,KAAK,CAAC,wBAAyB,WAAW,CAAC,OAAQ,iBAAkB,iBAAkB,iCAAkC,OAAO,CAAC,WAAY,cAAe,aAAc,qBAAsB,YAAa,GAAG,CAAC,CAAC;YAC1N,OAAO;gBACL,OAAO,EAAE,KAAK;aACf,CAAC;SACH;QAED,OAAO;YACL,OAAO,EAAE,IAAI;SACd,CAAC;;CACH;AAtCD,8BAsCC"}

package/src/executors/check-version/schema.d.ts

@@ -0,0 +1,3 @@
+export interface CheckVersionExecutorSchema {
+  packageName: string;
+}

package/src/executors/check-version/schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "version": 2,
+  "title": "CheckVersion executor",
+  "description": "",
+  "type": "object",
+  "properties": {
+    "packageName": {
+      "type": "string",
+      "description": "The name of the package used as minimum version reference"
+    }
+  },
+  "required": [
+    "packageName"
+  ]
+}

package/src/executors/readme/executor.d.ts

@@ -0,0 +1,5 @@
+import { ExecutorContext } from '@nx/devkit';
+import { ReadmeExecutorSchema } from './schema';
+export default function runExecutor(options: ReadmeExecutorSchema, context: ExecutorContext): Promise<{
+    success: boolean;
+}>;