@ronas-it/nx-generators 0.3.4 → 0.3.6

package/README.md

@@ -2,17 +2,9 @@
 
 NX generators for Ronas IT projects.
 
-At the moment this library contains the following generators:
-
-1. `repo-config` - setups the monorepo structure for React Native development.
-1. `code-checks` - configures code checks and formatting with pre-commit hook.
-1. `expo-app` - generates and configures Expo React Native app.
-1. `react-lib` - generates a library according to [NX notation](https://nx.dev/concepts/more-concepts/applications-and-libraries).
-1. `react-component` - creates a React component in particular library.
-
 ## Usage
 
-1. Create monorepo with Expo app using [NX preset](https://nx.dev/nx-api/expo):
+1. Create monorepo with Expo app using [NX Expo preset](https://nx.dev/nx-api/expo) or with Next.js app using [NX Next preset](https://nx.dev/nx-api/next):
 
 ```sh
 npx create-nx-workspace@latest my-project --preset=expo --appName=my-app --e2eTestRunner=none --ci=skip
@@ -29,7 +21,7 @@ npm i @ronas-it/nx-generators --save-dev
 ```sh
 npx nx g repo-config
 npx nx g code-checks
-npx nx g expo-app
+npx nx g expo-app // for Expo app
 ```
 
 Or run all generators at once:
@@ -51,6 +43,80 @@ npx nx g react-lib mobile/account/features/profile-settings --withComponent
 npx nx g react-component
 ```
 
+## Generators overview
+
+### 1. `repo-config`
+
+Setups the monorepo structure for development.
+
+### 2. `code-checks`
+
+Configures code checks and formatting with pre-commit hook.
+
+### 3. `expo-app`
+
+Generates and configures Expo React Native app.
+
+### Options
+
+1. `name` (optional) - name of the app for `app.config.ts` (e.g: my-app)
+
+2. `directory` (optional) - name of the directory in the `apps/` folder (e.g: mobile)
+
+### Example
+
+```sh
+npx nx g expo-app --name=my-app --directory=mobile
+```
+or
+```sh
+npx nx g expo-app my-app mobile
+```
+
+### 4. `react-lib`
+
+Generates a library according to [NX notation](https://nx.dev/concepts/more-concepts/applications-and-libraries).
+
+### Options
+
+1. `directory` (optional) - directory for the library (e.g. mobile/account/features/profile-settings)
+
+2. `withComponent` (optional) - generate the library with `lib/component.tsx` file
+
+3. `dryRun` (optional) - generate the library without creating files
+
+### Example
+
+```sh
+npx nx g react-lib --directory=mobile/account/features/profile-settings --withComponent --dryRun
+```
+or
+```sh
+npx nx g react-lib mobile/account/features/profile-settings --withComponent --dryRun
+```
+
+### 5. `react-component`
+
+Creates a React component in particular library.
+
+### Options
+
+1. `name` (optional) - name of the component (e.g. AppButton)
+
+2. `subcomponent` (optional) - generate a folder for components
+
+### Example
+
+```sh
+npx nx g react-component --name=AppButton --subcomponent
+```
+or
+```sh
+npx nx g react-component AppButton --subcomponent
+```
+
+### Note
+
 Each generator accepts the `--help` argument to see generator instructions.
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronas-it/nx-generators",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "NX generators for Ronas IT projects",
   "license": "MIT",
   "author": "Ronas IT",
@@ -33,4 +33,4 @@
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",
   "generators": "./generators.json"
-}
+}

package/src/generators/code-checks/generator.js

@@ -8,8 +8,8 @@ const devkit_1 = require("@nx/devkit");
 const config_1 = require("./config");
 const scripts_1 = require("./scripts");
 function codeChecksGenerator(tree, options) {
-    var _a;
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        var _a;
         const projectRoot = '.';
         // Delete files
         tree.delete('.eslintrc.json');
@@ -40,7 +40,7 @@ function codeChecksGenerator(tree, options) {
             'eslint-plugin-react': '^7.34.3',
             'eslint-plugin-react-hooks': '^4.6.2',
             'eslint-plugin-react-native': '^4.1.0',
-            'eslint-plugin-unused-imports': '^4.0.0',
+            'eslint-plugin-unused-imports': '^3.0.0',
             '@typescript-eslint/eslint-plugin': '^7.13.1',
             '@typescript-eslint/parser': '^7.13.1',
             'tsc-files': '^1.1.4',

package/src/generators/code-checks/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/code-checks/generator.ts"],"names":[],"mappings":";;;;AAAA,iDAAyC;AACzC,6BAA6B;AAC7B,uCAQoB;AACpB,qCAA8B;AAE9B,uCAAgC;AAEhC,SAAsB,mBAAmB,CAAC,IAAU,EAAE,OAAkC;;;QACtF,MAAM,WAAW,GAAG,GAAG,CAAC;QAExB,eAAe;QACf,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE3B,4BAA4B;QAC5B,IAAA,wBAAQ,EAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAExD,MAAM,WAAW,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACnD,WAAW,CAAC,aAAa,CAAC,GAAG,gBAAM,CAAC,aAAa,CAAC,CAAC;QACnD,WAAW,CAAC,OAAO,mCAAQ,iBAAO,GAAK,WAAW,CAAC,OAAO,CAAE,CAAC;QAC7D,IAAA,kBAAS,EAAC,IAAI,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;QAE7C,4BAA4B;QAC5B,MAAM,YAAY,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QAC1D,YAAY,CAAC,eAAe,mCAAQ,gBAAM,CAAC,QAAQ,GAAK,YAAY,CAAC,eAAe,CAAE,CAAC;QACvF,IAAA,kBAAS,EAAC,IAAI,EAAE,oBAAoB,EAAE,YAAY,CAAC,CAAC;QAEpD,oBAAoB;QACpB,MAAM,gBAAgB,GAAG,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,0CAAE,QAAQ,EAAE,IAAG,kBAAkB,CAAC;QAClF,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;QAE3C,YAAY;QACZ,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAEzE,iCAAiC;QACjC,IAAA,qCAA4B,EAC1B,IAAI,EACJ,EAAE,EACF;YACE,QAAQ,EAAE,SAAS;YACnB,UAAU,EAAE,QAAQ;YACpB,wBAAwB,EAAE,QAAQ;YAClC,mCAAmC,EAAE,QAAQ;YAC7C,sBAAsB,EAAE,SAAS;YACjC,wBAAwB,EAAE,QAAQ;YAClC,qBAAqB,EAAE,SAAS;YAChC,2BAA2B,EAAE,QAAQ;YACrC,4BAA4B,EAAE,QAAQ;YACtC,8BAA8B,EAAE,QAAQ;YACxC,kCAAkC,EAAE,SAAS;YAC7C,2BAA2B,EAAE,SAAS;YACtC,WAAW,EAAE,QAAQ;SACtB,CACF,CAAC;QAEF,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;;CACH;AArDD,kDAqDC;AAED,kBAAe,mBAAmB,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/code-checks/generator.ts"],"names":[],"mappings":";;;;AAAA,iDAAyC;AACzC,6BAA6B;AAC7B,uCAQoB;AACpB,qCAA8B;AAE9B,uCAAgC;AAEhC,SAAsB,mBAAmB,CAAC,IAAU,EAAE,OAAkC;;;QACtF,MAAM,WAAW,GAAG,GAAG,CAAC;QAExB,eAAe;QACf,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE3B,4BAA4B;QAC5B,IAAA,wBAAQ,EAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAExD,MAAM,WAAW,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACnD,WAAW,CAAC,aAAa,CAAC,GAAG,gBAAM,CAAC,aAAa,CAAC,CAAC;QACnD,WAAW,CAAC,OAAO,mCAAQ,iBAAO,GAAK,WAAW,CAAC,OAAO,CAAE,CAAC;QAC7D,IAAA,kBAAS,EAAC,IAAI,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;QAE7C,4BAA4B;QAC5B,MAAM,YAAY,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QAC1D,YAAY,CAAC,eAAe,mCAAQ,gBAAM,CAAC,QAAQ,GAAK,YAAY,CAAC,eAAe,CAAE,CAAC;QACvF,IAAA,kBAAS,EAAC,IAAI,EAAE,oBAAoB,EAAE,YAAY,CAAC,CAAC;QAEpD,oBAAoB;QACpB,MAAM,gBAAgB,GAAG,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,0CAAE,QAAQ,EAAE,IAAG,kBAAkB,CAAC;QAClF,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;QAE3C,YAAY;QACZ,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAEzE,iCAAiC;QACjC,IAAA,qCAA4B,EAC1B,IAAI,EACJ,EAAE,EACF;YACE,QAAQ,EAAE,SAAS;YACnB,UAAU,EAAE,QAAQ;YACpB,wBAAwB,EAAE,QAAQ;YAClC,mCAAmC,EAAE,QAAQ;YAC7C,sBAAsB,EAAE,SAAS;YACjC,wBAAwB,EAAE,QAAQ;YAClC,qBAAqB,EAAE,SAAS;YAChC,2BAA2B,EAAE,QAAQ;YACrC,4BAA4B,EAAE,QAAQ;YACtC,8BAA8B,EAAE,QAAQ;YACxC,kCAAkC,EAAE,SAAS;YAC7C,2BAA2B,EAAE,SAAS;YACtC,WAAW,EAAE,QAAQ;SACtB,CACF,CAAC;QAEF,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC;CAAA;AArDD,kDAqDC;AAED,kBAAe,mBAAmB,CAAC"}

package/src/generators/code-checks/scripts.d.ts

@@ -1,5 +1,6 @@
 declare const _default: {
     lint: string;
     format: string;
+    prepare: string;
 };
 export default _default;

package/src/generators/code-checks/scripts.js

@@ -3,5 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     'lint': 'npx tsc && npx eslint ./',
     'format': 'npx prettier --write . && npm run lint -- --fix',
+    'prepare': 'husky',
 };
 //# sourceMappingURL=scripts.js.map

package/src/generators/code-checks/scripts.js.map

@@ -1 +1 @@
-{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/code-checks/scripts.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,MAAM,EAAE,0BAA0B;IAClC,QAAQ,EAAE,iDAAiD;CAC5D,CAAA"}
+{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/code-checks/scripts.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,MAAM,EAAE,0BAA0B;IAClC,QAAQ,EAAE,iDAAiD;IAC3D,SAAS,EAAE,OAAO;CACnB,CAAA"}

package/src/generators/expo-app/files/README.md.template

@@ -0,0 +1,70 @@
+# <%= formatName(name) %> - Mobile app
+
+React Native mobile app for Android and iOS.
+
+## Scripts overview
+
+See `package.json` for pre-defined scripts.\
+You can run them using `npm run {script} -- {arguments}` or `yarn {script} {arguments}`:
+
+- `start` - Start local development server
+- `build:{environment}` - Create builds for _both_ platforms
+  - Pass `-p {android|ios}` to run a platform-specific build
+  - To create a [Development client](https://docs.expo.dev/develop/development-builds/introduction/) build run `build:debug`
+- `submit:ios:{environment}` - Submit iOS build to AppStore Connect
+- `update:{environment}` - Publish OTA-update for specified environment
+
+## Development
+
+This app uses [Expo development builds](https://docs.expo.dev/develop/development-builds/introduction/)
+for local development.
+
+### Run on a virtual device
+
+- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/): `npm run android`
+- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/) (macOS is required): `npm run ios`
+
+### Run on a physical device
+
+1. Find the latest `debug`-profile build for your platform in Expo project or run `build:debug` script to create a new one.
+1. Download the build artifact and install it on your device.
+1. Run the `start` script to launch a local development server.
+1. Connect to the server using dev-client you installed.
+
+**Note**: For iOS you need to register your device first as [described](https://docs.expo.dev/build/internal-distribution/#setting-up-ad-hoc-provisioning).\
+After that [resign](https://docs.expo.dev/app-signing/app-credentials/#re-signing-new-credentials) existing build or a create new one. This is required only once.
+
+## Releases
+
+### 1. Prepare
+
+1. Increment `ios.buildNumber` and `android.versionCode` values and update `version` (if necessary) in `app.config.ts`
+1. Commit the changes with version `v{version}-{buildNumber}`, for example: `chore: release v1.2.2-12`
+1. Create or update version tag: `git tag v1.2.2-12`
+1. Push changes: `git push && git push --tags`
+1. Create new release in [Releases](../../../../-/releases) based on tag you pushed
+
+### 2. Create builds
+
+- `build:dev` - build development version for internal testing
+- `build:prod` - build production version for stores
+
+### 3. Distribute
+
+#### Internal testing
+
+- Android: share .apk builds with testers
+- iOS: send created builds to Testflight using `submit:ios:dev`
+
+#### Production
+
+- Android: Download production build artifact and upload it to Google Play Console
+- iOS: submit production builds App Store Connect using `submit:ios:prod`
+
+### OTA updates
+
+Minor fixes can be distributed over-the-air using [EAS Update](https://docs.expo.dev/eas-update/introduction/):
+
+1. Update `version` in `app.config.ts`
+2. Commit the changes
+3. Publish OTA-update for desired environment: `update:dev` or `update:prod`

package/src/generators/expo-app/generator.js

@@ -24,7 +24,7 @@ function expoAppGenerator(tree, options) {
         // Install @nx/expo plugin
         (0, child_process_1.execSync)('npx nx add @nx/expo', { stdio: 'inherit' });
         if (!(0, fs_1.existsSync)(appRoot)) {
-            (0, child_process_1.execSync)(`npx nx g app ${options.name} --directory=apps/${options.directory} --projectNameAndRootFormat=as-provided --unitTestRunner=none --e2eTestRunner=none`);
+            (0, child_process_1.execSync)(`npx nx g @nx/expo:app ${options.name} --directory=apps/${options.directory} --projectNameAndRootFormat=as-provided --unitTestRunner=none --e2eTestRunner=none`, { stdio: 'inherit' });
         }
         const appPackagePath = `${appRoot}/package.json`;
         // Remove unnecessary files and files that will be replaced

package/src/generators/expo-app/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/expo-app/generator.ts"],"names":[],"mappings":";;;;AAAA,iDAAyC;AACzC,6BAA6B;AAC7B,uCAQoB;AAEpB,uCAAgC;AAChC,2BAAgC;AAChC,8CAAgD;AAEhD,MAAM,YAAY,GAAG;IACnB,gBAAgB,EAAE,SAAS;IAC3B,aAAa,EAAE,SAAS;IACxB,gCAAgC,EAAE,SAAS;IAC3C,sBAAsB,EAAE,SAAS;IACjC,cAAc,EAAE,QAAQ;IACxB,iBAAiB,EAAE,SAAS;IAC5B,cAAc,EAAE,UAAU;IAC1B,eAAe,EAAE,QAAQ;CAC1B,CAAC;AAEF,SAAsB,gBAAgB,CACpC,IAAU,EACV,OAA+B;;QAE/B,MAAM,OAAO,GAAG,QAAQ,OAAO,CAAC,SAAS,EAAE,CAAC;QAE5C,0BAA0B;QAC1B,IAAA,wBAAQ,EAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QAErD,IAAI,CAAC,IAAA,eAAU,EAAC,OAAO,CAAC,EAAE,CAAC;YACzB,IAAA,wBAAQ,EACN,gBAAgB,OAAO,CAAC,IAAI,qBAAqB,OAAO,CAAC,SAAS,oFAAoF,CACvJ,CAAC;QACJ,CAAC;QAED,MAAM,cAAc,GAAG,GAAG,OAAO,eAAe,CAAC;QAEjD,2DAA2D;QAC3D,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,oBAAoB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;QAE1C,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACtD,cAAc,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAC1C,cAAc,CAAC,OAAO,mCACjB,iBAAO,GACP,cAAc,CAAC,OAAO,CAC1B,CAAC;QACF,IAAA,kBAAS,EAAC,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;QAEhD,gBAAgB;QAChB,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,kCACrD,OAAO,KACV,UAAU,EAAV,kBAAU,IACV,CAAC;QAEH,mBAAmB;QACnB,IAAA,qCAA4B,EAC1B,IAAI,kCAEC,YAAY;YACf,sCAAsC;YACtC,yEAAyE;YACzE,8BAA8B,EAAE,QAAQ,KAE1C,EAAE,WAAW,EAAE,QAAQ,EAAE,CAC1B,CAAC;QAEF,IAAA,qCAA4B,EAAC,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;QAErE,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,IAAA,wBAAQ,EAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC;IACJ,CAAC;CAAA;AA7DD,4CA6DC;AAED,kBAAe,gBAAgB,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/expo-app/generator.ts"],"names":[],"mappings":";;;;AAAA,iDAAyC;AACzC,6BAA6B;AAC7B,uCAQoB;AAEpB,uCAAgC;AAChC,2BAAgC;AAChC,8CAAgD;AAEhD,MAAM,YAAY,GAAG;IACnB,gBAAgB,EAAE,SAAS;IAC3B,aAAa,EAAE,SAAS;IACxB,gCAAgC,EAAE,SAAS;IAC3C,sBAAsB,EAAE,SAAS;IACjC,cAAc,EAAE,QAAQ;IACxB,iBAAiB,EAAE,SAAS;IAC5B,cAAc,EAAE,UAAU;IAC1B,eAAe,EAAE,QAAQ;CAC1B,CAAC;AAEF,SAAsB,gBAAgB,CACpC,IAAU,EACV,OAA+B;;QAE/B,MAAM,OAAO,GAAG,QAAQ,OAAO,CAAC,SAAS,EAAE,CAAC;QAE5C,0BAA0B;QAC1B,IAAA,wBAAQ,EAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QAErD,IAAI,CAAC,IAAA,eAAU,EAAC,OAAO,CAAC,EAAE,CAAC;YACzB,IAAA,wBAAQ,EACN,yBAAyB,OAAO,CAAC,IAAI,qBAAqB,OAAO,CAAC,SAAS,oFAAoF,EAC/J,EAAE,KAAK,EAAE,SAAS,EAAE,CACrB,CAAC;QACJ,CAAC;QAED,MAAM,cAAc,GAAG,GAAG,OAAO,eAAe,CAAC;QAEjD,2DAA2D;QAC3D,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,oBAAoB,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,WAAW,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,GAAG,OAAO,kBAAkB,CAAC,CAAC;QAE1C,0BAA0B;QAC1B,MAAM,cAAc,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACtD,cAAc,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAC1C,cAAc,CAAC,OAAO,mCACjB,iBAAO,GACP,cAAc,CAAC,OAAO,CAC1B,CAAC;QACF,IAAA,kBAAS,EAAC,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;QAEhD,gBAAgB;QAChB,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,OAAO,kCACrD,OAAO,KACV,UAAU,EAAV,kBAAU,IACV,CAAC;QAEH,mBAAmB;QACnB,IAAA,qCAA4B,EAC1B,IAAI,kCAEC,YAAY;YACf,sCAAsC;YACtC,yEAAyE;YACzE,8BAA8B,EAAE,QAAQ,KAE1C,EAAE,WAAW,EAAE,QAAQ,EAAE,CAC1B,CAAC;QAEF,IAAA,qCAA4B,EAAC,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;QAErE,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,GAAG,EAAE;YACV,IAAA,4BAAmB,EAAC,IAAI,CAAC,CAAC;YAC1B,IAAA,wBAAQ,EAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3D,CAAC,CAAC;IACJ,CAAC;CAAA;AA9DD,4CA8DC;AAED,kBAAe,gBAAgB,CAAC"}

package/src/generators/expo-app/schema.json

@@ -18,7 +18,7 @@
       "description": "",
       "$default": {
         "$source": "argv",
-        "index": 0
+        "index": 1
       },
       "x-prompt": "Enter the name of the directory in the 'apps/' folder (e.g: mobile)"
     }

package/src/generators/repo-config/files/README.md.template

@@ -1,79 +1,111 @@
 # <%= formatName(name) %>
 
-✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨
+This workspace contains source code for <%= formatName(name) %> project.
+Each app in the `apps` directory has own `README` where you can find more details about it.
 
-## Start the app
+## Getting started
 
 1. Install dependencies: `npm install`
-1. Start app for local development: `npx nx start {app-name}`
-   - Use [Expo Go](https://expo.dev/client) to run mobile version
+1. Launch desired app for development:
 
-## Generate code
+```sh
+npx nx start {app-name}
+```
+
+Or navigate to an app directory to run it as described in `README`.
+
+## Resources
+
+Below are links to tools and services used in this project:
+
+- [Tasks]() (will be added later)
+- [Design]() (will be added later)
+- [Expo]() (will be added later)
+- [Google Play Console]() (will be added later)
+- [App Store Connect]() (will be added later)
+- [Firebase]() (will be added later)
+- [API Documentation]() (will be added later)
+- [Laravel Telescope]() (will be added later)
+- [Sentry]() (will be added later)
 
-### Shortcut scripts
+## Repository management
 
-See `package.json` for NX generator command shortcuts.
+This workspace uses [Nx](https://nx.dev/getting-started/intro) for repository management and code generation.
+You can install [Nx extension](https://nx.dev/getting-started/editor-setup) for your code editor.
 
-#### 1. Generate a library
+### Code generation
+
+We use [custom Nx generators](https://github.com/RonasIT/nx-generators) plugin for code generation.\
+Run `npx nx list @ronas-it/nx-generators` to view a list of available generators in the plugin.\
+Each generator accepts the `--help` argument to show instructions.
+
+#### Generate libraries
 
 ```sh
-npm run g:library {app|shared}/{context?}/{type}/{name}
+npx nx g react-lib
+npx nx g react-lib {app-name|shared}/{context?}/{type}/{name}
 ```
 
 Examples:
 
 ```sh
-npm run g:library mobile/client/features/profile-settings
-# generate a "profile-settings" feature library in "client" context for "mobile" app
+npx nx g react-lib mobile/account/features/profile-settings
+# generate a "profile-settings" feature library in "account" context for "mobile" app
 
-npm run g:library shared/ui/ui-kit
+npx nx g react-lib shared/ui/ui-kit
 # generate a "ui-kit" ui-library shared between all apps
 ```
 
-#### 2. Generate components
+#### Generate components
 
-- `npm run g:component --lib={library}` - generate a root component in some library
-- `npm run g:subcomponent --lib={library} --name={name}` - generate a library sub-component.
+- `npx nx g react-component` - generate a root component in some library
+- `npx nx g react-component --name=AppButton --subcomponent` - generate a library sub-component.
 
-Examples:
+#### Generate apps
 
-```sh
-npm run g:component --lib=mobile/client/features/profile-settings
-# generate a root component.tsx for feature library "profile-settings" in "client" context for "mobile" app
+- `npx nx g expo-app` - generate new RN Expo app
 
-npm run g:component --lib=mobile/shared/ui/ui-kit --name=button
-# generate an exported "button/component.tsx" component inside the "ui-kit" library
+### Running tasks
 
-npm run g:subcomponent --lib=mobile/client/features/profile-settings --name=settings-form
-# generate "components/settings-form/component.tsx" sub-component inside the "profile-settings" library
+To execute tasks with Nx use the following syntax: `npx nx <target> <project> <...options>`.\
+You can also run multiple targets: `npx nx run-many -t <target1> <target2>`.\
+Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks).
 
-```
+## Dependencies management
 
-### Use NX-generators directly
+This repository uses [NPM Workspaces](https://docs.npmjs.com/cli/using-npm/workspaces) to manage dependencies.
+Dependencies that used in `libs` should be listed both in root and app's `package.json`.
 
-Run `nx list` to get a list of available plugins and whether they have generators.
-Then run `nx list <plugin-name>` to see what generators are available.
+### Installing dependencies
 
-Navigate to [@nx/expo](https://nx.dev/packages/expo/generators) for see more available generators.
+Run the following scripts in the repository root:
 
-## Running tasks
+- `npm i {some-package} -w {app-name} -iwr` - install some package for particular app and for the whole repository
+- `npm i {some-package} -ws -iwr` - install some package for all apps and including root one `package.json`
 
-To execute tasks with Nx use the following syntax:
+You can also navigate to an app directory and install package there:
 
-```
-nx <target> <project> <...options>
-```
+- `npm i {some-package} -iwr`
 
-You can also run multiple targets:
+### Uninstalling dependencies
 
-```
-nx run-many -t <target1> <target2>
-```
+The same rules apply to removing dependencies:
 
-..or add `-p` to filter specific projects
+- `npm uni {some-package} -w {app-name} -iwr` - uninstall some package for particular app and for the whole repository
+- `npm uni {some-package} -ws -iwr` - uninstall some package for all apps and including root `package.json`
 
-```
-nx run-many -t <target1> <target2> -p <proj1> <proj2>
-```
+### Syncing dependencies
+
+To check consistency of packages versions across workspaces run the following command in the project root:
+
+- `npm run deps:sync`
+
+After that check the changes and run `npm i` to install adjusted versions.
+
+## Code checks
+
+This project has pre-configured linting and formatting rules with pre-commit hook.
+You can execute these commands for the whole project manually:
 
-Targets can be defined in the `package.json` or `projects.json` . Learn more [in the docs](https://nx.dev/run-tasks).
+- `npm run lint` - run necessary code checks
+- `npm run format` - run code autoformat

package/src/generators/repo-config/scripts.d.ts

@@ -1,7 +1,4 @@
 declare const _default: {
     'deps:sync': string;
-    'g:library': string;
-    'g:component': string;
-    'g:subcomponent': string;
 };
 export default _default;

package/src/generators/repo-config/scripts.js

@@ -2,8 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     'deps:sync': 'npx syncpack fix-mismatches',
-    'g:library': 'npx nx g @nx/expo:lib --skipPackageJson --unitTestRunner=none',
-    'g:component': 'npx nx g @nx/expo:component component --export --flat --skipTests --directory=lib/${npm_config_name}',
-    'g:subcomponent': 'npx nx g @nx/expo:component component --export=false --flat --skipTests --directory=lib/components/${npm_config_name}',
 };
 //# sourceMappingURL=scripts.js.map

package/src/generators/repo-config/scripts.js.map

@@ -1 +1 @@
-{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/repo-config/scripts.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,WAAW,EAAE,6BAA6B;IAC1C,WAAW,EAAE,+DAA+D;IAC5E,aAAa,EACX,sGAAsG;IACxG,gBAAgB,EACd,uHAAuH;CAC1H,CAAC"}
+{"version":3,"file":"scripts.js","sourceRoot":"","sources":["../../../../../plugin/src/generators/repo-config/scripts.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb,WAAW,EAAE,6BAA6B;CAC3C,CAAC"}