@nx/react-native 0.0.0-pr-22179-271588f

package/src/generators/init/lib/add-git-ignore-entry.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addGitIgnoreEntry = void 0;
+const devkit_1 = require("@nx/devkit");
+const ignore_1 = require("ignore");
+const gitignore_entries_1 = require("./gitignore-entries");
+function addGitIgnoreEntry(host) {
+    if (!host.exists('.gitignore')) {
+        devkit_1.logger.warn(`Couldn't find .gitignore file to update`);
+        return;
+    }
+    let content = host.read('.gitignore', 'utf-8').trimEnd();
+    const ig = (0, ignore_1.default)();
+    ig.add(host.read('.gitignore', 'utf-8'));
+    if (!ig.ignores('apps/example/ios/Pods/Folly')) {
+        content = `${content}\n${gitignore_entries_1.gitIgnoreEntriesForReactNative}\n`;
+    }
+    // also ignore nested node_modules folders due to symlink for React Native
+    if (!ig.ignores('apps/example/node_modules')) {
+        content = `${content}\n## Nested node_modules\n\nnode_modules/\n`;
+    }
+    host.write('.gitignore', content);
+}
+exports.addGitIgnoreEntry = addGitIgnoreEntry;

package/src/generators/init/lib/gitignore-entries.d.ts

@@ -0,0 +1 @@
+export declare const gitIgnoreEntriesForReactNative = "\n# React Native\n\n# OSX\n#\n.DS_Store\n\n# Xcode\n#\nbuild/\n*.pbxuser\n!default.pbxuser\n*.mode1v3\n!default.mode1v3\n*.mode2v3\n!default.mode2v3\n*.perspectivev3\n!default.perspectivev3\nxcuserdata\n*.xccheckout\n*.moved-aside\nDerivedData\n*.hmap\n*.ipa\n*.xcuserstate\nios/.xcode.env.local\n\n# Android/IntelliJ\n#\nbuild/\n.idea\n.gradle\nlocal.properties\n*.iml\n*.hprof\n.cxx/\n*.keystore\n!debug.keystore\n\n# node.js\n#\nnode_modules/\nnpm-debug.log\nyarn-error.log\n\n# fastlane\n#\n# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the\n# screenshots whenever they are needed.\n# For more information about the recommended setup visit:\n# https://docs.fastlane.tools/best-practices/source-control/\n\n**/fastlane/report.xml\n**/fastlane/Preview.html\n**/fastlane/screenshots\n**/fastlane/test_output\n\n# Bundle artifact\n*.jsbundle\n\n# Ruby / CocoaPods\n**/ios/Pods/\n**/vendor/bundle/\n\n# Temporary files created by Metro to check the health of the file watcher\n.metro-health-check*\n\n# testing\n/coverage\n";

package/src/generators/init/lib/gitignore-entries.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitIgnoreEntriesForReactNative = void 0;
+// template from https://github.com/facebook/react-native/blob/main/template/_gitignore
+exports.gitIgnoreEntriesForReactNative = `
+# React Native
+
+# OSX
+#
+.DS_Store
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+ios/.xcode.env.local
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+*.hprof
+.cxx/
+*.keystore
+!debug.keystore
+
+# node.js
+#
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/
+
+**/fastlane/report.xml
+**/fastlane/Preview.html
+**/fastlane/screenshots
+**/fastlane/test_output
+
+# Bundle artifact
+*.jsbundle
+
+# Ruby / CocoaPods
+**/ios/Pods/
+**/vendor/bundle/
+
+# Temporary files created by Metro to check the health of the file watcher
+.metro-health-check*
+
+# testing
+/coverage
+`;

package/src/generators/init/schema.d.ts

@@ -0,0 +1,7 @@
+export interface Schema {
+  skipFormat?: boolean;
+  skipPackageJson?: boolean; //default is false
+  keepExistingVersions?: boolean; //default is false
+  updatePackageScripts?: boolean;
+  addPlugin?: boolean;
+}

package/src/generators/init/schema.json

@@ -0,0 +1,35 @@
+{
+  "cli": "nx",
+  "$id": "NxReactNativeInit",
+  "$schema": "https://json-schema.org/schema",
+  "title": "Add Nx React Native Schematics",
+  "description": "Add Nx React native schematics.",
+  "type": "object",
+  "properties": {
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "skipPackageJson": {
+      "description": "Do not add dependencies to `package.json`.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update `package.json` scripts with inferred targets",
+      "default": false
+    }
+  },
+  "required": []
+}

package/src/generators/library/files/lib/.babelrc.js.template

@@ -0,0 +1,21 @@
+module.exports = function (api) {
+  api.cache(true);
+  
+  return {
+    presets: [
+      [
+        '@nx/react/babel',
+        {
+          runtime: 'automatic',
+          useBuiltIns: 'usage',
+        },
+      ],
+    ],
+    plugins: [],
+    env: {
+      test: {
+        presets: [['module:@react-native/babel-preset',  { "useTransformReactJSX": true }]],
+      },
+    },
+  };
+};

package/src/generators/library/files/lib/README.md

@@ -0,0 +1,7 @@
+# <%= name %>
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test <%= name %>` to execute the unit tests via [Jest](https://jestjs.io).

package/src/generators/library/files/lib/package.json.template

@@ -0,0 +1,4 @@
+{
+  "name": "<%= name %>",
+  "version": "0.0.1"
+}

package/src/generators/library/files/lib/test-setup.ts.template

@@ -0,0 +1 @@
+import '@testing-library/jest-native/extend-expect';

package/src/generators/library/files/lib/tsconfig.json.template

@@ -0,0 +1,16 @@
+{
+  "extends": "<%= rootTsConfigPath %>",
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "allowJs": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ]
+}

package/src/generators/library/files/lib/tsconfig.lib.json.template

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "<%= offsetFromRoot %>dist/out-tsc",
+    "types": ["node"]
+  },
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.spec.tsx", "test-setup.ts"],
+  "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
+}

package/src/generators/library/lib/normalize-options.d.ts

@@ -0,0 +1,12 @@
+import { Tree } from '@nx/devkit';
+import { Schema } from '../schema';
+export interface NormalizedSchema extends Schema {
+    name: string;
+    fileName: string;
+    projectRoot: string;
+    routePath: string;
+    parsedTags: string[];
+    appMain?: string;
+    appSourceRoot?: string;
+}
+export declare function normalizeOptions(host: Tree, options: Schema): Promise<NormalizedSchema>;

package/src/generators/library/lib/normalize-options.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeOptions = void 0;
+const devkit_1 = require("@nx/devkit");
+const project_name_and_root_utils_1 = require("@nx/devkit/src/generators/project-name-and-root-utils");
+async function normalizeOptions(host, options) {
+    const { projectName, names: projectNames, projectRoot, importPath, } = await (0, project_name_and_root_utils_1.determineProjectNameAndRootOptions)(host, {
+        name: options.name,
+        projectType: 'library',
+        directory: options.directory,
+        importPath: options.importPath,
+        projectNameAndRootFormat: options.projectNameAndRootFormat,
+        callingGenerator: '@nx/react-native:library',
+    });
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    options.addPlugin ??= addPluginDefault;
+    const parsedTags = options.tags
+        ? options.tags.split(',').map((s) => s.trim())
+        : [];
+    const normalized = {
+        ...options,
+        fileName: projectName,
+        routePath: `/${projectNames.projectSimpleName}`,
+        name: projectName,
+        projectRoot,
+        parsedTags,
+        importPath,
+    };
+    return normalized;
+}
+exports.normalizeOptions = normalizeOptions;

package/src/generators/library/library.d.ts

@@ -0,0 +1,5 @@
+import { GeneratorCallback, Tree } from '@nx/devkit';
+import { Schema } from './schema';
+export declare function reactNativeLibraryGenerator(host: Tree, schema: Schema): Promise<GeneratorCallback>;
+export declare function reactNativeLibraryGeneratorInternal(host: Tree, schema: Schema): Promise<GeneratorCallback>;
+export default reactNativeLibraryGenerator;

package/src/generators/library/library.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reactNativeLibraryGeneratorInternal = exports.reactNativeLibraryGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const js_1 = require("@nx/js");
+const init_1 = require("../init/init");
+const add_linting_1 = require("../../utils/add-linting");
+const add_jest_1 = require("../../utils/add-jest");
+const versions_1 = require("../../utils/versions");
+const normalize_options_1 = require("./lib/normalize-options");
+const ensure_dependencies_1 = require("../../utils/ensure-dependencies");
+const log_show_project_command_1 = require("@nx/devkit/src/utils/log-show-project-command");
+async function reactNativeLibraryGenerator(host, schema) {
+    return await reactNativeLibraryGeneratorInternal(host, {
+        addPlugin: false,
+        projectNameAndRootFormat: 'derived',
+        ...schema,
+    });
+}
+exports.reactNativeLibraryGenerator = reactNativeLibraryGenerator;
+async function reactNativeLibraryGeneratorInternal(host, schema) {
+    const options = await (0, normalize_options_1.normalizeOptions)(host, schema);
+    if (options.publishable === true && !schema.importPath) {
+        throw new Error(`For publishable libs you have to provide a proper "--importPath" which needs to be a valid npm package name (e.g. my-awesome-lib or @myorg/my-lib)`);
+    }
+    const tasks = [];
+    const jsInitTask = await (0, js_1.initGenerator)(host, {
+        ...schema,
+        skipFormat: true,
+    });
+    tasks.push(jsInitTask);
+    const initTask = await (0, init_1.default)(host, { ...options, skipFormat: true });
+    tasks.push(initTask);
+    if (!options.skipPackageJson) {
+        tasks.push((0, ensure_dependencies_1.ensureDependencies)(host));
+    }
+    const addProjectTask = await addProject(host, options);
+    if (addProjectTask) {
+        tasks.push(addProjectTask);
+    }
+    createFiles(host, options);
+    const lintTask = await (0, add_linting_1.addLinting)(host, {
+        ...options,
+        projectName: options.name,
+        tsConfigPaths: [
+            (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.lib.json'),
+        ],
+    });
+    tasks.push(lintTask);
+    const jestTask = await (0, add_jest_1.addJest)(host, options.unitTestRunner, options.name, options.projectRoot, options.js, options.skipPackageJson, options.addPlugin);
+    tasks.push(jestTask);
+    if (options.publishable || options.buildable) {
+        updateLibPackageNpmScope(host, options);
+    }
+    if (!options.skipTsConfig) {
+        (0, js_1.addTsConfigPath)(host, options.importPath, [
+            (0, devkit_1.joinPathFragments)(options.projectRoot, './src', 'index.' + (options.js ? 'js' : 'ts')),
+        ]);
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(host);
+    }
+    tasks.push(() => {
+        (0, log_show_project_command_1.logShowProjectCommand)(options.name);
+    });
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.reactNativeLibraryGeneratorInternal = reactNativeLibraryGeneratorInternal;
+async function addProject(host, options) {
+    const project = {
+        root: options.projectRoot,
+        sourceRoot: (0, devkit_1.joinPathFragments)(options.projectRoot, 'src'),
+        projectType: 'library',
+        tags: options.parsedTags,
+        targets: {},
+    };
+    (0, devkit_1.addProjectConfiguration)(host, options.name, project);
+    if (!options.publishable && !options.buildable) {
+        return () => { };
+    }
+    const { configurationGenerator } = (0, devkit_1.ensurePackage)('@nx/rollup', versions_1.nxVersion);
+    const rollupConfigTask = await configurationGenerator(host, {
+        ...options,
+        project: options.name,
+        skipFormat: true,
+    });
+    const external = ['react/jsx-runtime', 'react-native', 'react', 'react-dom'];
+    project.targets.build = {
+        executor: '@nx/rollup:rollup',
+        outputs: ['{options.outputPath}'],
+        options: {
+            outputPath: `dist/${options.projectRoot}`,
+            tsConfig: `${options.projectRoot}/tsconfig.lib.json`,
+            project: `${options.projectRoot}/package.json`,
+            entryFile: maybeJs(options, `${options.projectRoot}/src/index.ts`),
+            external,
+            rollupConfig: `@nx/react/plugins/bundle-rollup`,
+            assets: [
+                {
+                    glob: `${options.projectRoot}/README.md`,
+                    input: '.',
+                    output: '.',
+                },
+            ],
+        },
+    };
+    (0, devkit_1.updateProjectConfiguration)(host, options.name, project);
+    return rollupConfigTask;
+}
+function updateTsConfig(tree, options) {
+    (0, devkit_1.updateJson)(tree, (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.json'), (json) => {
+        if (options.strict) {
+            json.compilerOptions = {
+                ...json.compilerOptions,
+                forceConsistentCasingInFileNames: true,
+                strict: true,
+                noImplicitReturns: true,
+                noFallthroughCasesInSwitch: true,
+            };
+        }
+        return json;
+    });
+}
+function createFiles(host, options) {
+    (0, devkit_1.generateFiles)(host, (0, devkit_1.joinPathFragments)(__dirname, './files/lib'), options.projectRoot, {
+        ...options,
+        ...(0, devkit_1.names)(options.name),
+        offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.projectRoot),
+        rootTsConfigPath: (0, js_1.getRelativePathToRootTsConfig)(host, options.projectRoot),
+    });
+    if (!options.publishable && !options.buildable) {
+        host.delete(`${options.projectRoot}/package.json`);
+    }
+    if (options.js) {
+        (0, devkit_1.toJS)(host);
+    }
+    updateTsConfig(host, options);
+}
+function updateLibPackageNpmScope(host, options) {
+    return (0, devkit_1.updateJson)(host, `${options.projectRoot}/package.json`, (json) => {
+        json.name = options.importPath;
+        json.peerDependencies = {
+            react: versions_1.reactVersion,
+            'react-native': versions_1.reactNativeVersion,
+        };
+        return json;
+    });
+}
+function maybeJs(options, path) {
+    return options.js && (path.endsWith('.ts') || path.endsWith('.tsx'))
+        ? path.replace(/\.tsx?$/, '.js')
+        : path;
+}
+exports.default = reactNativeLibraryGenerator;