From 6f0cc00ee1dcc0924c72c6d7bcd523a671be16c7 Mon Sep 17 00:00:00 2001 From: Benjamin Cabanes <3447705+bcabanes@users.noreply.github.com> Date: Fri, 25 Mar 2022 17:06:33 -0400 Subject: [PATCH] docs(core): add description to react-native package (#9536) --- docs/generated/packages/react-native.json | 22 +++++++++--------- packages/react-native/executors.json | 12 +++++----- packages/react-native/generators.json | 28 +++++++++++------------ packages/react-native/package.json | 2 +- 4 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/generated/packages/react-native.json b/docs/generated/packages/react-native.json index b529f5ca2ab2c..16aa7026cef6d 100644 --- a/docs/generated/packages/react-native.json +++ b/docs/generated/packages/react-native.json @@ -1,7 +1,7 @@ { "githubRoot": "https://github.com/nrwl/nx/blob/master", "name": "react-native", - "description": "React Native Plugin for Nx", + "description": "React Native brings React's declarative UI framework to iOS and Android. With React Native, you use native UI controls and have full access to the native platform.\n\nThe Nx Plugin for React Native contains generators for managing React Native applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Detox, and Storybook.\n\n- Scaffolding for creating buildable libraries that can be published to npm.\n\n- Utilities for automatic workspace refactoring.", "root": "/packages/react-native", "source": "/packages/react-native/src", "generators": [ @@ -37,7 +37,7 @@ "required": [], "presets": [] }, - "description": "Initialize the @nrwl/react-native plugin", + "description": "Initialize the `@nrwl/react-native` plugin.", "hidden": true, "implementation": "/packages/react-native/src/generators/init/init#reactNativeInitGenerator.ts", "aliases": [], @@ -123,7 +123,7 @@ }, "aliases": ["app"], "x-type": "application", - "description": "Create a React Native application", + "description": "Create a React Native application.", "implementation": "/packages/react-native/src/generators/application/application#reactNativeApplicationGenerator.ts", "hidden": false, "path": "/packages/react-native/src/generators/application/schema.json" @@ -229,7 +229,7 @@ }, "aliases": ["lib"], "x-type": "library", - "description": "Create a React Native library", + "description": "Create a React Native library.", "implementation": "/packages/react-native/src/generators/library/library#reactNativeLibraryGenerator.ts", "hidden": false, "path": "/packages/react-native/src/generators/library/schema.json" @@ -311,7 +311,7 @@ "required": ["name", "project"], "presets": [] }, - "description": "Create a React Native component", + "description": "Create a React Native component.", "aliases": ["c"], "implementation": "/packages/react-native/src/generators/component/component#reactNativeComponentGenerator.ts", "hidden": false, @@ -358,7 +358,7 @@ "required": ["name"], "presets": [] }, - "description": "Set up storybook for a react-native app or library", + "description": "Set up Storybook for a React-native application or library.", "hidden": false, "implementation": "/packages/react-native/src/generators/storybook-configuration/configuration#storybookConfigurationGenerator.ts", "aliases": [], @@ -392,7 +392,7 @@ "required": ["project", "componentPath"], "presets": [] }, - "description": "Generate storybook story for a react-native component", + "description": "Generate Storybook story for a React-native component.", "hidden": false, "implementation": "/packages/react-native/src/generators/component-story/component-story#componentStoryGenerator.ts", "aliases": [], @@ -419,7 +419,7 @@ "required": ["project"], "presets": [] }, - "description": "Create stories/specs for all components declared in an app or library", + "description": "Create stories/specs for all components declared in an application or library.", "hidden": false, "implementation": "/packages/react-native/src/generators/stories/stories#storiesGenerator.ts", "aliases": [], @@ -722,7 +722,7 @@ }, "presets": [] }, - "description": "Syncs dependencies to package.json (required for autolinking).", + "description": "Syncs dependencies to `package.json` (required for autolinking).", "aliases": [], "hidden": false, "path": "/packages/react-native/src/executors/sync-deps/schema.json" @@ -740,7 +740,7 @@ "properties": {}, "presets": [] }, - "description": "Ensure workspace node_modules is symlink under app's node_modules folder.", + "description": "Ensure workspace `node_modules` is symlink under app's `node_modules` folder.", "aliases": [], "hidden": false, "path": "/packages/react-native/src/executors/ensure-symlink/schema.json" @@ -777,7 +777,7 @@ "required": ["searchDir", "outputFile", "pattern"], "presets": [] }, - "description": "Serve React Native Storybook", + "description": "Serve React Native Storybook.", "aliases": [], "hidden": false, "path": "/packages/react-native/src/executors/storybook/schema.json" diff --git a/packages/react-native/executors.json b/packages/react-native/executors.json index 24cbbbd094e0e..214e05a25a6df 100644 --- a/packages/react-native/executors.json +++ b/packages/react-native/executors.json @@ -28,17 +28,17 @@ "sync-deps": { "implementation": "./src/executors/sync-deps/sync-deps.impl", "schema": "./src/executors/sync-deps/schema.json", - "description": "Syncs dependencies to package.json (required for autolinking)." + "description": "Syncs dependencies to `package.json` (required for autolinking)." }, "ensure-symlink": { "implementation": "./src/executors/ensure-symlink/ensure-symlink.impl", "schema": "./src/executors/ensure-symlink//schema.json", - "description": "Ensure workspace node_modules is symlink under app's node_modules folder." + "description": "Ensure workspace `node_modules` is symlink under app's `node_modules` folder." }, "storybook": { "implementation": "./src/executors/storybook/storybook.impl", "schema": "./src/executors/storybook/schema.json", - "description": "Serve React Native Storybook" + "description": "Serve React Native Storybook." } }, "builders": { @@ -70,17 +70,17 @@ "sync-deps": { "implementation": "./src/executors/sync-deps/compat", "schema": "./src/executors/sync-deps/schema.json", - "description": "Syncs dependencies to package.json (required for autolinking)." + "description": "Syncs dependencies to `package.json` (required for autolinking)." }, "ensure-symlink": { "implementation": "./src/executors/ensure-symlink/compat", "schema": "./src/executors/ensure-symlink//schema.json", - "description": "Ensure workspace node_modules is symlink under app's node_modules folder." + "description": "Ensure workspace `node_modules` is symlink under app's `node_modules` folder." }, "storybook": { "implementation": "./src/executors/storybook/compat", "schema": "./src/executors/storybook/schema.json", - "description": "Serve React Native Storybook" + "description": "Serve React Native Storybook." } } } diff --git a/packages/react-native/generators.json b/packages/react-native/generators.json index 13aaaa6647f71..860eab8433f7a 100644 --- a/packages/react-native/generators.json +++ b/packages/react-native/generators.json @@ -6,7 +6,7 @@ "init": { "factory": "./src/generators/init/init#reactNativeInitSchematic", "schema": "./src/generators/init/schema.json", - "description": "Initialize the @nrwl/react-native plugin", + "description": "Initialize the `@nrwl/react-native` plugin.", "hidden": true }, "application": { @@ -14,37 +14,37 @@ "schema": "./src/generators/application/schema.json", "aliases": ["app"], "x-type": "application", - "description": "Create a React Native application" + "description": "Create a React Native application." }, "library": { "factory": "./src/generators/library/library#reactNativeLibrarySchematic", "schema": "./src/generators/library/schema.json", "aliases": ["lib"], "x-type": "library", - "description": "Create a React Native library" + "description": "Create a React Native library." }, "component": { "factory": "./src/generators/component/component#reactNativeComponentSchematic", "schema": "./src/generators/component/schema.json", - "description": "Create a React Native component", + "description": "Create a React Native component.", "aliases": ["c"] }, "storybook-configuration": { "factory": "./src/generators/storybook-configuration/configuration#storybookConfigurationSchematic", "schema": "./src/generators/storybook-configuration/schema.json", - "description": "Set up storybook for a react-native app or library", + "description": "Set up Storybook for a React-native application or library.", "hidden": false }, "component-story": { "factory": "./src/generators/component-story/component-story#componentStorySchematic", "schema": "./src/generators/component-story/schema.json", - "description": "Generate storybook story for a react-native component", + "description": "Generate Storybook story for a React-native component.", "hidden": false }, "stories": { "factory": "./src/generators/stories/stories#storiesSchematic", "schema": "./src/generators/stories/schema.json", - "description": "Create stories for all components declared in an app or library", + "description": "Create stories for all components declared in an application or library.", "hidden": false } }, @@ -52,7 +52,7 @@ "init": { "factory": "./src/generators/init/init#reactNativeInitGenerator", "schema": "./src/generators/init/schema.json", - "description": "Initialize the @nrwl/react-native plugin", + "description": "Initialize the `@nrwl/react-native` plugin.", "hidden": true }, "application": { @@ -60,37 +60,37 @@ "schema": "./src/generators/application/schema.json", "aliases": ["app"], "x-type": "application", - "description": "Create a React Native application" + "description": "Create a React Native application." }, "library": { "factory": "./src/generators/library/library#reactNativeLibraryGenerator", "schema": "./src/generators/library/schema.json", "aliases": ["lib"], "x-type": "library", - "description": "Create a React Native library" + "description": "Create a React Native library." }, "component": { "factory": "./src/generators/component/component#reactNativeComponentGenerator", "schema": "./src/generators/component/schema.json", - "description": "Create a React Native component", + "description": "Create a React Native component.", "aliases": ["c"] }, "storybook-configuration": { "factory": "./src/generators/storybook-configuration/configuration#storybookConfigurationGenerator", "schema": "./src/generators/storybook-configuration/schema.json", - "description": "Set up storybook for a react-native app or library", + "description": "Set up Storybook for a React-native application or library.", "hidden": false }, "component-story": { "factory": "./src/generators/component-story/component-story#componentStoryGenerator", "schema": "./src/generators/component-story/schema.json", - "description": "Generate storybook story for a react-native component", + "description": "Generate Storybook story for a React-native component.", "hidden": false }, "stories": { "factory": "./src/generators/stories/stories#storiesGenerator", "schema": "./src/generators/stories/schema.json", - "description": "Create stories/specs for all components declared in an app or library", + "description": "Create stories/specs for all components declared in an application or library.", "hidden": false } } diff --git a/packages/react-native/package.json b/packages/react-native/package.json index 68eaa1db1e9bb..ea81c7937a5a8 100644 --- a/packages/react-native/package.json +++ b/packages/react-native/package.json @@ -1,7 +1,7 @@ { "name": "@nrwl/react-native", "version": "0.0.1", - "description": "React Native Plugin for Nx", + "description": "React Native brings React's declarative UI framework to iOS and Android. With React Native, you use native UI controls and have full access to the native platform.\n\nThe Nx Plugin for React Native contains generators for managing React Native applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Detox, and Storybook.\n\n- Scaffolding for creating buildable libraries that can be published to npm.\n\n- Utilities for automatic workspace refactoring.", "keywords": [ "Monorepo", "React",