chore(nxdev): update latest version documentation to v12.9.0 (#6950)

This commit is contained in:
Jason Jean 2021-09-07 11:40:16 -04:00 committed by GitHub
parent a4f449e88f
commit c96c68f213
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
53 changed files with 3268 additions and 6 deletions

View File

@ -201,8 +201,6 @@ Nx provides two methods to exclude additional glob patterns (files and folders)
Affected and caching are used to solve the same problem: minimize the computation. But they do it differently, and the combination provides better results than one or the other.
Affected and caching are used to solve the same problem: minimize the computation. But they do it differently, and the combination provides better results than one or the other.
The affected command looks at the before and after states of the workspaces and figures out what can be broken by a change. Because it knows the two states, it can deduce the nature of the change. For instance, this repository uses React and Angular. If a PR updates the version of React in the root package.json, Nx knows that only half of the projects in the workspace can be affected. It knows what was changed--the version of React was bumped up.
Caching simply looks at the current state of the workspace and the environment (such as the version of Node) and checks if somebody already ran the command against this state. Caching knows that something changed, but because there is no before and after states, it doesn't know the nature of the change. In other words, caching is a lot more conservative.

View File

@ -0,0 +1,23 @@
# @nrwl/detox:build
Run the command defined in build property of the specified configuration.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it

View File

@ -0,0 +1,177 @@
# @nrwl/detox:test
Initiating your detox test suite.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### appLaunchArgs
Type: `number`
Custom arguments to pass (through) onto the app every time it is launched.
### artifactsLocation
Alias(es): a
Type: `string`
Artifacts (logs, screenshots, etc) root directory.
### captureViewHierarchy
Type: `string`
[iOS Only] Capture \*.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls.
### cleanup
Type: `boolean`
Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### debugSynchronization
Alias(es): d
Type: `string`
Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it
### deviceLaunchArgs
Type: `string`
A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.
### deviceName
Alias(es): n
Type: `string`
Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.
### forceAdbInstall
Type: `boolean`
Due to problems with the adb install command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of adb install, instead.
### gpu
Type: `boolean`
[Android Only] Launch Emulator with the specific -gpu [gpu mode] parameter.
### headless
Type: `boolean`
Android Only] Launch Emulator in headless mode. Useful when running on CI.
### inspectBrk
Type: `boolean`
Uses node's --inspect-brk flag to let users debug the jest/mocha test runner
### jestReportSpecs
Type: `boolean`
[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.
### loglevel
Alias(es): l
Type: `string`
Log level: fatal, error, warn, info, verbose, trace
### noColor
Type: `boolean`
Disable colors in log output
### recordLogs
Type: `string`
Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only.
### recordPerformance
Type: `string`
[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.
### recordTimeline
Type: `string`
[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool.
### recordVideos
Type: `string`
Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only.
### retries
Type: `number`
[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.
### reuse
Type: `boolean`
Reuse existing installed app (do not delete + reinstall) for a faster run.
### runnerConfig
Alias(es): o
Type: `string`
Test runner config file, defaults to 'e2e/mocha.opts' for mocha and 'e2e/config.json' for jest.
### takeScreenshots
Type: `string`
Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only.
### useCustomLogger
Type: `boolean`
Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test-runner's implementation (e.g. Jest / Mocha).
### workers
Type: `number`
Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).

View File

@ -0,0 +1,81 @@
# @nrwl/detox:application
Create a detox application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/detox:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
Name of the E2E Project
### project (_**required**_)
Type: `string`
The name of the frontend project to test.
### directory
Type: `string`
A directory where the project is placed
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`, `none`
The tool to use for running lint checks.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,55 @@
# @nrwl/linter:workspace-rule
Create a new workspace ESLint rule
## Usage
```bash
nx generate workspace-rule ...
```
By default, Nx will search for `workspace-rule` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/linter:workspace-rule ...
```
Show what will be generated without writing to disk:
```bash
nx g workspace-rule ... --dry-run
```
### Examples
Create a new workspace lint rule called my-custom-rule:
```bash
nx g @nrwl/linter:workspace-rule my-custom-rule
```
Create a new workspace lint rule located at tools/eslint-rules/a/b/c/my-custom-rule.ts:
```bash
nx g @nrwl/linter:workspace-rule --name=my-custom-rule --directory=a/b/c
```
## Options
### directory (_**required**_)
Alias(es): dir
Default: `rules`
Type: `string`
Create the rule under this directory within tools/eslint-rules/ (can be nested).
### name (_**required**_)
Type: `string`
The name of the new rule

View File

@ -0,0 +1,13 @@
# @nrwl/react-native:build-android
Release Build for Android.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### apk
Type: `boolean`
Generate apk file(s) rather than a bundle (.aab).

View File

@ -0,0 +1,45 @@
# @nrwl/react-native:bundle
Builds the JS bundle.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### bundleOutput (_**required**_)
Type: `string`
The output path of the generated files.
### entryFile (_**required**_)
Type: `string`
The entry file relative to project root.
### platform (_**required**_)
Type: `string`
Platform to build for (ios, android).
### dev
Default: `true`
Type: `boolean`
Generate a development build.
### maxWorkers
Type: `number`
The number of workers we should parallelize the transformer on.
### sourceMap
Type: `boolean`
Whether source maps should be generated or not.

View File

@ -0,0 +1,5 @@
# @nrwl/react-native:ensure-symlink
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `angular.json` when defining the executor, or when invoking it.

View File

@ -0,0 +1,85 @@
# @nrwl/react-native:run-android
Runs Android application.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### appId
Type: `string`
Specify an applicationId to launch after build. If not specified, 'package' from AndroidManifest.xml will be used.
### appIdSuffix
Type: `string`
Specify an applicationIdSuffix to launch after build.
### deviceId
Type: `string`
Builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
### jetifier
Default: `true`
Type: `boolean`
Run jetifier the AndroidX transition tool. By default it runs before Gradle to ease working with libraries that don't support AndroidX yet.
### mainActivity
Default: `MainActivity`
Type: `string`
Name of the activity to start.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink).
### tasks
Type: `string`
Run custom gradle tasks. If this argument is provided, then --variant option is ignored. Example: yarn react-native run-android --tasks clean,installDebug.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### variant
Default: `debug`
Type: `string`
Specify your app's build variant (e.g. debug, release).

View File

@ -0,0 +1,73 @@
# @nrwl/react-native:run-ios
Runs iOS application.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### device
Type: `string`
Explicitly set device to use by name. The value is not required if you have a single device connected.
### install
Default: `true`
Type: `boolean`
Runs 'pod install' for native modules before building iOS app.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### scheme
Type: `string`
Explicitly set the Xcode scheme to use
### simulator
Default: `iPhone X`
Type: `string`
Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: "iPhone X (12.1)"
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink). Always true when --install is used.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### xcodeConfiguration
Default: `Debug`
Type: `string`
Explicitly set the Xcode configuration to use

View File

@ -0,0 +1,23 @@
# @nrwl/react-native:start
Starts the dev server for JS bundle.
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### port
Default: `8081`
Type: `number`
The port to listen on.
### resetCache
Default: `false`
Type: `boolean`
Resets metro cache.

View File

@ -0,0 +1,13 @@
# @nrwl/react-native:sync-deps
Syncs dependencies to package.json (required for autolinking).
Options can be configured in `angular.json` when defining the executor, or when invoking it.
## Options
### include
Type: `string`
A comma-separated list of additional npm packages to include. e.g. 'nx sync-deps --include=react-native-gesture-handler,react-native-safe-area-context'

View File

@ -0,0 +1,125 @@
# @nrwl/react-native:application
Create an application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate apps/nested/myapp:
```bash
nx g app myapp --directory=nested
```
Use class components instead of functional components:
```bash
nx g app myapp --classComponent
```
## Options
### directory
Alias(es): d
Type: `string`
The directory of the new application.
### displayName
Type: `string`
The display name to show in the application. Defaults to name.
### e2eTestRunner
Default: `detox`
Type: `string`
Possible values: `detox`, `none`
Adds the specified e2e test runner
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### tags
Alias(es): t
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,119 @@
# @nrwl/react-native:component
Create a component
## Usage
```bash
nx generate component ...
```
```bash
nx g c ... # same
```
By default, Nx will search for `component` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:component ...
```
Show what will be generated without writing to disk:
```bash
nx g component ... --dry-run
```
### Examples
Generate a component in the mylib library:
```bash
nx g component my-component --project=mylib
```
Generate a class component in the mylib library:
```bash
nx g component my-component --project=mylib --classComponent
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### classComponent
Alias(es): C
Default: `false`
Type: `boolean`
Use class components instead of functional component.
### directory
Alias(es): d
Type: `string`
Create the component under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new component.

View File

@ -0,0 +1,157 @@
# @nrwl/react-native:library
Create a library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### directory
Alias(es): d
Type: `string`
A directory where the lib is placed.
### globalCss
Default: `false`
Type: `boolean`
When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '_.css' rather than '_.module.css').
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### publishable
Type: `boolean`
Create a publishable library.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Alias(es): t
Type: `string`
Add tags to the library (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

View File

@ -1,12 +1,14 @@
[
"angular",
"cypress",
"detox",
"gatsby",
"jest",
"linter",
"next",
"node",
"nx-plugin",
"react-native",
"storybook",
"web",
"workspace"

View File

@ -1,14 +1,17 @@
[
"angular",
"cypress",
"detox",
"express",
"gatsby",
"jest",
"linter",
"nest",
"next",
"node",
"nx-plugin",
"react",
"react-native",
"storybook",
"web",
"workspace"

View File

@ -228,7 +228,7 @@ First, add `FormsModule` to the `imports` array in your `remote-entry/entry.modu
```ts
import { NgModule } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { BrowserModule } from '@angular/platform-browser';
import { CommonModule } from '@angular/common';
import { RouterModule } from '@angular/router';
import { RemoteEntryComponent } from './entry.component';
@ -236,7 +236,7 @@ import { RemoteEntryComponent } from './entry.component';
@NgModule({
declarations: [RemoteEntryComponent],
imports: [
BrowserModule,
CommonModule,
FormsModule,
RouterModule.forChild([
{

View File

@ -670,6 +670,11 @@
"name": "lint executor",
"id": "lint",
"file": "angular/api-linter/executors/lint"
},
{
"name": "workspace-rule generator",
"id": "workspace-rule",
"file": "angular/api-linter/generators/workspace-rule"
}
]
},
@ -908,6 +913,83 @@
}
]
},
{
"name": "detox",
"id": "detox",
"itemList": [
{
"name": "application generator",
"id": "application",
"file": "angular/api-detox/generators/application"
},
{
"name": "build executor",
"id": "build",
"file": "angular/api-detox/executors/build"
},
{
"name": "test executor",
"id": "test",
"file": "angular/api-detox/executors/test"
}
]
},
{
"name": "react native",
"id": "react-native",
"itemList": [
{
"name": "application generator",
"id": "application",
"file": "angular/api-react-native/generators/application"
},
{
"name": "component generator",
"id": "component",
"file": "angular/api-react-native/generators/component"
},
{
"name": "library generator",
"id": "library",
"file": "angular/api-react-native/generators/library"
},
{
"name": "build android executor",
"id": "build-android",
"file": "angular/api-react-native/executors/build-android"
},
{
"name": "bundle executor",
"id": "bundle",
"file": "angular/api-react-native/executors/bundle"
},
{
"name": "ensure symlink executor",
"id": "ensure-symlink",
"file": "angular/api-react-native/executors/ensure-symlink"
},
{
"name": "run android executor",
"id": "run-android",
"file": "angular/api-react-native/executors/run-android"
},
{
"name": "run ios executor",
"id": "run-ios",
"file": "angular/api-react-native/executors/run-ios"
},
{
"name": "start executor",
"id": "start",
"file": "angular/api-react-native/executors/start"
},
{
"name": "sync deps executor",
"id": "sync-deps",
"file": "angular/api-react-native/executors/sync-deps"
}
]
},
{
"name": "Nx Plugin",
"id": "nx-plugin",
@ -1882,6 +1964,11 @@
"name": "lint executor",
"id": "lint",
"file": "react/api-linter/executors/lint"
},
{
"name": "workspace-rule generator",
"id": "workspace-rule",
"file": "react/api-linter/generators/workspace-rule"
}
]
},
@ -2120,6 +2207,104 @@
}
]
},
{
"name": "detox",
"id": "detox",
"itemList": [
{
"name": "application generator",
"id": "application",
"file": "react/api-detox/generators/application"
},
{
"name": "build executor",
"id": "build",
"file": "react/api-detox/executors/build"
},
{
"name": "test executor",
"id": "test",
"file": "react/api-detox/executors/test"
}
]
},
{
"name": "detox",
"id": "detox",
"itemList": [
{
"name": "application generator",
"id": "application",
"file": "node/api-detox/generators/application"
},
{
"name": "build executor",
"id": "build",
"file": "node/api-detox/executors/build"
},
{
"name": "test executor",
"id": "test",
"file": "node/api-detox/executors/test"
}
]
},
{
"name": "react native",
"id": "react-native",
"itemList": [
{
"name": "application generator",
"id": "application",
"file": "react/api-react-native/generators/application"
},
{
"name": "component generator",
"id": "component",
"file": "react/api-react-native/generators/component"
},
{
"name": "library generator",
"id": "library",
"file": "react/api-react-native/generators/library"
},
{
"name": "build android executor",
"id": "build-android",
"file": "react/api-react-native/executors/build-android"
},
{
"name": "bundle executor",
"id": "bundle",
"file": "react/api-react-native/executors/bundle"
},
{
"name": "ensure symlink executor",
"id": "ensure-symlink",
"file": "react/api-react-native/executors/ensure-symlink"
},
{
"name": "run android executor",
"id": "run-android",
"file": "react/api-react-native/executors/run-android"
},
{
"name": "run ios executor",
"id": "run-ios",
"file": "react/api-react-native/executors/run-ios"
},
{
"name": "start executor",
"id": "start",
"file": "react/api-react-native/executors/start"
},
{
"name": "sync deps executor",
"id": "sync-deps",
"file": "react/api-react-native/executors/sync-deps"
}
]
},
{
"name": "Nx Plugin",
"id": "nx-plugin",
@ -3035,6 +3220,11 @@
"name": "lint executor",
"id": "lint",
"file": "node/api-linter/executors/lint"
},
{
"name": "workspace-rule generator",
"id": "workspace-rule",
"file": "node/api-linter/generators/workspace-rule"
}
]
},
@ -3273,6 +3463,62 @@
}
]
},
{
"name": "react native",
"id": "react-native",
"itemList": [
{
"name": "application generator",
"id": "application",
"file": "node/api-react-native/generators/application"
},
{
"name": "component generator",
"id": "component",
"file": "node/api-react-native/generators/component"
},
{
"name": "library generator",
"id": "library",
"file": "node/api-react-native/generators/library"
},
{
"name": "build android executor",
"id": "build-android",
"file": "node/api-react-native/executors/build-android"
},
{
"name": "bundle executor",
"id": "bundle",
"file": "node/api-react-native/executors/bundle"
},
{
"name": "ensure symlink executor",
"id": "ensure-symlink",
"file": "node/api-react-native/executors/ensure-symlink"
},
{
"name": "run android executor",
"id": "run-android",
"file": "node/api-react-native/executors/run-android"
},
{
"name": "run ios executor",
"id": "run-ios",
"file": "node/api-react-native/executors/run-ios"
},
{
"name": "start executor",
"id": "start",
"file": "node/api-react-native/executors/start"
},
{
"name": "sync deps executor",
"id": "sync-deps",
"file": "node/api-react-native/executors/sync-deps"
}
]
},
{
"name": "Nx Plugin",
"id": "nx-plugin",

View File

@ -0,0 +1,24 @@
# @nrwl/detox:build
Run the command defined in build property of the specified configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it

View File

@ -0,0 +1,178 @@
# @nrwl/detox:test
Initiating your detox test suite.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### appLaunchArgs
Type: `number`
Custom arguments to pass (through) onto the app every time it is launched.
### artifactsLocation
Alias(es): a
Type: `string`
Artifacts (logs, screenshots, etc) root directory.
### captureViewHierarchy
Type: `string`
[iOS Only] Capture \*.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls.
### cleanup
Type: `boolean`
Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### debugSynchronization
Alias(es): d
Type: `string`
Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it
### deviceLaunchArgs
Type: `string`
A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.
### deviceName
Alias(es): n
Type: `string`
Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.
### forceAdbInstall
Type: `boolean`
Due to problems with the adb install command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of adb install, instead.
### gpu
Type: `boolean`
[Android Only] Launch Emulator with the specific -gpu [gpu mode] parameter.
### headless
Type: `boolean`
Android Only] Launch Emulator in headless mode. Useful when running on CI.
### inspectBrk
Type: `boolean`
Uses node's --inspect-brk flag to let users debug the jest/mocha test runner
### jestReportSpecs
Type: `boolean`
[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.
### loglevel
Alias(es): l
Type: `string`
Log level: fatal, error, warn, info, verbose, trace
### noColor
Type: `boolean`
Disable colors in log output
### recordLogs
Type: `string`
Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only.
### recordPerformance
Type: `string`
[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.
### recordTimeline
Type: `string`
[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool.
### recordVideos
Type: `string`
Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only.
### retries
Type: `number`
[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.
### reuse
Type: `boolean`
Reuse existing installed app (do not delete + reinstall) for a faster run.
### runnerConfig
Alias(es): o
Type: `string`
Test runner config file, defaults to 'e2e/mocha.opts' for mocha and 'e2e/config.json' for jest.
### takeScreenshots
Type: `string`
Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only.
### useCustomLogger
Type: `boolean`
Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test-runner's implementation (e.g. Jest / Mocha).
### workers
Type: `number`
Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).

View File

@ -0,0 +1,81 @@
# @nrwl/detox:application
Create a detox application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/detox:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
Name of the E2E Project
### project (_**required**_)
Type: `string`
The name of the frontend project to test.
### directory
Type: `string`
A directory where the project is placed
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`, `none`
The tool to use for running lint checks.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,55 @@
# @nrwl/linter:workspace-rule
Create a new workspace ESLint rule
## Usage
```bash
nx generate workspace-rule ...
```
By default, Nx will search for `workspace-rule` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/linter:workspace-rule ...
```
Show what will be generated without writing to disk:
```bash
nx g workspace-rule ... --dry-run
```
### Examples
Create a new workspace lint rule called my-custom-rule:
```bash
nx g @nrwl/linter:workspace-rule my-custom-rule
```
Create a new workspace lint rule located at tools/eslint-rules/a/b/c/my-custom-rule.ts:
```bash
nx g @nrwl/linter:workspace-rule --name=my-custom-rule --directory=a/b/c
```
## Options
### directory (_**required**_)
Alias(es): dir
Default: `rules`
Type: `string`
Create the rule under this directory within tools/eslint-rules/ (can be nested).
### name (_**required**_)
Type: `string`
The name of the new rule

View File

@ -0,0 +1,14 @@
# @nrwl/react-native:build-android
Release Build for Android.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### apk
Type: `boolean`
Generate apk file(s) rather than a bundle (.aab).

View File

@ -0,0 +1,46 @@
# @nrwl/react-native:bundle
Builds the JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### bundleOutput (_**required**_)
Type: `string`
The output path of the generated files.
### entryFile (_**required**_)
Type: `string`
The entry file relative to project root.
### platform (_**required**_)
Type: `string`
Platform to build for (ios, android).
### dev
Default: `true`
Type: `boolean`
Generate a development build.
### maxWorkers
Type: `number`
The number of workers we should parallelize the transformer on.
### sourceMap
Type: `boolean`
Whether source maps should be generated or not.

View File

@ -0,0 +1,6 @@
# @nrwl/react-native:ensure-symlink
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.

View File

@ -0,0 +1,86 @@
# @nrwl/react-native:run-android
Runs Android application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### appId
Type: `string`
Specify an applicationId to launch after build. If not specified, 'package' from AndroidManifest.xml will be used.
### appIdSuffix
Type: `string`
Specify an applicationIdSuffix to launch after build.
### deviceId
Type: `string`
Builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
### jetifier
Default: `true`
Type: `boolean`
Run jetifier the AndroidX transition tool. By default it runs before Gradle to ease working with libraries that don't support AndroidX yet.
### mainActivity
Default: `MainActivity`
Type: `string`
Name of the activity to start.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink).
### tasks
Type: `string`
Run custom gradle tasks. If this argument is provided, then --variant option is ignored. Example: yarn react-native run-android --tasks clean,installDebug.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### variant
Default: `debug`
Type: `string`
Specify your app's build variant (e.g. debug, release).

View File

@ -0,0 +1,74 @@
# @nrwl/react-native:run-ios
Runs iOS application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### device
Type: `string`
Explicitly set device to use by name. The value is not required if you have a single device connected.
### install
Default: `true`
Type: `boolean`
Runs 'pod install' for native modules before building iOS app.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### scheme
Type: `string`
Explicitly set the Xcode scheme to use
### simulator
Default: `iPhone X`
Type: `string`
Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: "iPhone X (12.1)"
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink). Always true when --install is used.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### xcodeConfiguration
Default: `Debug`
Type: `string`
Explicitly set the Xcode configuration to use

View File

@ -0,0 +1,24 @@
# @nrwl/react-native:start
Starts the dev server for JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### port
Default: `8081`
Type: `number`
The port to listen on.
### resetCache
Default: `false`
Type: `boolean`
Resets metro cache.

View File

@ -0,0 +1,14 @@
# @nrwl/react-native:sync-deps
Syncs dependencies to package.json (required for autolinking).
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### include
Type: `string`
A comma-separated list of additional npm packages to include. e.g. 'nx sync-deps --include=react-native-gesture-handler,react-native-safe-area-context'

View File

@ -0,0 +1,125 @@
# @nrwl/react-native:application
Create an application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate apps/nested/myapp:
```bash
nx g app myapp --directory=nested
```
Use class components instead of functional components:
```bash
nx g app myapp --classComponent
```
## Options
### directory
Alias(es): d
Type: `string`
The directory of the new application.
### displayName
Type: `string`
The display name to show in the application. Defaults to name.
### e2eTestRunner
Default: `detox`
Type: `string`
Possible values: `detox`, `none`
Adds the specified e2e test runner
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### tags
Alias(es): t
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,119 @@
# @nrwl/react-native:component
Create a component
## Usage
```bash
nx generate component ...
```
```bash
nx g c ... # same
```
By default, Nx will search for `component` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:component ...
```
Show what will be generated without writing to disk:
```bash
nx g component ... --dry-run
```
### Examples
Generate a component in the mylib library:
```bash
nx g component my-component --project=mylib
```
Generate a class component in the mylib library:
```bash
nx g component my-component --project=mylib --classComponent
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### classComponent
Alias(es): C
Default: `false`
Type: `boolean`
Use class components instead of functional component.
### directory
Alias(es): d
Type: `string`
Create the component under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new component.

View File

@ -0,0 +1,157 @@
# @nrwl/react-native:library
Create a library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### directory
Alias(es): d
Type: `string`
A directory where the lib is placed.
### globalCss
Default: `false`
Type: `boolean`
When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '_.css' rather than '_.module.css').
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### publishable
Type: `boolean`
Create a publishable library.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Alias(es): t
Type: `string`
Add tags to the library (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

View File

@ -1,12 +1,14 @@
[
"angular",
"cypress",
"detox",
"gatsby",
"jest",
"linter",
"next",
"node",
"nx-plugin",
"react-native",
"storybook",
"web",
"workspace"

View File

@ -1,14 +1,17 @@
[
"angular",
"cypress",
"detox",
"express",
"gatsby",
"jest",
"linter",
"nest",
"next",
"node",
"nx-plugin",
"react",
"react-native",
"storybook",
"web",
"workspace"

View File

@ -0,0 +1,24 @@
# @nrwl/detox:build
Run the command defined in build property of the specified configuration.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it

View File

@ -0,0 +1,178 @@
# @nrwl/detox:test
Initiating your detox test suite.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### appLaunchArgs
Type: `number`
Custom arguments to pass (through) onto the app every time it is launched.
### artifactsLocation
Alias(es): a
Type: `string`
Artifacts (logs, screenshots, etc) root directory.
### captureViewHierarchy
Type: `string`
[iOS Only] Capture \*.uihierarchy snapshots on view action errors and device.captureViewHierarchy() calls.
### cleanup
Type: `boolean`
Shutdown simulator when test is over, useful for CI scripts, to make sure detox exists cleanly with no residue
### configPath
Alias(es): cp
Type: `string`
Specify Detox config file path. If not supplied, detox searches for .detoxrc[.js] or "detox" section in package.json
### debugSynchronization
Alias(es): d
Type: `string`
Customize how long an action/expectation can take to complete before Detox starts querying the app why it is busy. By default, the app status will be printed if the action takes more than 10s to complete.
### detoxConfiguration
Alias(es): C
Type: `string`
Select a device configuration from your defined configurations, if not supplied, and there's only one configuration, detox will default to it
### deviceLaunchArgs
Type: `string`
A list of passthrough-arguments to use when (if) devices (Android emulator / iOS simulator) are launched by Detox.
### deviceName
Alias(es): n
Type: `string`
Override the device name specified in a configuration. Useful for running a single build configuration on multiple devices.
### forceAdbInstall
Type: `boolean`
Due to problems with the adb install command on Android, Detox resorts to a different scheme for install APK's. Setting true will disable that and force usage of adb install, instead.
### gpu
Type: `boolean`
[Android Only] Launch Emulator with the specific -gpu [gpu mode] parameter.
### headless
Type: `boolean`
Android Only] Launch Emulator in headless mode. Useful when running on CI.
### inspectBrk
Type: `boolean`
Uses node's --inspect-brk flag to let users debug the jest/mocha test runner
### jestReportSpecs
Type: `boolean`
[Jest Only] Whether to output logs per each running spec, in real-time. By default, disabled with multiple workers.
### loglevel
Alias(es): l
Type: `string`
Log level: fatal, error, warn, info, verbose, trace
### noColor
Type: `boolean`
Disable colors in log output
### recordLogs
Type: `string`
Save logs during each test to artifacts directory. Pass "failing" to save logs of failing tests only.
### recordPerformance
Type: `string`
[iOS Only] Save Detox Instruments performance recordings of each test to artifacts directory.
### recordTimeline
Type: `string`
[Jest Only] Record tests and events timeline, for visual display on the chrome://tracing tool.
### recordVideos
Type: `string`
Save screen recordings of each test to artifacts directory. Pass "failing" to save recordings of failing tests only.
### retries
Type: `number`
[Jest Circus Only] Re-spawn the test runner for individual failing suite files until they pass, or <N> times at least.
### reuse
Type: `boolean`
Reuse existing installed app (do not delete + reinstall) for a faster run.
### runnerConfig
Alias(es): o
Type: `string`
Test runner config file, defaults to 'e2e/mocha.opts' for mocha and 'e2e/config.json' for jest.
### takeScreenshots
Type: `string`
Save screenshots before and after each test to artifacts directory. Pass "failing" to save screenshots of failing tests only.
### useCustomLogger
Type: `boolean`
Use Detox' custom console-logging implementation, for logging Detox (non-device) logs. Disabling will fallback to node.js / test-runner's implementation (e.g. Jest / Mocha).
### workers
Type: `number`
Specifies number of workers the test runner should spawn, requires a test runner with parallel execution support (Detox CLI currently supports Jest).

View File

@ -0,0 +1,81 @@
# @nrwl/detox:application
Create a detox application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/detox:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
## Options
### name (_**required**_)
Type: `string`
Name of the E2E Project
### project (_**required**_)
Type: `string`
The name of the frontend project to test.
### directory
Type: `string`
A directory where the project is placed
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`, `none`
The tool to use for running lint checks.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files

View File

@ -0,0 +1,55 @@
# @nrwl/linter:workspace-rule
Create a new workspace ESLint rule
## Usage
```bash
nx generate workspace-rule ...
```
By default, Nx will search for `workspace-rule` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/linter:workspace-rule ...
```
Show what will be generated without writing to disk:
```bash
nx g workspace-rule ... --dry-run
```
### Examples
Create a new workspace lint rule called my-custom-rule:
```bash
nx g @nrwl/linter:workspace-rule my-custom-rule
```
Create a new workspace lint rule located at tools/eslint-rules/a/b/c/my-custom-rule.ts:
```bash
nx g @nrwl/linter:workspace-rule --name=my-custom-rule --directory=a/b/c
```
## Options
### directory (_**required**_)
Alias(es): dir
Default: `rules`
Type: `string`
Create the rule under this directory within tools/eslint-rules/ (can be nested).
### name (_**required**_)
Type: `string`
The name of the new rule

View File

@ -0,0 +1,14 @@
# @nrwl/react-native:build-android
Release Build for Android.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### apk
Type: `boolean`
Generate apk file(s) rather than a bundle (.aab).

View File

@ -0,0 +1,46 @@
# @nrwl/react-native:bundle
Builds the JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### bundleOutput (_**required**_)
Type: `string`
The output path of the generated files.
### entryFile (_**required**_)
Type: `string`
The entry file relative to project root.
### platform (_**required**_)
Type: `string`
Platform to build for (ios, android).
### dev
Default: `true`
Type: `boolean`
Generate a development build.
### maxWorkers
Type: `number`
The number of workers we should parallelize the transformer on.
### sourceMap
Type: `boolean`
Whether source maps should be generated or not.

View File

@ -0,0 +1,6 @@
# @nrwl/react-native:ensure-symlink
Ensure workspace node_modules is symlink under app's node_modules folder.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.

View File

@ -0,0 +1,86 @@
# @nrwl/react-native:run-android
Runs Android application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### appId
Type: `string`
Specify an applicationId to launch after build. If not specified, 'package' from AndroidManifest.xml will be used.
### appIdSuffix
Type: `string`
Specify an applicationIdSuffix to launch after build.
### deviceId
Type: `string`
Builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
### jetifier
Default: `true`
Type: `boolean`
Run jetifier the AndroidX transition tool. By default it runs before Gradle to ease working with libraries that don't support AndroidX yet.
### mainActivity
Default: `MainActivity`
Type: `string`
Name of the activity to start.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink).
### tasks
Type: `string`
Run custom gradle tasks. If this argument is provided, then --variant option is ignored. Example: yarn react-native run-android --tasks clean,installDebug.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### variant
Default: `debug`
Type: `string`
Specify your app's build variant (e.g. debug, release).

View File

@ -0,0 +1,74 @@
# @nrwl/react-native:run-ios
Runs iOS application.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### device
Type: `string`
Explicitly set device to use by name. The value is not required if you have a single device connected.
### install
Default: `true`
Type: `boolean`
Runs 'pod install' for native modules before building iOS app.
### packager
Default: `true`
Type: `boolean`
Starts the packager server
### port
Default: `8081`
Type: `number`
The port where the packager server is listening on.
### scheme
Type: `string`
Explicitly set the Xcode scheme to use
### simulator
Default: `iPhone X`
Type: `string`
Explicitly set simulator to use. Optionally include iOS version between parenthesis at the end to match an exact version: "iPhone X (12.1)"
### sync
Default: `true`
Type: `boolean`
Syncs npm dependencies to package.json (for React Native autolink). Always true when --install is used.
### terminal
Type: `string`
Launches the Metro Bundler in a new window using the specified terminal path.
### xcodeConfiguration
Default: `Debug`
Type: `string`
Explicitly set the Xcode configuration to use

View File

@ -0,0 +1,24 @@
# @nrwl/react-native:start
Starts the dev server for JS bundle.
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### port
Default: `8081`
Type: `number`
The port to listen on.
### resetCache
Default: `false`
Type: `boolean`
Resets metro cache.

View File

@ -0,0 +1,14 @@
# @nrwl/react-native:sync-deps
Syncs dependencies to package.json (required for autolinking).
Options can be configured in `workspace.json` when defining the executor, or when invoking it.
Read more about how to use executors and the CLI here: https://nx.dev/getting-started/nx-cli#common-commands.
## Options
### include
Type: `string`
A comma-separated list of additional npm packages to include. e.g. 'nx sync-deps --include=react-native-gesture-handler,react-native-safe-area-context'

View File

@ -0,0 +1,125 @@
# @nrwl/react-native:application
Create an application
## Usage
```bash
nx generate application ...
```
```bash
nx g app ... # same
```
By default, Nx will search for `application` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:application ...
```
Show what will be generated without writing to disk:
```bash
nx g application ... --dry-run
```
### Examples
Generate apps/nested/myapp:
```bash
nx g app myapp --directory=nested
```
Use class components instead of functional components:
```bash
nx g app myapp --classComponent
```
## Options
### directory
Alias(es): d
Type: `string`
The directory of the new application.
### displayName
Type: `string`
The display name to show in the application. Defaults to name.
### e2eTestRunner
Default: `detox`
Type: `string`
Possible values: `detox`, `none`
Adds the specified e2e test runner
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
The name of the application.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files
### tags
Alias(es): t
Type: `string`
Add tags to the application (used for linting)
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests

View File

@ -0,0 +1,119 @@
# @nrwl/react-native:component
Create a component
## Usage
```bash
nx generate component ...
```
```bash
nx g c ... # same
```
By default, Nx will search for `component` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:component ...
```
Show what will be generated without writing to disk:
```bash
nx g component ... --dry-run
```
### Examples
Generate a component in the mylib library:
```bash
nx g component my-component --project=mylib
```
Generate a class component in the mylib library:
```bash
nx g component my-component --project=mylib --classComponent
```
## Options
### name (_**required**_)
Type: `string`
The name of the component.
### project (_**required**_)
Alias(es): p
Type: `string`
The name of the project.
### classComponent
Alias(es): C
Default: `false`
Type: `boolean`
Use class components instead of functional component.
### directory
Alias(es): d
Type: `string`
Create the component under this directory (can be nested).
### export
Alias(es): e
Default: `false`
Type: `boolean`
When true, the component is exported from the project index.ts (if it exists).
### flat
Default: `false`
Type: `boolean`
Create component at the source root rather than its own directory.
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### skipTests
Default: `false`
Type: `boolean`
When true, does not create "spec.ts" test files for the new component.

View File

@ -0,0 +1,157 @@
# @nrwl/react-native:library
Create a library
## Usage
```bash
nx generate library ...
```
```bash
nx g lib ... # same
```
By default, Nx will search for `library` in the default collection provisioned in `workspace.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react-native:library ...
```
Show what will be generated without writing to disk:
```bash
nx g library ... --dry-run
```
### Examples
Generate libs/myapp/mylib:
```bash
nx g lib mylib --directory=myapp
```
## Options
### name (_**required**_)
Type: `string`
Library name
### buildable
Default: `false`
Type: `boolean`
Generate a buildable library.
### directory
Alias(es): d
Type: `string`
A directory where the lib is placed.
### globalCss
Default: `false`
Type: `boolean`
When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is '_.css' rather than '_.module.css').
### importPath
Type: `string`
The library name used to import it, like @myorg/my-awesome-lib
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### pascalCaseFiles
Alias(es): P
Default: `false`
Type: `boolean`
Use pascal case component file name (e.g. App.tsx).
### publishable
Type: `boolean`
Create a publishable library.
### setParserOptionsProject
Default: `false`
Type: `boolean`
Whether or not to configure the ESLint "parserOptions.project" option. We do not do this by default for lint performance reasons.
### skipFormat
Default: `false`
Type: `boolean`
Skip formatting files.
### skipTsConfig
Default: `false`
Type: `boolean`
Do not update tsconfig.json for development experience.
### strict
Default: `true`
Type: `boolean`
Whether to enable tsconfig strict mode or not.
### tags
Alias(es): t
Type: `string`
Add tags to the library (used for linting).
### unitTestRunner
Default: `jest`
Type: `string`
Possible values: `jest`, `none`
Test runner to use for unit tests.

View File

@ -1,12 +1,14 @@
[
"angular",
"cypress",
"detox",
"gatsby",
"jest",
"linter",
"next",
"node",
"nx-plugin",
"react-native",
"storybook",
"web",
"workspace"

View File

@ -1,14 +1,17 @@
[
"angular",
"cypress",
"detox",
"express",
"gatsby",
"jest",
"linter",
"nest",
"next",
"node",
"nx-plugin",
"react",
"react-native",
"storybook",
"web",
"workspace"

View File

@ -42,11 +42,14 @@ We are going to achieve this by creating a shell script in our Nx workspace that
# Name of the app to check. Change this to your application name!
APP=tuskdesk
# Determine version of Nx installed
NX_VERSION=$(node -e "console.log(require('./package.json').devDependencies['@nrwl/workspace'])")
TS_VERSION=$(node -e "console.log(require('./package.json').devDependencies['typescript'])")
# Install @nrwl/workspace in order to run the affected command
npm install -D @nrwl/workspace@$NX_VERSION --prefer-offline
npm install -D typescript@$TS_VERSION --prefer-offline
# Run the affected command, comparing latest commit to the one before that
npx nx affected:apps --plain --base HEAD~1 --head HEAD | grep $APP -q

View File

@ -1,8 +1,8 @@
[
{
"name": "Latest (v12.8.0)",
"name": "Latest (v12.9.0)",
"id": "latest",
"release": "12.8.0",
"release": "12.9.0",
"path": "latest",
"default": true
},