@ronas-it/nx-generators 0.10.3 → 0.10.5

package/src/generators/lib-tags/interfaces/context.ts

@@ -1,9 +0,0 @@
-import { Tree } from '@nx/devkit';
-import { Constraint } from '../../../shared/utils';
-
-export interface LibTagsContext {
-  config: Record<string, any>;
-  rules: Array<Constraint>;
-  log: (message: any, ...optionalParams: Array<any>) => void;
-  reload: (tree: Tree) => void;
-}

package/src/generators/lib-tags/utils/check-lib-tags.ts

@@ -1,143 +0,0 @@
-import { ProjectConfiguration, Tree, readProjectConfiguration, updateProjectConfiguration } from '@nx/devkit';
-import { addNxAppTag, addNxScopeTag, constants } from '../../../shared/utils';
-import { LibTagsContext, VerifyTagConfig } from '../interfaces';
-import { TagType } from '../types';
-
-const getTagFromLibPath = (libPath: string, type: TagType): string => {
-  const projectAppTag = libPath.split('/')[1];
-
-  switch (type) {
-    case 'app':
-      return projectAppTag;
-    case 'scope':
-      return projectAppTag === constants.sharedValue ? constants.sharedValue : libPath.split('/')[2];
-    case 'type':
-      return projectAppTag === constants.sharedValue ? libPath.split('/')[2] : libPath.split('/')[3];
-  }
-};
-
-const verifyLibraryTag = ({
-  project,
-  tree,
-  tag,
-  tagType,
-  context,
-  ruleNotFoundCallback
-}: VerifyTagConfig): void => {
-  const defaultRuleNotFoundCallback = (): void => {
-    throw new Error(`Missing ${tagType} tag rule for ${tag}. Please add it to the ESLint config file.`);
-  };
-
-  if (tag) {
-    const tagRule = context.rules.find((rule) => rule.sourceTag === tag);
-
-    if (!tagRule) {
-      const callback = ruleNotFoundCallback || defaultRuleNotFoundCallback;
-
-      callback();
-    }
-
-    const tagFromLibPath = getTagFromLibPath(project.root, tagType);
-    const isInvalidTag = tag !== `${tagType}:${tagFromLibPath}`;
-
-    if (isInvalidTag) {
-      context.log(`Invalid tag ${tag}. Updating...\n`);
-
-      project = readProjectConfiguration(tree, project.name as string);
-
-      const filteredTags = project.tags?.filter((item) => item !== tag) || [];
-
-      project.tags = [...filteredTags, `${tagType}:${tagFromLibPath}`];
-
-      updateProjectConfiguration(tree, project.name as string, project);
-
-      if (tagType === 'scope') {
-        addNxScopeTag(tree,  tagFromLibPath);
-        context.reload(tree);
-      }
-
-      verifyLibraryTag({
-        project,
-        tree,
-        tag:`${tagType}:${tagFromLibPath}`,
-        tagType,
-        context
-      });
-    }
-  } else {
-    context.log(`Missing ${tagType} tag for ${project.name}. Adding...`);
-
-    project = readProjectConfiguration(tree, project.name as string);
-
-    const tag = getTagFromLibPath(project.root, tagType);
-
-    if (tagType === 'type') {
-      const typeTagRule = context.rules.find((rule) => rule.sourceTag === `type:${tag}`);
-
-      if (!typeTagRule) {
-        throw new Error(`Missing type tag rule for ${tag}. Please add it to the ESLint config file.`);
-      }
-    }
-
-    updateProjectConfiguration(tree, project.name as string, { ...project, tags: [...(project.tags || []), `${tagType}:${tag}`] });
-
-    if (tagType === 'scope') {
-      addNxScopeTag(tree,  tag);
-      context.reload(tree);
-    }
-  }
-};
-
-export const checkApplicationTags = (project: ProjectConfiguration, tree: Tree, context: LibTagsContext): void => {
-  const { tags } = project;
-  const appTag = tags?.find((tag) => tag.startsWith('app:'));
-  const hasTypeTag = tags?.includes('type:app');
-
-  if (appTag) {
-    const appTagRule = context.rules.find((rule) => rule.sourceTag === appTag);
-
-    if (!appTagRule) {
-      context.log(`Missing app tag rule for ${appTag}. Adding...\n`);
-      addNxAppTag(tree, appTag.replace('app:', ''));
-      context.reload(tree);
-    }
-  } else {
-    context.log(`Missing app tag for ${project.name}. Adding...`);
-
-    const projectAppTag = project.root.split('/').pop() as string;
-
-    updateProjectConfiguration(tree, project.name as string, { ...project, tags: [...(project.tags || []), `app:${projectAppTag}`] });
-    addNxAppTag(tree,  projectAppTag);
-    context.reload(tree);
-  }
-
-  if (!hasTypeTag) {
-    context.log(`Missing type tag for ${project.name}. Adding...`);
-
-    project = readProjectConfiguration(tree, project.name as string);
-
-    updateProjectConfiguration(tree, project.name as string, { ...project, tags: [...(project.tags || []), 'type:app'] });
-  }
-};
-
-export const checkLibraryTags = (project: ProjectConfiguration, tree: Tree, context: LibTagsContext): void => {
-  const { tags } = project;
-  const appTag = tags?.find((tag) => tag.startsWith('app:'));
-  const scopeTag = tags?.find((tag) => tag.startsWith('scope:'));
-  const typeTag = tags?.find((tag) => tag.startsWith('type:'));
-
-  verifyLibraryTag({ project, tree, tag: appTag, tagType: 'app', context });
-  verifyLibraryTag({
-    project,
-    tree,
-    tag: scopeTag,
-    tagType:'scope',
-    context,
-    ruleNotFoundCallback:() => {
-      context.log(`Missing scope tag rule for ${scopeTag}. Adding...`);
-      addNxScopeTag(tree, scopeTag?.replace('scope:', '') as string);
-      context.reload(tree);
-    }
-  });
-  verifyLibraryTag({ project, tree, tag: typeTag, tagType: 'type', context });
-};

package/src/generators/next-app/generator.ts

@@ -1,99 +0,0 @@
-import { execSync } from 'child_process';
-import {
-  addDependenciesToPackageJson,
-  formatFiles,
-  generateFiles,
-  installPackagesTask,
-  readJson,
-  Tree,
-  writeJson,
-} from '@nx/devkit';
-import { NextAppGeneratorSchema } from './schema';
-import { existsSync } from 'fs';
-import { dependencies } from '../../shared/dependencies';
-import { BaseGeneratorType } from '../../shared/enums';
-import { runApiClientGenerator, runAppEnvGenerator, runFormUtilsGenerator, runStoreGenerator } from '../../shared/generators';
-import { addNxAppTag, askQuestion, formatName } from '../../shared/utils';
-import * as path from 'path';
-
-export async function nextAppGenerator(
-  tree: Tree,
-  options: NextAppGeneratorSchema,
-) {
-  const shouldGenerateStoreLib = await askQuestion('Do you want to create store lib? (y/n): ') === 'y';
-  const shouldGenerateApiClientLib = shouldGenerateStoreLib && await askQuestion('Do you want to create api client lib? (y/n): ') === 'y';
-  const shouldGenerateFormUtilsLib = await askQuestion('Do you want to create a lib with the form utils? (y/n): ') === 'y';
-
-  const appRoot = `apps/${options.directory}`;
-  const tags = [`app:${options.directory}`, 'type:app'];
-
-  // Install @nx/next plugin
-  execSync('npx nx add @nx/next', { stdio: 'inherit' });
-
-  if (!existsSync(appRoot)) {
-    execSync(
-      `npx nx g @nx/next:app ${options.name} --directory=apps/${options.directory} --tags="${tags.join(', ')}" --linter=eslint --appDir=true --style=scss --src=false --unitTestRunner=none --e2eTestRunner=none`,
-      { stdio: 'inherit' },
-    );
-  }
-
-  // Install @nx/expo to generate libs
-  const packageJson = readJson(tree, 'package.json');
-  const hasNxExpo = !!packageJson.devDependencies['@nx/expo'];
-  if (!hasNxExpo) {
-    execSync('npx nx add @nx/expo', { stdio: 'inherit' });
-  }
-
-  await runAppEnvGenerator(tree, { ...options, baseGeneratorType: BaseGeneratorType.NEXT_APP });
-
-  if (shouldGenerateStoreLib) {
-    await runStoreGenerator(tree, { ...options, baseGeneratorType: BaseGeneratorType.NEXT_APP });
-  }
-
-  if (shouldGenerateApiClientLib) {
-    await runApiClientGenerator(tree, options);
-  }
-
-  if (shouldGenerateFormUtilsLib) {
-    await runFormUtilsGenerator(tree, options);
-  }
-
-  // Remove unnecessary files and files that will be replaced
-  tree.delete(`${appRoot}/public/.gitkeep`);
-  tree.delete(`${appRoot}/app/api`);
-  tree.delete(`${appRoot}/app/page.tsx`);
-  tree.delete(`${appRoot}/app/page.module.scss`);
-  tree.delete(`${appRoot}/app/global.css`);
-  tree.delete(`${appRoot}/app/layout.tsx`);
-  tree.delete(`${appRoot}/specs`);
-  tree.delete(`${appRoot}/.eslintrc.json`);
-
-  // Update app tsconfig.json to skip automatic reconfiguration during the first application run
-  const appTsconfigPath = `${appRoot}/tsconfig.json`;
-  const appTsconfigJson = readJson(tree, appTsconfigPath);
-  const nextTypesInclude = '.next/types/**/*.ts';
-
-  if (!appTsconfigJson.include.includes(nextTypesInclude)) {
-    appTsconfigJson.include.push(nextTypesInclude);
-    writeJson(tree, appTsconfigPath, appTsconfigJson);
-  }
-
-  // Add app files
-  generateFiles(tree, path.join(__dirname, 'files'), appRoot, {
-    ...options,
-    formatName,
-  });
-
-  addNxAppTag(tree, options.directory);
-
-  // Add dependencies
-  addDependenciesToPackageJson(tree, dependencies['next-app'], {});
-
-  await formatFiles(tree);
-
-  return () => {
-    installPackagesTask(tree);
-  };
-}
-
-export default nextAppGenerator;

package/src/generators/react-component/generator.ts

@@ -1,80 +0,0 @@
-import { existsSync } from 'fs';
-import * as path from 'path';
-import { formatFiles, generateFiles, Tree } from '@nx/devkit';
-import { kebabCase } from 'lodash';
-import {
-  appendFileContent,
-  askQuestion,
-  createCliReadline,
-  dynamicImport,
-  formatName,
-  getNxLibsPaths,
-  LibraryType,
-  searchNxLibsPaths
-} from '../../shared/utils';
-import { ReactComponentGeneratorSchema } from './schema';
-
-export async function reactComponentGenerator(tree: Tree, options: ReactComponentGeneratorSchema) {
-  const { default: autocomplete } = await dynamicImport<typeof import('inquirer-autocomplete-standalone')>(
-    'inquirer-autocomplete-standalone',
-  );
-
-  const nxLibsPaths = getNxLibsPaths([LibraryType.FEATURES, LibraryType.UI]);
-
-  const libPath = await autocomplete({
-    message: 'Enter the library path:',
-    source: async (input) => {
-      const filteredNxLibsPaths = searchNxLibsPaths(nxLibsPaths, input as string);
-
-      return filteredNxLibsPaths.map((path) => ({ value: path }));
-    }
-  });
-
-  const cliReadline = createCliReadline();
-  options.name =
-    options.name || (await askQuestion('Enter the name of the component (e.g: AppButton): ', undefined, cliReadline));
-  options.subcomponent =
-    options.subcomponent ||
-    (await askQuestion('Generate component inside components folder? (y/n): ', undefined, cliReadline)) === 'y';
-  options.withForwardRef =
-    options.withForwardRef ||
-    (await askQuestion('Generate component with forwardRef? (y/n): ', undefined, cliReadline)) === 'y';
-  cliReadline.close();
-
-  const libRootPath = `${libPath}/lib`;
-  const componentsPath = `${libRootPath}/components`;
-  const componentPath = options.subcomponent ? `${libRootPath}/components/${kebabCase(options.name)}` : libRootPath;
-  const shouldUpdateSrcIndex = !existsSync(libRootPath);
-  const shouldUpdateLibIndex = !existsSync(componentsPath) && options.subcomponent;
-
-  generateFiles(tree, path.join(__dirname, `files`), componentPath, {
-    ...options,
-    name: formatName(options.name, true)
-  });
-
-  const updateIndexes = (): void => {
-    const componentsIndexFilePath = `${libRootPath}/components/index.ts`;
-
-    if (shouldUpdateSrcIndex) {
-      appendFileContent(`${libPath}/index.ts`, `export * from './lib';\n`, tree);
-    }
-
-    if (shouldUpdateLibIndex) {
-      appendFileContent(`${libRootPath}/index.ts`, `export * from './components';\n`, tree);
-    }
-
-    if (!existsSync(componentsIndexFilePath)) {
-      tree.write(componentsIndexFilePath, `export * from './${kebabCase(options.name)}';\n`);
-    } else {
-      appendFileContent(componentsIndexFilePath, `export * from './${kebabCase(options.name)}';\n`, tree);
-    }
-  };
-
-  if (options.subcomponent) {
-    updateIndexes();
-  }
-
-  await formatFiles(tree);
-}
-
-export default reactComponentGenerator;

package/src/generators/react-lib/generator.ts

@@ -1,86 +0,0 @@
-import { execSync } from 'child_process';
-import * as path from 'path';
-import { formatFiles, generateFiles, output, Tree } from '@nx/devkit';
-import { isBoolean } from 'lodash';
-import {
-  addNxScopeTag,
-  askQuestion,
-  constants,
-  dynamicImport,
-  filterSource,
-  formatName,
-  LibraryType,
-  selectProject,
-  validateLibraryType,
-  getLibDirectoryName,
-  createCliReadline
-} from '../../shared/utils';
-import { ReactLibGeneratorSchema } from './schema';
-
-export async function reactLibGenerator(tree: Tree, options: ReactLibGeneratorSchema) {
-  const { default: autocomplete } = await dynamicImport<typeof import('inquirer-autocomplete-standalone')>(
-    'inquirer-autocomplete-standalone',
-  );
-
-  options.app = options.app || (await selectProject(tree, 'application', 'Select the application: ')).name;
-
-  const isSharedLib = options.app === constants.sharedValue;
-
-  options.scope =
-    options.scope ||
-    (isSharedLib ? '' : await askQuestion(`Enter the scope (e.g: profile) or '${constants.sharedValue}': `));
-  options.type = options.type
-    ? validateLibraryType(options.type)
-    : await autocomplete({
-      message: 'Select the library type: ',
-      source: (input) => filterSource(input as string, Object.values(LibraryType))
-    });
-
-  const cliReadline = createCliReadline();
-  options.name =
-    options.name || (await askQuestion('Enter the name of the library (e.g: settings): ', undefined, cliReadline));
-
-  if (
-    [LibraryType.FEATURES, LibraryType.UI].includes(options.type as LibraryType) &&
-    !isBoolean(options.withComponent)
-  ) {
-    options.withComponent =
-      (await askQuestion('Generate component inside lib folder? (y/n): ', undefined, cliReadline)) === 'y';
-
-    if (options.withComponent && !isBoolean(options.withComponentForwardRef)) {
-      options.withComponentForwardRef =
-        (await askQuestion('Generate component with forwardRef? (y/n): ', undefined, cliReadline)) === 'y';
-    }
-  }
-  cliReadline.close();
-
-  const scopeTag = options.scope || constants.sharedValue;
-  const tags = [`app:${options.app}`, `scope:${scopeTag}`, `type:${options.type}`];
-
-  const libDirectoryName = getLibDirectoryName(options.name, options.scope);
-  const libName = path.normalize(`${options.app}/${options.scope}/${options.type}/${libDirectoryName}`);
-  const libPath = `libs/${libName}`;
-  const command = `npx nx g @nx/expo:lib --skipPackageJson --unitTestRunner=none --tags="${tags.join(', ')}" --name=${libName} ${libPath} --linter=eslint`;
-  const commandWithOptions = options.dryRun ? command + ' --dry-run' : command;
-
-  execSync(commandWithOptions, { stdio: 'inherit' });
-
-  if (options.withComponent) {
-    const srcPath = `${libPath}/src`;
-
-    generateFiles(tree, path.join(__dirname, 'files'), srcPath, { ...options, name: formatName(options.name, true) });
-    tree.write(`${srcPath}/index.ts`, 'export * from \'./lib\';');
-  }
-
-  addNxScopeTag(tree, scopeTag);
-
-  await formatFiles(tree);
-
-  if (libDirectoryName !== options.name) {
-    output.warn({
-      title: `The library directory was changed to ${output.bold(libDirectoryName)} so that it does not start with the scope name.`
-    });
-  }
-}
-
-export default reactLibGenerator;

package/src/generators/repo-config/generator.ts

@@ -1,44 +0,0 @@
-import * as path from 'path';
-import {
-  addDependenciesToPackageJson,
-  formatFiles,
-  generateFiles,
-  installPackagesTask,
-  readJson,
-  Tree,
-  writeJson,
-} from '@nx/devkit';
-import { devDependencies } from '../../shared/dependencies';
-import scripts from './scripts';
-import { formatName, getProjectName } from '../../shared/utils';
-
-export async function repoConfigGenerator(tree: Tree) {
-  const projectRoot = '.';
-  const projectPackagePath = 'package.json';
-
-  // Remove unnecessary files and files that will be replaced
-  tree.delete('README.md');
-
-  // Update project package.json
-  const projectPackageJson = readJson(tree, projectPackagePath);
-  projectPackageJson.workspaces = ['apps/*'];
-  projectPackageJson.scripts = { ...scripts, ...projectPackageJson.scripts };
-  writeJson(tree, projectPackagePath, projectPackageJson);
-
-  // Add project files
-  generateFiles(tree, path.join(__dirname, 'files'), projectRoot, {
-    name: getProjectName(projectPackageJson.name),
-    formatName,
-  });
-
-  // Add dependencies
-  addDependenciesToPackageJson(tree, {}, devDependencies['repo-config']);
-
-  await formatFiles(tree);
-
-  return () => {
-    installPackagesTask(tree);
-  };
-}
-
-export default repoConfigGenerator;

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

@@ -1,3 +0,0 @@
-export default {
-  'deps:sync': 'npx syncpack fix-mismatches',
-};

package/src/shared/dependencies.ts

@@ -1,76 +0,0 @@
-export const dependencies = {
-  'expo-app': {
-    "@ronas-it/react-native-common-modules": "^0.6.0",
-    'expo-constants': '~17.0.3',
-    'expo-dev-client': '^5.0.6',
-    'expo-router': '~4.0.14',
-    'react-native-safe-area-context': '^4.10.5',
-    'react-native-screens': '~4.1.0',
-    'expo-linking': '~7.0.3',
-    'expo-status-bar': '^2.0.0',
-    'expo-updates': '^0.26.10',
-    'expo-insights': '~0.8.1',
-    "lodash-es": "^4.17.21"
-  },
-  'expo-app-root': {
-    // Need new version to fix this error:
-    // https://github.com/kristerkari/react-native-svg-transformer/issues/329
-    'react-native-svg-transformer': '^1.4.0'
-  },
-  'next-app': {
-    'next-intl': '^3.17.2',
-  },
-  'api-client': {
-    '@ronas-it/axios-api-client': '^0.1.0',
-  },
-  'auth': {
-    'luxon': '^3.4.4'
-  },
-  'rn-styles': {
-    'react-native-extended-stylesheet': '^0.12.0'
-  },
-  'store': {
-    '@ronas-it/rtkq-entity-api': '^0.3.1',
-    'react-redux': '^9.1.2'
-  },
-  'ui-kitten': {
-    '@eva-design/eva': '^2.2.0',
-    '@ui-kitten/components': '^5.3.1'
-  },
-  'form': {
-    '@hookform/resolvers': '^3.9.0',
-    'react-hook-form': '^7.53.0',
-    'yup': '^1.4.0'
-  }
-};
-
-export const devDependencies = {
-  'code-checks': {
-    'eslint': '^9.8.0',
-    'prettier': '^3.3.2',
-    'eslint-config-prettier': '^9.1.0',
-    'eslint-import-resolver-typescript': '^3.7.0',
-    'eslint-plugin-import': '^2.29.1',
-    'eslint-plugin-jsx-a11y': '^6.9.0',
-    'eslint-plugin-react': '^7.34.3',
-    'eslint-plugin-react-hooks': '^5.0.0',
-    'eslint-plugin-unused-imports': '^4.1.4',
-    'husky': '^9.1.5',
-    '@stylistic/eslint-plugin': '^2.12.1',
-    '@typescript-eslint/eslint-plugin': '^8.18.1',
-    '@typescript-eslint/parser': '^8.18.1',
-    'tsc-files': '^1.1.4',
-  },
-  'expo-app': {
-    '@types/lodash': '^4.14.194',
-  },
-  'expo-app-root': {
-    'cross-env': '^7.0.3'
-  },
-  'repo-config': {
-    'syncpack': '^12.3.2',
-  },
-  'auth': {
-    '@types/luxon': '3.4.2'
-  }
-};

package/src/shared/enums/base-generator-type.ts

@@ -1,4 +0,0 @@
-export enum BaseGeneratorType {
-  EXPO_APP = 'expo-app',
-  NEXT_APP = 'next-app'
-}

package/src/shared/generators/api-client/generator.ts

@@ -1,49 +0,0 @@
-import { execSync } from 'child_process';
-import { existsSync } from 'fs';
-import * as path from 'path';
-import {
-  addDependenciesToPackageJson,
-  formatFiles,
-  generateFiles,
-  Tree
-} from '@nx/devkit';
-import { dependencies } from '../../dependencies';
-import { formatName, formatAppIdentifier, getImportPathPrefix } from '../../utils';
-
-export async function runApiClientGenerator(
-  tree: Tree,
-  options: { name: string; directory: string }
-) {
-  const appRoot = `apps/${options.directory}`;
-  const libRoot = `libs/${options.directory}`;
-  const libPath = `${getImportPathPrefix(tree)}/${options.directory}`;
-
-  // Generate shared libs
-  execSync(`npx nx g react-lib --app=${options.directory} --scope=shared --type=data-access --name=api-client`, { stdio: 'inherit' });
-
-  const appPackagePath = `${appRoot}/package.json`;
-
-  // Remove unnecessary files and files that will be replaced
-  tree.delete(`${libRoot}/shared/data-access/api-client/src/index.ts`);
-
-  // Add lib files
-  generateFiles(tree, path.join(__dirname, '/lib-files'), libRoot, {
-    ...options,
-    formatName,
-    formatAppIdentifier,
-    formatDirectory: () => libPath
-  });
-
-  // Add dependencies
-  addDependenciesToPackageJson(tree, dependencies['api-client'], {});
-
-  if (existsSync(appPackagePath)) {
-    addDependenciesToPackageJson(tree, dependencies['api-client'], {}, appPackagePath);
-  }
-
-  await formatFiles(tree);
-
-  console.warn(`\nPlease set api endpoint in ${libPath}/shared/data-access/api-client/src/configuration.ts`);
-}
-
-export default runApiClientGenerator;

package/src/shared/generators/app-env/generator.ts

@@ -1,37 +0,0 @@
-import { execSync } from 'child_process';
-import * as path from 'path';
-import {
-  formatFiles,
-  generateFiles,
-  Tree
-} from '@nx/devkit';
-import { BaseGeneratorType } from '../../enums';
-import { formatName, formatAppIdentifier, getImportPathPrefix } from '../../utils';
-
-export async function runAppEnvGenerator(
-  tree: Tree,
-  options: { name: string; directory: string, baseGeneratorType: BaseGeneratorType }
-) {
-  const libRoot = `libs/${options.directory}`;
-  const appType = options.baseGeneratorType.split('-')[0].toUpperCase();
-  const libPath = `${getImportPathPrefix(tree)}/${options.directory}`;
-
-  // Generate shared libs
-  execSync(`npx nx g react-lib --app=${options.directory} --scope=shared --type=utils --name=app-env`, { stdio: 'inherit' });
-
-  // Remove unnecessary files and files that will be replaced
-  tree.delete(`${libRoot}/shared/utils/app-env/src/index.ts`);
-
-  // Add lib files
-  generateFiles(tree, path.join(__dirname, 'lib-files'), libRoot, {
-    ...options,
-    formatName,
-    formatAppIdentifier,
-    formatDirectory: () => libPath,
-    appType
-  });
-
-  await formatFiles(tree);
-}
-
-export default runAppEnvGenerator;