Feat/react native harness support

README.md

@@ -16,6 +16,7 @@ A CLI tool that simplifies creating React Native modules powered by Nitro Module
 - 📚 TypeScript support out of the box
 - 🔧 Zero configuration required
 - ⚙️ Automated ios/android build with GitHub Actions
+- 🧪 Optional React Native Harness setup for native Android and iOS tests
 - 📦 Semantic Release
 
 ## 📖 Documentation

docs/docs/commands.md

@@ -25,6 +25,7 @@ Options:
   --platforms <platforms>             comma-separated platforms to target
   --langs <langs>                     comma-separated languages to generate
   -d, --module-dir <moduleDirectory>  directory to create the module in
+  --include-harness                   include React Native Harness setup in the example app
   -e, --skip-example                  skip example app generation
   -i, --skip-install                  skip installing dependencies
   --ci                               run in CI mode

docs/docs/usage/create-a-nitro-module.md

@@ -36,6 +36,35 @@ To create a Nitro Module along with an example app, use the following command. T
   </TabItem>
 </Tabs>
 
+## With React Native Harness
+
+If you want the generated example app to include React Native Harness for native Android and iOS tests, pass the `--include-harness` flag.
+
+<Tabs groupId="cli">
+  <TabItem value="bun" label="Bun" default>
+  ```bash
+  bun create nitro-module@latest my-awesome-module --include-harness
+  ```
+  </TabItem>
+  <TabItem value="npx" label="Npx">
+  ```bash
+  npx create-nitro-module@latest my-awesome-module --include-harness
+  ```
+  </TabItem>
+  <TabItem value="yarn" label="Yarn">
+  ```bash
+  yarn create nitro-module@latest my-awesome-module --include-harness
+  ```
+  </TabItem>
+  <TabItem value="pnpm" label="Pnpm">
+  ```bash
+  pnpm create nitro-module@latest my-awesome-module --include-harness
+  ```
+  </TabItem>
+</Tabs>
+
+The generated `example` app will include Harness config, sample native test files, package scripts, and a GitHub Actions workflow for the selected platforms.
+
 ## Without example app
 
 If you prefer to create a Nitro Module without an example app, use the following command. This will generate only the module, without any additional example app.

eslint.config.js

@@ -8,7 +8,7 @@ export default defineConfig([
     js.configs.recommended,
     nodePlugin.configs['flat/recommended-script'],
     {
-        files: ['src/*.ts'],
+        files: ['src/**/*.ts'],
         languageOptions: {
             parser: tsParser,
             parserOptions: {

src/cli/create.ts

@@ -186,6 +186,12 @@ export const createModule = async (
             }
         }
 
+        if (options.skipExample && options.includeHarness) {
+            throw new Error(
+                'React Native Harness requires the generated example app. Remove --skip-example or omit --include-harness.'
+            )
+        }
+
         if (
             options.packageType &&
             ![Nitro.Module, Nitro.View].includes(options.packageType)
@@ -213,6 +219,7 @@ export const createModule = async (
             spinner,
             packageType,
             finalPackageName: 'react-native-' + packageName.toLowerCase(),
+            includeHarness: answers.includeHarness,
             skipInstall: options.skipInstall,
             skipExample: options.skipExample,
         })
@@ -254,8 +261,10 @@ export const createModule = async (
 
         console.log(
             generateInstructions({
+                includeHarness: answers.includeHarness,
                 moduleName: `react-native-${packageName.toLowerCase()}`,
                 pm: answers.pm,
+                platforms: answers.platforms,
                 skipExample: options.skipExample,
                 skipInstall: options.skipInstall,
             })
@@ -350,6 +359,7 @@ const getUserAnswers = async (
             description: `${kleur.yellow(`react-native-${name}`)} is a react native package built with Nitro`,
             platforms,
             packageType,
+            includeHarness: options.includeHarness === true,
             platformLangs: parsePlatformLangsOption(
                 options.langs,
                 platforms,
@@ -479,6 +489,22 @@ const getUserAnswers = async (
                     ],
                 })
             },
+            includeHarness: async () => {
+                if (options?.skipExample) {
+                    return false
+                }
+
+                if (options?.includeHarness === true) {
+                    return true
+                }
+
+                return p.confirm({
+                    message: kleur.cyan(
+                        'Include React Native Harness for native Android and iOS tests?'
+                    ),
+                    initialValue: false,
+                })
+            },
             packageNameConfirmation: async ({ results }) => {
                 const packageName = results.packageName
                 if (!packageName) {
@@ -511,6 +537,7 @@ const getUserAnswers = async (
         packageType: group.packageType,
         platforms: group.platforms,
         platformLangs: group.platformLangs as PlatformLangMap,
+        includeHarness: group.includeHarness as boolean,
         pm: group.pm,
         description: group.description as string,
     }

src/cli/index.ts

@@ -17,6 +17,10 @@ program
         '-d, --module-dir <moduleDirectory>',
         'directory to create the module in'
     )
+    .option(
+        '--include-harness',
+        'include React Native Harness setup in the example app'
+    )
     .option('-e, --skip-example', 'skip example app generation')
     .option('-i, --skip-install', 'skip installing dependencies')
     .option('--ci', 'run in CI mode')