Skip to content

Commit fb908eb

Browse files
Copilotanupriya13
andcommitted
Update documentation to remove skip-deps and skip-build options and reflect latest changes
Co-authored-by: anupriya13 <[email protected]>
1 parent 6dfe853 commit fb908eb

File tree

2 files changed

+4
-27
lines changed

2 files changed

+4
-27
lines changed

packages/@react-native-windows/cli/src/commands/setupModuleWindows/EXAMPLE.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,6 @@ yarn react-native setup-module-windows --template cpp-app --logging
5757
[SetupModuleWindows] Found valid spec file(s): NativeReactNativeWebview.ts
5858
[SetupModuleWindows] Extracted actual module name: ReactNativeWebview
5959
[SetupModuleWindows] Added codegenConfig to package.json with module name: ReactNativeWebview
60-
[SetupModuleWindows] Installing dependencies...
61-
[SetupModuleWindows] Dependencies installed
6260
[SetupModuleWindows] Running init-windows with cpp-lib template...
6361
[SetupModuleWindows] init-windows completed successfully
6462
[SetupModuleWindows] Running codegen-windows...
@@ -221,14 +219,8 @@ yarn react-native setup-module-windows --template cpp-lib
221219
# Verbose logging
222220
yarn react-native setup-module-windows --logging
223221

224-
# Skip dependency upgrades
225-
yarn react-native setup-module-windows --skip-deps
226-
227-
# Skip build verification
228-
yarn react-native setup-module-windows --skip-build
229-
230222
# Combine options
231-
yarn react-native setup-module-windows --template cpp-app --logging --skip-deps
223+
yarn react-native setup-module-windows --template cpp-app --logging
232224
```
233225

234226
## Error Handling

packages/@react-native-windows/cli/src/commands/setupModuleWindows/README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ yarn react-native setup-module-windows [options]
1212

1313
- `--logging`: Enable verbose output logging
1414
- `--no-telemetry`: Disable telemetry tracking
15-
- `--skip-deps`: Skip dependency upgrades (use current versions)
16-
- `--skip-build`: Skip final build verification step
1715
- `--template <template>`: Project template (cpp-lib or cpp-app), defaults to cpp-lib
1816

1917
## What it does
@@ -24,14 +22,11 @@ The command performs the following steps automatically:
2422

2523
2. **Package.json Updates**: Adds or updates the `codegenConfig` section in package.json with proper Windows codegen configuration.
2624

27-
3. **Dependency Management**:
28-
- Installs dependencies using yarn
25+
3. **Windows Library Setup**: Runs `init-windows --template <template>` to create the Windows-specific project structure. Supports both `cpp-lib` (default) and `cpp-app` templates.
2926

30-
4. **Windows Library Setup**: Runs `init-windows --template <template>` to create the Windows-specific project structure. Supports both `cpp-lib` (default) and `cpp-app` templates.
27+
4. **Code Generation**: Runs `codegen-windows` to generate C++ spec files from TypeScript/JavaScript specs.
3128

32-
5. **Code Generation**: Runs `codegen-windows` to generate C++ spec files from TypeScript/JavaScript specs.
33-
34-
6. **C++ Stub Generation**: Creates C++ header (.h) and implementation (.cpp) stub files with:
29+
5. **C++ Stub Generation**: Creates C++ header (.h) and implementation (.cpp) stub files with:
3530
- Proper method signatures matching the TypeScript spec
3631
- Reference multiply function as commented example (from cpp-lib template)
3732
- Hello World `sayHello` function to verify module functionality
@@ -173,16 +168,6 @@ With verbose logging:
173168
yarn react-native setup-module-windows --logging
174169
```
175170

176-
Skip dependency upgrades:
177-
```bash
178-
yarn react-native setup-module-windows --skip-deps
179-
```
180-
181-
Skip build verification:
182-
```bash
183-
yarn react-native setup-module-windows --skip-build
184-
```
185-
186171
## Error Messages
187172

188173
**"Create Spec File - TurboModule spec file not found"**: You need to create a TurboModule spec file before running this command. The command will not automatically create spec files.

0 commit comments

Comments
 (0)