@ronas-it/nx-generators 0.10.2 → 0.10.4

package/.eslintrc.json

@@ -0,0 +1,37 @@
+{
+  "extends": ["../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": [
+          "error",
+          {
+            "ignoredDependencies": ["@nx/expo"]
+          }
+        ]
+      }
+    },
+    {
+      "files": ["./package.json", "./generators.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/nx-plugin-checks": "error"
+      }
+    }
+  ]
+}

package/README.md

@@ -85,7 +85,9 @@ Generates and configures an Expo React Native app.
 ```sh
 npx nx g expo-app --name=my-app --directory=mobile
 ```
+
 or
+
 ```sh
 npx nx g expo-app my-app mobile
 ```
@@ -105,7 +107,9 @@ Generates and configures a Next.js app.
 ```sh
 npx nx g next-app --name=my-app --directory=web
 ```
+
 or
+
 ```sh
 npx nx g next-app my-app web
 ```
@@ -141,7 +145,9 @@ Generates a library according to [NX notation](https://nx.dev/concepts/more-conc
 ```sh
 npx nx g react-lib --app=mobile --scope=account --type=features --name=profile-settings --withComponent --withComponentForwardRef --dryRun
 ```
+
 or
+
 ```sh
 npx nx g react-lib --dryRun
 ```
@@ -235,7 +241,9 @@ Creates a React component in particular library.
 ```sh
 npx nx g react-component --name=AppButton --subcomponent --withForwardRef
 ```
+
 or
+
 ```sh
 npx nx g react-component AppButton --subcomponent --withForwardRef
 ```
@@ -256,7 +264,9 @@ Generates a form schema class and adds its usage to a component or a hook.
 ```sh
 npx nx g form --name=profile-settings --placeOfUse=ProfileSettings
 ```
+
 or
+
 ```sh
 npx nx g form profile-settings ProfileSettings
 ```
@@ -286,4 +296,3 @@ Each generator accepts the `--help` argument to see generator instructions.
 ```sh
 npx nx g react-lib --help
 ```
-

package/jest.config.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+export default {
+  displayName: '@ronas-it/nx-generators',
+  preset: '../jest.preset.js',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../coverage/plugin',
+};

package/package.json

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

package/project.json

@@ -0,0 +1,61 @@
+{
+  "name": "@ronas-it/nx-generators",
+  "$schema": "../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "plugin/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/plugin",
+        "main": "plugin/src/index.ts",
+        "tsConfig": "plugin/tsconfig.lib.json",
+        "assets": [
+          "plugin/*.md",
+          {
+            "input": "./plugin/src",
+            "glob": "**/!(*.ts)",
+            "output": "./src"
+          },
+          {
+            "input": "./plugin/src",
+            "glob": "**/*.d.ts",
+            "output": "./src"
+          },
+          {
+            "input": "./plugin",
+            "glob": "generators.json",
+            "output": "."
+          },
+          {
+            "input": "./plugin",
+            "glob": "executors.json",
+            "output": "."
+          }
+        ]
+      }
+    },
+    "nx-release-publish": {
+      "options": {
+        "packageRoot": "dist/{projectRoot}"
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "plugin/jest.config.ts"
+      }
+    }
+  },
+  "tags": ["nx", "generator", "monorepo", "expo", "react-native", "typescript"],
+  "release": {
+    "version": {
+      "generatorOptions": {
+        "packageRoot": "dist/{projectRoot}",
+        "currentVersionResolver": "git-tag"
+      }
+    }
+  }
+}

package/src/generators/code-checks/config.ts

@@ -0,0 +1,17 @@
+export default {
+  'lint-staged': {
+    '*.{ts,tsx}': 'tsc-files --noEmit types.d.ts',
+    '*.{ts,tsx,js,html,json,md}': 'prettier --write',
+    '*.{ts,tsx,js}': 'eslint --cache --fix',
+  },
+  tsconfig: {
+    jsx: 'react-native',
+    allowJs: true,
+    noEmit: true,
+    strict: true,
+    allowSyntheticDefaultImports: true,
+    noImplicitAny: true,
+    strictPropertyInitialization: false,
+    strictNullChecks: true,
+  },
+};

package/src/generators/code-checks/files/.eslintrc.json.template

@@ -2,5 +2,177 @@
   "root": true,
   "plugins": ["@nx"],
   "extends": ["./.eslint.ronasit.json"],
-  "overrides": []
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {
+        "@stylistic/array-bracket-newline": "off",
+        "@stylistic/array-bracket-spacing": "off",
+        "@stylistic/array-element-newline": "off",
+        "@stylistic/arrow-parens": "off",
+        "@stylistic/arrow-spacing": "off",
+        "@stylistic/block-spacing": "off",
+        "@stylistic/brace-style": "off",
+        "@stylistic/comma-dangle": "off",
+        "@stylistic/comma-spacing": "off",
+        "@stylistic/comma-style": "off",
+        "@stylistic/computed-property-spacing": "off",
+        "@stylistic/dot-location": "off",
+        "@stylistic/eol-last": "off",
+        "@stylistic/func-call-spacing": "off",
+        "@stylistic/function-call-argument-newline": "off",
+        "@stylistic/function-call-spacing": "off",
+        "@stylistic/function-paren-newline": "off",
+        "@stylistic/generator-star-spacing": "off",
+        "@stylistic/implicit-arrow-linebreak": "off",
+        "@stylistic/indent": "off",
+        "@stylistic/jsx-quotes": "off",
+        "@stylistic/key-spacing": "off",
+        "@stylistic/keyword-spacing": "off",
+        "@stylistic/linebreak-style": "off",
+        "@stylistic/max-statements-per-line": "off",
+        "@stylistic/multiline-ternary": "off",
+        "@stylistic/new-parens": "off",
+        "@stylistic/newline-per-chained-call": "off",
+        "@stylistic/no-extra-parens": "off",
+        "@stylistic/no-extra-semi": "off",
+        "@stylistic/no-floating-decimal": "off",
+        "@stylistic/no-mixed-spaces-and-tabs": "off",
+        "@stylistic/no-multi-spaces": "off",
+        "@stylistic/no-multiple-empty-lines": "off",
+        "@stylistic/no-trailing-spaces": "off",
+        "@stylistic/no-whitespace-before-property": "off",
+        "@stylistic/nonblock-statement-body-position": "off",
+        "@stylistic/object-curly-newline": "off",
+        "@stylistic/object-curly-spacing": "off",
+        "@stylistic/object-property-newline": "off",
+        "@stylistic/one-var-declaration-per-line": "off",
+        "@stylistic/operator-linebreak": "off",
+        "@stylistic/padded-blocks": "off",
+        "@stylistic/quote-props": "off",
+        "@stylistic/rest-spread-spacing": "off",
+        "@stylistic/semi": "off",
+        "@stylistic/semi-spacing": "off",
+        "@stylistic/semi-style": "off",
+        "@stylistic/space-before-blocks": "off",
+        "@stylistic/space-before-function-paren": "off",
+        "@stylistic/space-in-parens": "off",
+        "@stylistic/space-infix-ops": "off",
+        "@stylistic/space-unary-ops": "off",
+        "@stylistic/switch-colon-spacing": "off",
+        "@stylistic/template-curly-spacing": "off",
+        "@stylistic/template-tag-spacing": "off",
+        "@stylistic/wrap-iife": "off",
+        "@stylistic/wrap-regex": "off",
+        "@stylistic/yield-star-spacing": "off",
+        "@stylistic/member-delimiter-style": "off",
+        "@stylistic/type-annotation-spacing": "off",
+        "@stylistic/jsx-child-element-spacing": "off",
+        "@stylistic/jsx-closing-bracket-location": "off",
+        "@stylistic/jsx-closing-tag-location": "off",
+        "@stylistic/jsx-curly-newline": "off",
+        "@stylistic/jsx-curly-spacing": "off",
+        "@stylistic/jsx-equals-spacing": "off",
+        "@stylistic/jsx-first-prop-new-line": "off",
+        "@stylistic/jsx-indent": "off",
+        "@stylistic/jsx-indent-props": "off",
+        "@stylistic/jsx-max-props-per-line": "off",
+        "@stylistic/jsx-newline": "off",
+        "@stylistic/jsx-one-expression-per-line": "off",
+        "@stylistic/jsx-props-no-multi-spaces": "off",
+        "@stylistic/jsx-tag-spacing": "off",
+        "@stylistic/jsx-wrap-multilines": "off",
+        "@stylistic/indent-binary-ops": "off",
+        "@stylistic/type-generic-spacing": "off",
+        "@stylistic/type-named-tuple-spacing": "off",
+        "@stylistic/js/array-bracket-newline": "off",
+        "@stylistic/js/array-bracket-spacing": "off",
+        "@stylistic/js/array-element-newline": "off",
+        "@stylistic/js/arrow-parens": "off",
+        "@stylistic/js/arrow-spacing": "off",
+        "@stylistic/js/block-spacing": "off",
+        "@stylistic/js/brace-style": "off",
+        "@stylistic/js/comma-dangle": "off",
+        "@stylistic/js/comma-spacing": "off",
+        "@stylistic/js/comma-style": "off",
+        "@stylistic/js/computed-property-spacing": "off",
+        "@stylistic/js/dot-location": "off",
+        "@stylistic/js/eol-last": "off",
+        "@stylistic/js/func-call-spacing": "off",
+        "@stylistic/js/function-call-argument-newline": "off",
+        "@stylistic/js/function-call-spacing": "off",
+        "@stylistic/js/function-paren-newline": "off",
+        "@stylistic/js/generator-star-spacing": "off",
+        "@stylistic/js/implicit-arrow-linebreak": "off",
+        "@stylistic/js/indent": "off",
+        "@stylistic/js/jsx-quotes": "off",
+        "@stylistic/js/key-spacing": "off",
+        "@stylistic/js/keyword-spacing": "off",
+        "@stylistic/js/linebreak-style": "off",
+        "@stylistic/js/max-statements-per-line": "off",
+        "@stylistic/js/multiline-ternary": "off",
+        "@stylistic/js/new-parens": "off",
+        "@stylistic/js/newline-per-chained-call": "off",
+        "@stylistic/js/no-extra-parens": "off",
+        "@stylistic/js/no-extra-semi": "off",
+        "@stylistic/js/no-floating-decimal": "off",
+        "@stylistic/js/no-mixed-spaces-and-tabs": "off",
+        "@stylistic/js/no-multi-spaces": "off",
+        "@stylistic/js/no-multiple-empty-lines": "off",
+        "@stylistic/js/no-trailing-spaces": "off",
+        "@stylistic/js/no-whitespace-before-property": "off",
+        "@stylistic/js/nonblock-statement-body-position": "off",
+        "@stylistic/js/object-curly-newline": "off",
+        "@stylistic/js/object-curly-spacing": "off",
+        "@stylistic/js/object-property-newline": "off",
+        "@stylistic/js/one-var-declaration-per-line": "off",
+        "@stylistic/js/operator-linebreak": "off",
+        "@stylistic/js/padded-blocks": "off",
+        "@stylistic/js/quote-props": "off",
+        "@stylistic/js/rest-spread-spacing": "off",
+        "@stylistic/js/semi": "off",
+        "@stylistic/js/semi-spacing": "off",
+        "@stylistic/js/semi-style": "off",
+        "@stylistic/js/space-before-blocks": "off",
+        "@stylistic/js/space-before-function-paren": "off",
+        "@stylistic/js/space-in-parens": "off",
+        "@stylistic/js/space-infix-ops": "off",
+        "@stylistic/js/space-unary-ops": "off",
+        "@stylistic/js/switch-colon-spacing": "off",
+        "@stylistic/js/template-curly-spacing": "off",
+        "@stylistic/js/template-tag-spacing": "off",
+        "@stylistic/js/wrap-iife": "off",
+        "@stylistic/js/wrap-regex": "off",
+        "@stylistic/js/yield-star-spacing": "off",
+        "@stylistic/ts/block-spacing": "off",
+        "@stylistic/ts/brace-style": "off",
+        "@stylistic/ts/comma-dangle": "off",
+        "@stylistic/ts/comma-spacing": "off",
+        "@stylistic/ts/func-call-spacing": "off",
+        "@stylistic/ts/function-call-spacing": "off",
+        "@stylistic/ts/indent": "off",
+        "@stylistic/ts/key-spacing": "off",
+        "@stylistic/ts/keyword-spacing": "off",
+        "@stylistic/ts/member-delimiter-style": "off",
+        "@stylistic/ts/no-extra-parens": "off",
+        "@stylistic/ts/no-extra-semi": "off",
+        "@stylistic/ts/object-curly-spacing": "off",
+        "@stylistic/ts/semi": "off",
+        "@stylistic/ts/space-before-blocks": "off",
+        "@stylistic/ts/space-before-function-paren": "off",
+        "@stylistic/ts/space-infix-ops": "off",
+        "@stylistic/ts/type-annotation-spacing": "off",
+        "@stylistic/jsx/jsx-child-element-spacing": "off",
+        "@stylistic/jsx/jsx-closing-bracket-location": "off",
+        "@stylistic/jsx/jsx-closing-tag-location": "off",
+        "@stylistic/jsx/jsx-curly-newline": "off",
+        "@stylistic/jsx/jsx-curly-spacing": "off",
+        "@stylistic/jsx/jsx-equals-spacing": "off",
+        "@stylistic/jsx/jsx-first-prop-new-line": "off",
+        "@stylistic/jsx/jsx-indent": "off",
+        "@stylistic/jsx/jsx-indent-props": "off",
+        "@stylistic/jsx/jsx-max-props-per-line": "off"
+      }
+    }
+  ]
 }

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

@@ -0,0 +1,68 @@
+import { execSync } from 'child_process';
+import * as path from 'path';
+import {
+  addDependenciesToPackageJson,
+  formatFiles,
+  generateFiles,
+  installPackagesTask,
+  readJson,
+  Tree,
+  writeJson,
+} from '@nx/devkit';
+import { devDependencies } from '../../shared/dependencies';
+import config from './config';
+import { CodeChecksGeneratorSchema } from './schema';
+import scripts from './scripts';
+
+export async function codeChecksGenerator(tree: Tree, options: CodeChecksGeneratorSchema) {
+  const projectRoot = '.';
+
+  // Delete files
+  tree.delete('.eslintrc.json');
+  tree.delete('eslint.config.cjs');
+  tree.delete('.prettierrc');
+
+  // Configure pre-commit hook
+  execSync('npx mrm@2 lint-staged', { stdio: 'inherit' });
+
+  const packageJson = readJson(tree, 'package.json');
+  packageJson['lint-staged'] = config['lint-staged'];
+  packageJson.scripts = { ...scripts, ...packageJson.scripts };
+  writeJson(tree, 'package.json', packageJson);
+
+  // Update tsconfig.base.json
+  const tsconfigJson = readJson(tree, 'tsconfig.base.json');
+  tsconfigJson.compilerOptions = { ...config.tsconfig, ...tsconfigJson.compilerOptions };
+  writeJson(tree, 'tsconfig.base.json', tsconfigJson);
+
+  // Update .gitignore
+  const gitignoreContent = tree.read('.gitignore')?.toString() + '\n.eslintcache\n';
+  tree.write('.gitignore', gitignoreContent);
+
+  // Update .eslintignore
+  const eslintignoreContent = tree.read('.eslintignore')?.toString() + '\n**/*.js\napps/*/app.config.ts\n';
+  tree.write('.eslintignore', eslintignoreContent);
+
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const configTemplate = require('../../shared/templates/config-template.json');
+
+  // Add files
+  generateFiles(tree, path.join(__dirname, 'files'), projectRoot, options);
+
+  // Add rules to .eslintrc.json
+  const esLintConfig = readJson(tree, '.eslintrc.json');
+
+  esLintConfig.overrides.push(configTemplate);
+  writeJson(tree, '.eslintrc.json', esLintConfig);
+
+  // Install necessary dependencies
+  addDependenciesToPackageJson(tree, {}, devDependencies['code-checks']);
+
+  await formatFiles(tree);
+
+  return (): void => {
+    installPackagesTask(tree);
+  };
+}
+
+export default codeChecksGenerator;

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

@@ -0,0 +1,5 @@
+export default {
+  lint: 'npx tsc && cross-env ESLINT_USE_FLAT_CONFIG=false npx eslint ./',
+  format: 'npx prettier --write . && npm run lint -- --fix',
+  prepare: 'husky',
+};

package/src/generators/entity-api/generator.ts

@@ -0,0 +1,127 @@
+import * as path from 'path';
+import { formatFiles, generateFiles, Tree } from '@nx/devkit';
+import { camelCase, kebabCase, startCase } from 'lodash';
+import { IndentationText, Project, QuoteKind, StructureKind, SyntaxKind } from 'ts-morph';
+import {
+  addNamedImport,
+  appendFileContent,
+  askQuestion,
+  createCliReadline,
+  dynamicImport,
+  filterSource,
+  getNxLibsPaths,
+  LibraryType,
+  searchAliasPath,
+  searchNxLibsPaths,
+} from '../../shared/utils';
+import { EntityApiGeneratorSchema } from './schema';
+
+export async function entityApiGenerator(tree: Tree, options: EntityApiGeneratorSchema): Promise<void> {
+  const { default: autocomplete } = await dynamicImport<typeof import('inquirer-autocomplete-standalone')>(
+    'inquirer-autocomplete-standalone',
+  );
+  const nxLibsPaths = getNxLibsPaths([LibraryType.DATA_ACCESS]);
+  const apiLibsPaths = searchNxLibsPaths(nxLibsPaths, 'data-access/api/src', 'endsWith');
+  const apiClientLibsPaths = searchNxLibsPaths(nxLibsPaths, 'data-access/api-client/src', 'endsWith');
+
+  if (!apiClientLibsPaths.length) {
+    throw new Error('Could not find API Client path.');
+  }
+
+  if (!apiLibsPaths.length) {
+    throw new Error('Could not find API path.');
+  }
+
+  if (apiClientLibsPaths.length > 1) {
+    apiClientLibsPaths[0] = await autocomplete({
+      message: 'Select the api client library path:',
+      source: (input) => filterSource(input as string, apiClientLibsPaths),
+    });
+  }
+
+  if (apiLibsPaths.length > 1) {
+    apiLibsPaths[0] = await autocomplete({
+      message: 'Select the api library path:',
+      source: (input) => filterSource(input as string, apiLibsPaths),
+    });
+  }
+
+  const apiDirectory = searchAliasPath(apiLibsPaths[0]) as string;
+  const apiClientDirectory = searchAliasPath(apiClientLibsPaths[0]);
+
+  const libPath = apiLibsPaths[0];
+  const libRootPath = `${libPath}/lib`;
+
+  const cliReadline = createCliReadline();
+  options.name =
+    options.name || (await askQuestion('Enter the name of the entity (e.g: User): ', undefined, cliReadline));
+
+  const apiName = kebabCase(options.name);
+
+  options.baseEndpoint =
+    options.baseEndpoint || (await askQuestion('Enter the base endpoint (e.g: /users): ', `/${apiName}`, cliReadline));
+  cliReadline.close();
+
+  const apiPath = `${libRootPath}/${apiName}`;
+  const entityName = startCase(camelCase(apiName)).replace(/\s+/g, '');
+
+  generateFiles(tree, path.join(__dirname, `files`), apiPath, {
+    ...options,
+    apiName: camelCase(options.name),
+    entityName,
+    entityFileName: apiName,
+    apiClientDirectory,
+    baseEndpoint: options.baseEndpoint.startsWith('/') ? options.baseEndpoint : `/${options.baseEndpoint}`,
+  });
+
+  tree.rename(`${apiPath}/models/entity.ts`, `${apiPath}/models/${apiName}.ts`);
+
+  appendFileContent(`${libRootPath}/index.ts`, `export * from './${apiName}';\n`, tree);
+
+  const storeLibsPaths = searchNxLibsPaths(nxLibsPaths, 'data-access/store/src', 'endsWith');
+
+  if (!storeLibsPaths.length) {
+    await formatFiles(tree);
+
+    throw new Error('Could not find redux store path.');
+  }
+
+  if (storeLibsPaths.length > 1) {
+    storeLibsPaths[0] = await autocomplete({
+      message: 'Select the store library path:',
+      source: (input) => filterSource(input as string, storeLibsPaths),
+    });
+  }
+
+  // Update redux store
+  const apiNameDeclaration = camelCase(options.name + 'Api');
+  const project = new Project({
+    manipulationSettings: {
+      indentationText: IndentationText.TwoSpaces,
+      quoteKind: QuoteKind.Single,
+    },
+  });
+  const store = project.addSourceFileAtPath(`${storeLibsPaths[0]}/store.ts`);
+
+  addNamedImport(apiNameDeclaration, apiDirectory, store);
+
+  const rootReducer = store.getVariableDeclarationOrThrow('rootReducer');
+
+  rootReducer.getInitializerIfKindOrThrow(SyntaxKind.ObjectLiteralExpression).addProperty({
+    name: `[${apiNameDeclaration}.reducerPath]`,
+    initializer: `${apiNameDeclaration}.reducer`,
+    kind: StructureKind.PropertyAssignment,
+  });
+
+  const middlewares = store.getVariableDeclarationOrThrow('middlewares');
+
+  middlewares
+    .getInitializerIfKindOrThrow(SyntaxKind.ArrayLiteralExpression)
+    .addElement(`${apiNameDeclaration}.middleware`);
+
+  project.saveSync();
+
+  await formatFiles(tree);
+}
+
+export default entityApiGenerator;