@rxap/plugin-angular 20.0.2 → 20.0.3-dev.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [20.0.3-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.0.2...@rxap/plugin-angular@20.0.3-dev.0) (2025-02-17)
+
+**Note:** Version bump only for package @rxap/plugin-angular
+
 ## [20.0.2](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.0.1...@rxap/plugin-angular@20.0.2) (2025-02-13)
 
 **Note:** Version bump only for package @rxap/plugin-angular

package/README.md

@@ -1,4 +1,4 @@
-# @rxap/plugin-angular
+This package provides generators and executors for Angular projects within an Nx workspace. It helps initialize and configure Angular applications and libraries with Rxap-specific defaults and utilities. It also includes executors for tasks like checking ng-package configurations, managing application configurations, and generating i18n files.
 
 [![npm version](https://img.shields.io/npm/v/@rxap/plugin-angular?style=flat-square)](https://www.npmjs.com/package/@rxap/plugin-angular)
 [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
@@ -10,7 +10,19 @@
 - [Installation](#installation)
 - [Guides](#guides)
 - [Generators](#generators)
+  - [init](#init)
+  - [init-application](#init-application)
+  - [init-library](#init-library)
+  - [fix-schematic](#fix-schematic)
+  - [schematic](#schematic)
+  - [init-feature](#init-feature)
+  - [init-feature-library](#init-feature-library)
+  - [init-component](#init-component)
 - [Executors](#executors)
+  - [tailwind](#tailwind)
+  - [check-ng-package](#check-ng-package)
+  - [i18n](#i18n)
+  - [config](#config)
 
 # Installation
 
@@ -138,168 +150,198 @@ nx g @rxap/plugin-angular:init-application \
 > init generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:init
+nx g @rxap/plugin-angular:init
 ```
 
+Option | Type | Default | Description
+--- | --- | --- | ---
+projects | array |  | 
+overwrite | boolean | false | Whether to overwrite existing files
+skipFormat | boolean | false | 
+skipProjects | boolean | false | Whether to skip executing project specific initialization
+prefix | string |  | The prefix for the angular components
+withSharedLibraries | boolean | false | Whether to add shared libraries
+
 ## init-application
 > init-application generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:init-application
+nx g @rxap/plugin-angular:init-application
 ```
 
+Option | Type | Default | Description
+--- | --- | --- | ---
+project | string |  | 
+projects | array |  | 
+incrementalBuild | boolean |  | Whether to enable incremental build
+moduleFederation | string |  | 
+layoutRoutePath | string |  | Route path for layout children
+standaloneImport | boolean |  | Whether to import the mfe remote as a standalone import
+skipDocker | boolean |  | Whether to skip the docker configuration
+host | string |  | Host project for module federation
+deploy | string |  | Add target to deploy to after build
+sentry | boolean | true | 
+apiStatusCheck | boolean | false | 
+authentication |  |  | 
+openApi | boolean | false | Whether to enable OpenAPI
+openApiLegacy | boolean |  | 
+config | boolean | true | Whether to enable configuration
+localazy | boolean | false | Whether to enable Localazy
+i18n | boolean | false | Whether to enable i18n
+serviceWorker | boolean | true | Whether to enable service worker
+languages | array |  | 
+material | boolean | true | Whether to enable Angular Material
+generateMain | boolean |  | Whether to generate the main file
+overwrite | boolean |  | Whether to overwrite existing files
+cleanup | boolean | true | Whether to cleanup files
+monolithic | boolean | true | Whether to generate a monolithic application
+localazyReadKey | string |  | Localazy read key
+authentik | boolean |  | Use authentik for authentication
+oauth | boolean |  | Use OAuth for authentication
+skipProjects | boolean |  | Whether to skip executing project specific initialization
+skipFormat | boolean |  | 
+coerce |  |  | 
+
 ## init-library
 > init-library generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:init-library
+nx g @rxap/plugin-angular:init-library
 ```
 
+Option | Type | Default | Description
+--- | --- | --- | ---
+project | string |  | 
+projects | array |  | 
+overwrite | boolean | false | Whether to overwrite existing files
+skipProjects | boolean | false | Whether to skip executing project specific initialization
+skipFormat | boolean | false | 
+indexExport | boolean | true | Whether to add the index-export target to the library
+coerce |  | true | 
+targets | object |  | 
+
 ## fix-schematic
 > fix-schematic generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:fix-schematic
+nx g @rxap/plugin-angular:fix-schematic
 ```
 
+Option | Type | Default | Description
+--- | --- | --- | ---
+project | string |  | The name of the project.
+
 ## schematic
 > Create a Schematic for a project.
 
 ```bash
-yarn nx g @rxap/plugin-angular:schematic
+nx g @rxap/plugin-angular:schematic
 ```
 
+Option | Type | Default | Description
+--- | --- | --- | ---
+project | string |  | The name of the project.
+name | string |  | Schematic name.
+description | string |  | Schematic description.
+skipFormat | boolean | false | Do not format files with prettier.
+
 ## init-feature
 > init-feature generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:init-feature
+nx g @rxap/plugin-angular:init-feature
 ```
 
+Option | Type | Default | Description
+--- | --- | --- | ---
+name | string |  | The name of the feature
+project | string |  | The name of the project where the feature should be added
+overwrite | boolean |  | If the feature should be overwritten if it already exists
+skipFormat | boolean | false | 
+apiStatusCheck | boolean | false | 
+navigation | object |  | 
+
 ## init-feature-library
 > init-feature-library generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:init-feature-library
-```
-
-## init-component
-> init-component generator
-
-```bash
-yarn nx g @rxap/plugin-angular:init-component
-```
-
-## init
-> init generator
-
-```bash
-yarn nx g @rxap/plugin-angular:init
-```
-
-## init-application
-> init-application generator
-
-```bash
-yarn nx g @rxap/plugin-angular:init-application
-```
-
-## init-library
-> init-library generator
-
-```bash
-yarn nx g @rxap/plugin-angular:init-library
-```
-
-## fix-schematic
-> fix-schematic generator
-
-```bash
-yarn nx g @rxap/plugin-angular:fix-schematic
+nx g @rxap/plugin-angular:init-feature-library
 ```
 
-## schematic
-> Create a Schematic for a project.
-
-```bash
-yarn nx g @rxap/plugin-angular:schematic
-```
-
-## init-feature
-> init-feature generator
-
-```bash
-yarn nx g @rxap/plugin-angular:init-feature
-```
+Option | Type | Default | Description
+--- | --- | --- | ---
+project | string |  | 
+projects | array |  | 
+overwrite | boolean | false | Whether to overwrite existing files
+skipProjects | boolean | false | Whether to skip executing project specific initialization
+skipFormat | boolean | false | 
+routes | boolean | true | Whether the library exposes routes
+targets | object |  | 
 
 ## init-component
 > init-component generator
 
 ```bash
-yarn nx g @rxap/plugin-angular:init-component
+nx g @rxap/plugin-angular:init-component
 ```
 
-## init-feature-library
-> init-feature-library generator
-
-```bash
-yarn nx g @rxap/plugin-angular:init-feature-library
-```
+Option | Type | Default | Description
+--- | --- | --- | ---
+directory | string |  | The directory at which to create the component file, relative to the current workspace. Default is a folder with the same name as the component in the project root.
+feature | string |  | The name of the feature.
+project | string |  | The name of the project.
+name | string |  | The name of the component.
+prefix | string |  | The prefix to apply to the generated component selector.
+displayBlock | boolean | false | Specifies if the style will contain `:host { display: block; }`.
+inlineStyle | boolean | false | Include styles inline in the component.ts file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component.ts file.
+inlineTemplate | boolean | false | Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.
+standalone | boolean | true | Whether the generated component is standalone. _Note: This is only supported in Angular versions >= 14.1.0_.
+viewEncapsulation | string |  | The view encapsulation strategy to use in the new component.
+changeDetection | string | OnPush | The change detection strategy to use in the new component.
+module | string |  | The filename or path to the NgModule that will declare this component.
+style | string | scss | The file extension or preprocessor to use for style files, or `none` to skip generating the style file.
+skipTests | boolean | false | Do not create `spec.ts` test files for the new component.
+flat | boolean | false | Create the new files at the top level of the current project.
+skipImport | boolean | false | Do not import this component into the owning NgModule.
+selector | string |  | The HTML selector to use for this component.
+skipSelector | boolean | false | Specifies if the component should have a selector or not.
+type | string | component | Adds a developer-defined type to the filename, in the format `name.type.ts`.
+defaultExport | boolean | false | Specifies if the component should be the default export of file.
+export | boolean | false | Specifies if the component should be exported in the declaring `NgModule`. Additionally, if the project is a library, the component will be exported from the project's entry point (normally `index.ts`) if the module it belongs to is also exported or if the component is standalone.
+skipFormat | boolean | false | Skip formatting files.
+interactionTests | boolean | true | Set up Storybook interaction tests.
+cypressProject | string |  | The Cypress project to generate the stories under. By default, inferred from `projectName`.
+specDirectory | string |  | Directory where to place the generated spec file. By default matches the value of the `componentPath` option.
 # Executors
 
 ## tailwind
 > tailwind executor
 
-**project.json**
-```json
-{
-  "targets": {
-    "tailwind": {
-      "executor": "@rxap/plugin-angular:tailwind"
-    }
-  }
-}
-```
+
+Option | Type | Default | Description
+--- | --- | --- | ---
+config | string | tailwind.config.js | 
+input | string | src/styles/theme.scss | 
+output | string | theme.css | 
+minify | boolean | false | 
 
 ## check-ng-package
 > check-ng-package executor
 
-**project.json**
-```json
-{
-  "targets": {
-    "check-ng-package": {
-      "executor": "@rxap/plugin-angular:check-ng-package"
-    }
-  }
-}
-```
 
 ## i18n
 > i18n executor
 
-**project.json**
-```json
-{
-  "targets": {
-    "i18n": {
-      "executor": "@rxap/plugin-angular:i18n"
-    }
-  }
-}
-```
+
+Option | Type | Default | Description
+--- | --- | --- | ---
+availableLanguages | array |  | 
+defaultLanguage | string |  | 
+indexHtmlTemplate | string | i18n.index.html.hbs | 
+buildTarget | string |  | 
+assets |  |  | 
 
 ## config
 > config executor
 
-**project.json**
-```json
-{
-  "targets": {
-    "config": {
-      "executor": "@rxap/plugin-angular:config"
-    }
-  }
-}
-```
 

package/package.json

@@ -1,14 +1,14 @@
 {
-  "version": "20.0.2",
+  "version": "20.0.3-dev.0",
   "name": "@rxap/plugin-angular",
   "description": "This package provides generators and executors for Angular projects within an Nx workspace. It helps initialize and configure Angular applications and libraries with Rxap-specific defaults and utilities. It also includes executors for tasks like checking ng-package configurations, managing application configurations, and generating i18n files.\n",
   "license": "GPL-3.0-or-later",
   "dependencies": {
     "@nx/angular": "20.4.2",
     "@nx/devkit": "20.4.2",
-    "@rxap/plugin-application": "^20.0.1",
-    "@rxap/plugin-library": "^20.1.1",
-    "@rxap/plugin-utilities": "^20.0.1",
+    "@rxap/plugin-application": "^20.0.2-dev.0",
+    "@rxap/plugin-library": "^20.1.2-dev.0",
+    "@rxap/plugin-utilities": "^20.0.2-dev.0",
     "@rxap/ts-morph": "^1.5.3",
     "@rxap/utilities": "^16.4.2",
     "@rxap/workspace-ts-morph": "^19.1.9",
@@ -56,7 +56,7 @@
   },
   "schematics": "./generators.json",
   "type": "commonjs",
-  "gitHead": "402887412674e616554624b2c11770ca36982b78",
+  "gitHead": "9c6b5087587f25e790ac3eb934055381506e1f08",
   "exports": {
     "./package.json": "./package.json",
     ".": {