@o3r/schematics 8.2.0-alpha.2 → 8.2.0-alpha.22

package/README.md

@@ -1,212 +1,17 @@
-<h1 align="center">Otter Framework</h1>
-<p align="center">
-  <img src="./.attachments/logo.png" alt="Super cute Otter!"/>
-</p>
+# Otter schematics
 
-<br />
-<br />
+This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/otter/tree/main/docs/core/MODULE.md).
 
-## Description
-The **Otter** project is a highly modular framework whose goal is to provide a common platform to accelerate and facilitate the development on Angular web applications.
-It is split into several units to cover different aspects of these applications (localization, testing, customization, etc.).
-Also, to customize an application, metadata can be extracted from the application source code and injected into a CMS to manage dynamic configuration.
-
-> **Note**:  The full documentation is available [here](./docs/README.md).
-
-## Built With
-
-* [Angular](https://angular.io/)
-* [Typescript](https://www.typescriptlang.org/)
-* [RxJs](http://reactivex.io/rxjs/)
-* [Redux](http://redux.js.org/)
-* [Sass](http://sass-lang.com/)
-* [Nx](https://nx.dev/)
-
-## Get Started
-
-A new application can be set up with these simple commands:
-
-```shell
-# Starting a new angular application
-npm install -g @angular/cli
-ng new my-app
-
-# Add Otter framework
-ng add @o3r/core
-```
-
-> **Note**: Please refer to [Otter Get Started](./docs/core/START_NEW_APPLICATION.md) and [Angular Get Started](https://angular.io/guide/setup-local#install-the-angular-cli) for complete documentation.
-
-## Contributing
-
-Please read the [Contributing](./CONTRIBUTING.md) file for details on our code of conduct and the process to submit pull requests.
-
-## Versioning
-
-Please refer to [Security file](./SECURITY.md).
-
-## License
-
-Please refer to the [License file](./LICENSE).
-
-## Acknowledgments
-
-The Otter Team, @AmadeusITGroup/otter_admins, is responsible for the review of the code of this repository.
-Any bug of feature request can be addressed via [issue](https://github.com/AmadeusITGroup/otter/issues/new) report.
-
-## Developer
-
-### Building and Testing library
-
-These documents describe how to set up your development environment to build and test the framework.
-It also explains the basic mechanics of using `git`, `node`, and `npm`.
-
-- [Description](#description)
-- [Built With](#built-with)
-- [Get Started](#get-started)
-- [Contributing](#contributing)
-- [Versioning](#versioning)
-- [License](#license)
-- [Acknowledgments](#acknowledgments)
-- [Developer](#developer)
-  - [Building and Testing library](#building-and-testing-library)
-    - [Prerequisite Software](#prerequisite-software)
-    - [Getting the Sources](#getting-the-sources)
-    - [Installing NPM Modules](#installing-npm-modules)
-    - [Build command](#build-command)
-    - [Running tests locally](#running-tests-locally)
-    - [Manage task cache](#manage-task-cache)
-    - [Debugging with Visual Studio Code](#debugging-with-visual-studio-code)
-    - [Link local packages](#link-local-packages)
-
-Refer to the [contribution guidelines](./CONTRIBUTING.md)
-if you'd like to contribute to the framework.
-
-#### Prerequisite Software
-
-Before you can build and test Otter modules, you must install and configure the
-following products on your development machine:
-
-* [Git](http://git-scm.com) and/or the **GitHub app** (for [Mac](http://mac.github.com) or
-  [Windows](http://windows.github.com))
-  * [GitHub's Guide to Installing
-    Git](https://help.github.com/articles/set-up-git) is a good source of information.
-
-* [Node.js](http://nodejs.org), (version `>=10.0.0`)
-  * This is used to run tests and generate distributable files. We also use Node's Package Manager, `npm`
-    (version `>3.8.x`), which comes with Node. Depending on your system, you can install Node either from
-    source or as a pre-packaged bundle.
-  
-* [Yarn](https://yarnpkg.com/lang/en/docs/install/), a Node's Package Manager
-  * You can install yarn using NPM manager (coming with Node.js).
-    The version of Yarn currently used is embedded in the repository. In case you need to link this library with your project, you can check the section "Link local packages".
-
-* [Chrome](https://www.google.com/chrome/browser/desktop/index.html)
-  * We use Chrome to run our tests.
-
-#### Getting the sources
-
-Clone the Otter repository using the button `Code` or using the following git command:
-
-```shell
-git clone https://github.com/AmadeusITGroup/otter.git
-```
-
-#### Installing NPM modules
-
-Next, install the JavaScript modules needed to build:
-
-```shell
-# Install library project dependencies (package.json)
-yarn install
-```
-
-#### Build command
-
-To build the modules, run:
-
-```shell
-yarn run build
-```
-
-Each module can be built independently thanks to [Nx](https://nx.dev/packages/nx/documents/run) commands:
-
-```shell
-# ex: Build Core package only
-yarn nx build core
-```
-
-> **Note**: Results are put in the `dist` of each module (`packages/@<scope>/<module>/dist`).
-
-#### Running tests locally
-
-Check the formatting:
-
-```shell
-yarn run lint
-```
-
-Check Unit Tests:
-
-```shell
-yarn run test
-```
-
-Each module can be test independently thanks to [Nx](https://nx.dev/packages/nx/documents/run) commands:
-
-```shell
-# ex: Test Core package only
-yarn nx test core
-
-# ex: Lint Core package only
-yarn nx lint core
-```
-
-#### Manage task cache
+This module provides basic utilities and generic rules (install, lint) reused in other package schematics.
 
-When running the Build, Lint, or Test commands, **Nx** can use its [cache mechanism](https://nx.dev/concepts/how-caching-works).
-In some cases, it may be useful to clear the cache to investigate an issue. This can be done with the following command:
+## How to install
 
 ```shell
-yarn nx reset
+ng add @o3r/schematics
 ```
 
-#### Debugging with Visual Studio Code
-
-The repository contains the mandatory configuration and the recommended VSCode plugins to ensure optimal comfort and productivity while developing on the Otter Framework.
-
-The default configuration of the repository provides a way to run Unit Tests one by one and to define, within VSCode, break points using the `vscode-jest-tests` debugger task.
-
-#### Link local packages
+> **Warning**: this module requires [@o3r/core](https://www.npmjs.com/package/@o3r/core) to be installed.
 
-For Yarn v1, add the `resolutions` property in the main package.json. It should be filled with the relative path to the `dist` of the local packages you want to link. The protocol `link:` can be used.
-
-NOTE: It will not import the transitive dependencies of the linked packages.
-
-Example:
-
-```json
-{
-  "resolutions": {
-    "@o3r/localization": "./relative/path/to/otter/packages/@o3r/localization/dist",
-    "@o3r/core": "link:./relative/path/to/otter/packages/@o3r/core/dist",
-  }
-}
-```
-
-For Yarn v2+, the protocol `portal:` can also be used.
-
-NOTE: The portal protocol will also import all the transitive dependencies of the linked packages.
-Please keep in mind that mismatched versions of these dependencies may cause some issues.
-
-Example:
+## Description
 
-```json
-{
-  "resolutions": {
-    "@o3r/localization": "./relative/path/to/otter/library/@o3r/localization/dist",
-    "@o3r/core": "link:./relative/path/to/otter/library/@o3r/core/dist",
-    "@o3r/rules-engine": "portal:./relative/path/to/otter/library/@o3r/rules-engine/dist",
-  }
-}
-```
+This is a technical package to be used as dependency by [Otter modules](https://github.com/AmadeusITGroup/otter/tree/main/docs/core/MODULE.md) providing helpers to used in [Schematics](https://angular.io/guide/schematics) development.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/schematics",
-  "version": "8.2.0-alpha.2",
+  "version": "8.2.0-alpha.22",
   "description": "Schematics module of the Otter framework",
   "main": "./src/index.js",
   "keywords": [
@@ -28,7 +28,7 @@
     }
   },
   "dependencies": {
-    "@o3r/dev-tools": "^8.2.0-alpha.2",
+    "@o3r/dev-tools": "^8.2.0-alpha.22",
     "comment-json": "^4.1.0",
     "globby": "^11.1.0",
     "minimatch": "^6.1.6",
@@ -47,12 +47,12 @@
     "@angular/core": "~15.2.0",
     "@angular/platform-browser": "~15.2.0",
     "@angular/platform-browser-dynamic": "~15.2.0",
-    "@nrwl/cli": "~15.8.0",
-    "@nrwl/jest": "~15.8.0",
-    "@nrwl/js": "~15.8.0",
-    "@nrwl/linter": "~15.8.0",
-    "@o3r/build-helpers": "^8.2.0-alpha.2",
-    "@o3r/eslint-plugin": "^8.2.0-alpha.2",
+    "@nrwl/cli": "~15.9.0",
+    "@nrwl/jest": "~15.9.0",
+    "@nrwl/js": "~15.9.0",
+    "@nrwl/linter": "~15.9.0",
+    "@o3r/build-helpers": "^8.2.0-alpha.22",
+    "@o3r/eslint-plugin": "^8.2.0-alpha.22",
     "@schematics/angular": "~15.2.0",
     "@types/jest": "~28.1.2",
     "@types/node": "^17.0.45",
@@ -69,7 +69,7 @@
     "jest": "~28.1.1",
     "jest-junit": "^14.0.0",
     "jsonschema": "~1.4.1",
-    "nx": "~15.8.0",
+    "nx": "~15.9.0",
     "rxjs": "^7.4.0",
     "ts-jest": "^28.0.5",
     "type-fest": "^3.6.1",

package/src/rule-factories/ng-add/index.js

@@ -18,7 +18,7 @@ function ngAddPackages(packages, options) {
             return;
         }
     };
-    return async (_tree, context) => {
+    return async (tree, context) => {
         if (packages.length > 0) {
             context.logger.info(`'${options?.parentPackageInfo || ''}' - 'ng add' has been launched for the following packages:`);
             for (const packageName of packages) {
@@ -29,7 +29,7 @@ function ngAddPackages(packages, options) {
                 }
             }
         }
-        return;
+        return () => tree;
     };
 }
 exports.ngAddPackages = ngAddPackages;

package/src/rule-factories/ng-add/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/rule-factories/ng-add/index.ts"],"names":[],"mappings":";;;AACA,6CAA8E;AAE9E;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,QAAkB,EAAE,OAA6B;IAC7E,MAAM,mBAAmB,GAAG,KAAK,EAAE,WAAmB,EAAE,EAAE;;QACxD,IAAI;YACF,OAAO,CAAC,YAAa,GAAG,WAAW,eAAe,4CAAC,CAAC,CAAC,OAAO,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,OAAO;SACR;IACH,CAAC,CAAC;IACF,OAAO,KAAK,EAAE,KAAW,EAAE,OAAyB,EAAE,EAAE;QACtD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,OAAO,EAAE,iBAAiB,IAAI,EAAE,4DAA4D,CAAC,CAAC;YACtH,KAAK,MAAM,WAAW,IAAI,QAAQ,EAAE;gBAClC,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,WAAW,CAAC,CAAC;gBAChE,IAAI,CAAC,gBAAgB,IAAI,OAAO,EAAE,OAAO,KAAK,gBAAgB,EAAE;oBAC9D,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,WAAW,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBACxH,OAAO,CAAC,OAAO,CAAC,IAAI,4BAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;iBACjE;aACF;SACF;QACD,OAAO;IACT,CAAC,CAAC;AACJ,CAAC;AArBD,sCAqBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/rule-factories/ng-add/index.ts"],"names":[],"mappings":";;;AACA,6CAA8E;AAE9E;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,QAAkB,EAAE,OAA6B;IAC7E,MAAM,mBAAmB,GAAG,KAAK,EAAE,WAAmB,EAAE,EAAE;;QACxD,IAAI;YACF,OAAO,CAAC,YAAa,GAAG,WAAW,eAAe,4CAAC,CAAC,CAAC,OAAO,CAAC;SAC9D;QAAC,OAAO,CAAC,EAAE;YACV,OAAO;SACR;IACH,CAAC,CAAC;IACF,OAAO,KAAK,EAAE,IAAU,EAAE,OAAyB,EAAE,EAAE;QACrD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,OAAO,EAAE,iBAAiB,IAAI,EAAE,4DAA4D,CAAC,CAAC;YACtH,KAAK,MAAM,WAAW,IAAI,QAAQ,EAAE;gBAClC,MAAM,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,WAAW,CAAC,CAAC;gBAChE,IAAI,CAAC,gBAAgB,IAAI,OAAO,EAAE,OAAO,KAAK,gBAAgB,EAAE;oBAC9D,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,WAAW,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBACxH,OAAO,CAAC,OAAO,CAAC,IAAI,4BAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;iBACjE;aACF;SACF;QACD,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AArBD,sCAqBC"}

package/src/utility/index.d.ts

@@ -10,4 +10,5 @@ export * from './sub-entry';
 export * from './template-property.helper';
 export * from './matching-peers';
 export * from './package-version';
+export * from './monorepo';
 //# sourceMappingURL=index.d.ts.map

package/src/utility/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utility/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utility/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

package/src/utility/index.js

@@ -13,4 +13,5 @@ tslib_1.__exportStar(require("./sub-entry"), exports);
 tslib_1.__exportStar(require("./template-property.helper"), exports);
 tslib_1.__exportStar(require("./matching-peers"), exports);
 tslib_1.__exportStar(require("./package-version"), exports);
+tslib_1.__exportStar(require("./monorepo"), exports);
 //# sourceMappingURL=index.js.map

package/src/utility/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utility/index.ts"],"names":[],"mappings":";;;AAAA,gDAAsB;AACtB,yDAA+B;AAC/B,sDAA4B;AAC5B,uDAA6B;AAC7B,sDAA4B;AAC5B,oDAA0B;AAC1B,oDAA0B;AAC1B,mDAAyB;AACzB,sDAA4B;AAC5B,qEAA2C;AAC3C,2DAAiC;AACjC,4DAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utility/index.ts"],"names":[],"mappings":";;;AAAA,gDAAsB;AACtB,yDAA+B;AAC/B,sDAA4B;AAC5B,uDAA6B;AAC7B,sDAA4B;AAC5B,oDAA0B;AAC1B,oDAA0B;AAC1B,mDAAyB;AACzB,sDAA4B;AAC5B,qEAA2C;AAC3C,2DAAiC;AACjC,4DAAkC;AAClC,qDAA2B"}

package/src/utility/monorepo.d.ts

@@ -0,0 +1,17 @@
+import type { Tree } from '@angular-devkit/schematics';
+/**
+ * Find the relative path to a configuration file at the monorepo root
+ *
+ * @param tree
+ * @param files List of files to look for, the first of the list will used
+ * @param originPath Path from where to calculate the relative path
+ * @returns
+ */
+export declare function findConfigFileRelativePath(tree: Tree, files: string[], originPath: string): string;
+/**
+ * Determine if we are in an Nx Monorepo context
+ *
+ * @param tree
+ */
+export declare function isNxContext(tree: Tree): boolean;
+//# sourceMappingURL=monorepo.d.ts.map

package/src/utility/monorepo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"monorepo.d.ts","sourceRoot":"","sources":["../../../src/utility/monorepo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAGvD;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,UAOzF;AACD;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,WAErC"}

package/src/utility/monorepo.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNxContext = exports.findConfigFileRelativePath = void 0;
+const path = require("node:path");
+/**
+ * Find the relative path to a configuration file at the monorepo root
+ *
+ * @param tree
+ * @param files List of files to look for, the first of the list will used
+ * @param originPath Path from where to calculate the relative path
+ * @returns
+ */
+function findConfigFileRelativePath(tree, files, originPath) {
+    const foundFile = files.find((file) => tree.exists(`/${file}`));
+    if (foundFile === undefined) {
+        return '';
+    }
+    return path.posix.relative(originPath, `/${foundFile}`);
+}
+exports.findConfigFileRelativePath = findConfigFileRelativePath;
+/**
+ * Determine if we are in an Nx Monorepo context
+ *
+ * @param tree
+ */
+function isNxContext(tree) {
+    return tree.exists('/nx.json');
+}
+exports.isNxContext = isNxContext;
+//# sourceMappingURL=monorepo.js.map

package/src/utility/monorepo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monorepo.js","sourceRoot":"","sources":["../../../src/utility/monorepo.ts"],"names":[],"mappings":";;;AACA,kCAAkC;AAElC;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CAAC,IAAU,EAAE,KAAe,EAAE,UAAkB;IACxF,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;IAChE,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,OAAO,EAAE,CAAC;KACX;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,SAAS,EAAE,CAAC,CAAC;AAC1D,CAAC;AAPD,gEAOC;AACD;;;;GAIG;AACH,SAAgB,WAAW,CAAC,IAAU;IACpC,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAFD,kCAEC"}