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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +145 -103
  3. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [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)
7
+
8
+ **Note:** Version bump only for package @rxap/plugin-angular
9
+
10
+ ## [20.0.2](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.0.1...@rxap/plugin-angular@20.0.2) (2025-02-13)
11
+
12
+ **Note:** Version bump only for package @rxap/plugin-angular
13
+
6
14
  ## [20.0.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-angular@20.0.1-dev.22...@rxap/plugin-angular@20.0.1) (2025-02-13)
7
15
 
8
16
  **Note:** Version bump only for package @rxap/plugin-angular
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @rxap/plugin-angular
1
+ 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.
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@rxap/plugin-angular?style=flat-square)](https://www.npmjs.com/package/@rxap/plugin-angular)
4
4
  [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
@@ -10,7 +10,19 @@
10
10
  - [Installation](#installation)
11
11
  - [Guides](#guides)
12
12
  - [Generators](#generators)
13
+ - [init](#init)
14
+ - [init-application](#init-application)
15
+ - [init-library](#init-library)
16
+ - [fix-schematic](#fix-schematic)
17
+ - [schematic](#schematic)
18
+ - [init-feature](#init-feature)
19
+ - [init-feature-library](#init-feature-library)
20
+ - [init-component](#init-component)
13
21
  - [Executors](#executors)
22
+ - [tailwind](#tailwind)
23
+ - [check-ng-package](#check-ng-package)
24
+ - [i18n](#i18n)
25
+ - [config](#config)
14
26
 
15
27
  # Installation
16
28
 
@@ -138,168 +150,198 @@ nx g @rxap/plugin-angular:init-application \
138
150
  > init generator
139
151
 
140
152
  ```bash
141
- yarn nx g @rxap/plugin-angular:init
153
+ nx g @rxap/plugin-angular:init
142
154
  ```
143
155
 
156
+ Option | Type | Default | Description
157
+ --- | --- | --- | ---
158
+ projects | array | |
159
+ overwrite | boolean | false | Whether to overwrite existing files
160
+ skipFormat | boolean | false |
161
+ skipProjects | boolean | false | Whether to skip executing project specific initialization
162
+ prefix | string | | The prefix for the angular components
163
+ withSharedLibraries | boolean | false | Whether to add shared libraries
164
+
144
165
  ## init-application
145
166
  > init-application generator
146
167
 
147
168
  ```bash
148
- yarn nx g @rxap/plugin-angular:init-application
169
+ nx g @rxap/plugin-angular:init-application
149
170
  ```
150
171
 
172
+ Option | Type | Default | Description
173
+ --- | --- | --- | ---
174
+ project | string | |
175
+ projects | array | |
176
+ incrementalBuild | boolean | | Whether to enable incremental build
177
+ moduleFederation | string | |
178
+ layoutRoutePath | string | | Route path for layout children
179
+ standaloneImport | boolean | | Whether to import the mfe remote as a standalone import
180
+ skipDocker | boolean | | Whether to skip the docker configuration
181
+ host | string | | Host project for module federation
182
+ deploy | string | | Add target to deploy to after build
183
+ sentry | boolean | true |
184
+ apiStatusCheck | boolean | false |
185
+ authentication | | |
186
+ openApi | boolean | false | Whether to enable OpenAPI
187
+ openApiLegacy | boolean | |
188
+ config | boolean | true | Whether to enable configuration
189
+ localazy | boolean | false | Whether to enable Localazy
190
+ i18n | boolean | false | Whether to enable i18n
191
+ serviceWorker | boolean | true | Whether to enable service worker
192
+ languages | array | |
193
+ material | boolean | true | Whether to enable Angular Material
194
+ generateMain | boolean | | Whether to generate the main file
195
+ overwrite | boolean | | Whether to overwrite existing files
196
+ cleanup | boolean | true | Whether to cleanup files
197
+ monolithic | boolean | true | Whether to generate a monolithic application
198
+ localazyReadKey | string | | Localazy read key
199
+ authentik | boolean | | Use authentik for authentication
200
+ oauth | boolean | | Use OAuth for authentication
201
+ skipProjects | boolean | | Whether to skip executing project specific initialization
202
+ skipFormat | boolean | |
203
+ coerce | | |
204
+
151
205
  ## init-library
152
206
  > init-library generator
153
207
 
154
208
  ```bash
155
- yarn nx g @rxap/plugin-angular:init-library
209
+ nx g @rxap/plugin-angular:init-library
156
210
  ```
157
211
 
212
+ Option | Type | Default | Description
213
+ --- | --- | --- | ---
214
+ project | string | |
215
+ projects | array | |
216
+ overwrite | boolean | false | Whether to overwrite existing files
217
+ skipProjects | boolean | false | Whether to skip executing project specific initialization
218
+ skipFormat | boolean | false |
219
+ indexExport | boolean | true | Whether to add the index-export target to the library
220
+ coerce | | true |
221
+ targets | object | |
222
+
158
223
  ## fix-schematic
159
224
  > fix-schematic generator
160
225
 
161
226
  ```bash
162
- yarn nx g @rxap/plugin-angular:fix-schematic
227
+ nx g @rxap/plugin-angular:fix-schematic
163
228
  ```
164
229
 
230
+ Option | Type | Default | Description
231
+ --- | --- | --- | ---
232
+ project | string | | The name of the project.
233
+
165
234
  ## schematic
166
235
  > Create a Schematic for a project.
167
236
 
168
237
  ```bash
169
- yarn nx g @rxap/plugin-angular:schematic
238
+ nx g @rxap/plugin-angular:schematic
170
239
  ```
171
240
 
241
+ Option | Type | Default | Description
242
+ --- | --- | --- | ---
243
+ project | string | | The name of the project.
244
+ name | string | | Schematic name.
245
+ description | string | | Schematic description.
246
+ skipFormat | boolean | false | Do not format files with prettier.
247
+
172
248
  ## init-feature
173
249
  > init-feature generator
174
250
 
175
251
  ```bash
176
- yarn nx g @rxap/plugin-angular:init-feature
252
+ nx g @rxap/plugin-angular:init-feature
177
253
  ```
178
254
 
255
+ Option | Type | Default | Description
256
+ --- | --- | --- | ---
257
+ name | string | | The name of the feature
258
+ project | string | | The name of the project where the feature should be added
259
+ overwrite | boolean | | If the feature should be overwritten if it already exists
260
+ skipFormat | boolean | false |
261
+ apiStatusCheck | boolean | false |
262
+ navigation | object | |
263
+
179
264
  ## init-feature-library
180
265
  > init-feature-library generator
181
266
 
182
267
  ```bash
183
- yarn nx g @rxap/plugin-angular:init-feature-library
184
- ```
185
-
186
- ## init-component
187
- > init-component generator
188
-
189
- ```bash
190
- yarn nx g @rxap/plugin-angular:init-component
191
- ```
192
-
193
- ## init
194
- > init generator
195
-
196
- ```bash
197
- yarn nx g @rxap/plugin-angular:init
198
- ```
199
-
200
- ## init-application
201
- > init-application generator
202
-
203
- ```bash
204
- yarn nx g @rxap/plugin-angular:init-application
205
- ```
206
-
207
- ## init-library
208
- > init-library generator
209
-
210
- ```bash
211
- yarn nx g @rxap/plugin-angular:init-library
212
- ```
213
-
214
- ## fix-schematic
215
- > fix-schematic generator
216
-
217
- ```bash
218
- yarn nx g @rxap/plugin-angular:fix-schematic
268
+ nx g @rxap/plugin-angular:init-feature-library
219
269
  ```
220
270
 
221
- ## schematic
222
- > Create a Schematic for a project.
223
-
224
- ```bash
225
- yarn nx g @rxap/plugin-angular:schematic
226
- ```
227
-
228
- ## init-feature
229
- > init-feature generator
230
-
231
- ```bash
232
- yarn nx g @rxap/plugin-angular:init-feature
233
- ```
271
+ Option | Type | Default | Description
272
+ --- | --- | --- | ---
273
+ project | string | |
274
+ projects | array | |
275
+ overwrite | boolean | false | Whether to overwrite existing files
276
+ skipProjects | boolean | false | Whether to skip executing project specific initialization
277
+ skipFormat | boolean | false |
278
+ routes | boolean | true | Whether the library exposes routes
279
+ targets | object | |
234
280
 
235
281
  ## init-component
236
282
  > init-component generator
237
283
 
238
284
  ```bash
239
- yarn nx g @rxap/plugin-angular:init-component
285
+ nx g @rxap/plugin-angular:init-component
240
286
  ```
241
287
 
242
- ## init-feature-library
243
- > init-feature-library generator
244
-
245
- ```bash
246
- yarn nx g @rxap/plugin-angular:init-feature-library
247
- ```
288
+ Option | Type | Default | Description
289
+ --- | --- | --- | ---
290
+ 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.
291
+ feature | string | | The name of the feature.
292
+ project | string | | The name of the project.
293
+ name | string | | The name of the component.
294
+ prefix | string | | The prefix to apply to the generated component selector.
295
+ displayBlock | boolean | false | Specifies if the style will contain `:host { display: block; }`.
296
+ 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.
297
+ 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.
298
+ standalone | boolean | true | Whether the generated component is standalone. _Note: This is only supported in Angular versions >= 14.1.0_.
299
+ viewEncapsulation | string | | The view encapsulation strategy to use in the new component.
300
+ changeDetection | string | OnPush | The change detection strategy to use in the new component.
301
+ module | string | | The filename or path to the NgModule that will declare this component.
302
+ style | string | scss | The file extension or preprocessor to use for style files, or `none` to skip generating the style file.
303
+ skipTests | boolean | false | Do not create `spec.ts` test files for the new component.
304
+ flat | boolean | false | Create the new files at the top level of the current project.
305
+ skipImport | boolean | false | Do not import this component into the owning NgModule.
306
+ selector | string | | The HTML selector to use for this component.
307
+ skipSelector | boolean | false | Specifies if the component should have a selector or not.
308
+ type | string | component | Adds a developer-defined type to the filename, in the format `name.type.ts`.
309
+ defaultExport | boolean | false | Specifies if the component should be the default export of file.
310
+ 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.
311
+ skipFormat | boolean | false | Skip formatting files.
312
+ interactionTests | boolean | true | Set up Storybook interaction tests.
313
+ cypressProject | string | | The Cypress project to generate the stories under. By default, inferred from `projectName`.
314
+ specDirectory | string | | Directory where to place the generated spec file. By default matches the value of the `componentPath` option.
248
315
  # Executors
249
316
 
250
317
  ## tailwind
251
318
  > tailwind executor
252
319
 
253
- **project.json**
254
- ```json
255
- {
256
- "targets": {
257
- "tailwind": {
258
- "executor": "@rxap/plugin-angular:tailwind"
259
- }
260
- }
261
- }
262
- ```
320
+
321
+ Option | Type | Default | Description
322
+ --- | --- | --- | ---
323
+ config | string | tailwind.config.js |
324
+ input | string | src/styles/theme.scss |
325
+ output | string | theme.css |
326
+ minify | boolean | false |
263
327
 
264
328
  ## check-ng-package
265
329
  > check-ng-package executor
266
330
 
267
- **project.json**
268
- ```json
269
- {
270
- "targets": {
271
- "check-ng-package": {
272
- "executor": "@rxap/plugin-angular:check-ng-package"
273
- }
274
- }
275
- }
276
- ```
277
331
 
278
332
  ## i18n
279
333
  > i18n executor
280
334
 
281
- **project.json**
282
- ```json
283
- {
284
- "targets": {
285
- "i18n": {
286
- "executor": "@rxap/plugin-angular:i18n"
287
- }
288
- }
289
- }
290
- ```
335
+
336
+ Option | Type | Default | Description
337
+ --- | --- | --- | ---
338
+ availableLanguages | array | |
339
+ defaultLanguage | string | |
340
+ indexHtmlTemplate | string | i18n.index.html.hbs |
341
+ buildTarget | string | |
342
+ assets | | |
291
343
 
292
344
  ## config
293
345
  > config executor
294
346
 
295
- **project.json**
296
- ```json
297
- {
298
- "targets": {
299
- "config": {
300
- "executor": "@rxap/plugin-angular:config"
301
- }
302
- }
303
- }
304
- ```
305
347
 
package/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
- "version": "20.0.1",
2
+ "version": "20.0.3-dev.0",
3
3
  "name": "@rxap/plugin-angular",
4
4
  "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",
5
5
  "license": "GPL-3.0-or-later",
6
6
  "dependencies": {
7
7
  "@nx/angular": "20.4.2",
8
8
  "@nx/devkit": "20.4.2",
9
- "@rxap/plugin-application": "^20.0.1",
10
- "@rxap/plugin-library": "^20.1.0",
11
- "@rxap/plugin-utilities": "^20.0.1",
9
+ "@rxap/plugin-application": "^20.0.2-dev.0",
10
+ "@rxap/plugin-library": "^20.1.2-dev.0",
11
+ "@rxap/plugin-utilities": "^20.0.2-dev.0",
12
12
  "@rxap/ts-morph": "^1.5.3",
13
13
  "@rxap/utilities": "^16.4.2",
14
14
  "@rxap/workspace-ts-morph": "^19.1.9",
@@ -56,7 +56,7 @@
56
56
  },
57
57
  "schematics": "./generators.json",
58
58
  "type": "commonjs",
59
- "gitHead": "753c877fe1a5c2fcfa737310f6e99fd1371f9b4d",
59
+ "gitHead": "9c6b5087587f25e790ac3eb934055381506e1f08",
60
60
  "exports": {
61
61
  "./package.json": "./package.json",
62
62
  ".": {