@ronas-it/nx-generators 0.10.4 → 0.10.6

package/src/generators/form/utils/add-form-usage.ts

@@ -1,99 +0,0 @@
-import {
-  ArrowFunction,
-  FunctionDeclaration,
-  FunctionExpression,
-  IndentationText,
-  Project,
-  QuoteKind,
-  SourceFile,
-  SyntaxKind,
-  VariableDeclaration,
-} from 'ts-morph';
-import { addNamedImport } from '../../../shared/utils';
-
-function getFormUsageCode(formClassName: string): string {
-  return `const formSchema = new ${formClassName}();
-const form = useForm({
-  defaultValues: formSchema.formValues,
-  resolver: yupResolver(${formClassName}.validationSchema)
-});\n\n`;
-}
-
-function getForwardRefFunction(variable: VariableDeclaration): FunctionExpression | ArrowFunction {
-  const callExpressionInitializer = variable.getInitializerIfKind(SyntaxKind.CallExpression);
-  const hasForwardRef = callExpressionInitializer?.getExpression().getText() === 'forwardRef';
-
-  if (!hasForwardRef) {
-    throw new Error('Could not find forwardRef');
-  }
-
-  const argument = callExpressionInitializer.getArguments()[0];
-  const hasComponentFunction =
-    argument && [SyntaxKind.FunctionExpression, SyntaxKind.ArrowFunction].includes(argument.getKind());
-
-  if (!hasComponentFunction) {
-    throw new Error('Could not find a component function in forwardRef');
-  }
-
-  const functionExpression = argument.asKind(
-    argument.getKind() === SyntaxKind.FunctionExpression ? SyntaxKind.FunctionExpression : SyntaxKind.ArrowFunction,
-  );
-
-  if (!functionExpression) {
-    throw new Error('Could not get a component function in forwardRef');
-  }
-
-  return functionExpression;
-}
-
-function getPlaceOfUse(
-  file: SourceFile,
-  placeOfUseName: string,
-): FunctionExpression | ArrowFunction | FunctionDeclaration {
-  const placeOfUseFunction = file.getFunction(placeOfUseName);
-
-  if (placeOfUseFunction) {
-    return placeOfUseFunction;
-  }
-
-  const variable = file.getVariableDeclaration(placeOfUseName);
-
-  if (!variable) {
-    throw new Error(`Could not find the place where the form should be used (${placeOfUseName}).`);
-  }
-
-  return (
-    variable.getInitializerIfKind(SyntaxKind.FunctionExpression) ||
-    variable.getInitializerIfKind(SyntaxKind.ArrowFunction) ||
-    getForwardRefFunction(variable)
-  );
-}
-
-export async function addFormUsage(libPath: string, placeOfUseName: string, formClassName: string): Promise<void> {
-  const project = new Project({
-    manipulationSettings: {
-      indentationText: IndentationText.TwoSpaces,
-      quoteKind: QuoteKind.Single,
-    },
-  });
-  const files = project.addSourceFilesAtPaths([`${libPath}/lib/**/*.tsx`, `${libPath}/lib/**/*.ts`]);
-  const file = files.find((file) => file.getFunction(placeOfUseName) || file.getVariableDeclaration(placeOfUseName));
-
-  if (!file) {
-    throw new Error('Could not find the place where the form should be used.');
-  }
-
-  const pathToForm = file.getFilePath().includes('components')
-    ? '../../forms'
-    : file.getFilePath().includes('hooks')
-      ? '../forms'
-      : './forms';
-  addNamedImport(formClassName, pathToForm, file);
-  addNamedImport('useForm', 'react-hook-form', file);
-  addNamedImport('yupResolver', '@hookform/resolvers/yup', file);
-
-  const placeOfUse = getPlaceOfUse(file, placeOfUseName);
-  placeOfUse.setBodyText(`${getFormUsageCode(formClassName)}${placeOfUse.getBodyText()}`);
-
-  project.saveSync();
-}

package/src/generators/form/utils/get-app-name.ts

@@ -1,3 +0,0 @@
-export function getAppName(path: string): string {
-  return path.split('/')[1];
-}

package/src/generators/form/utils/get-form-utils-directory.ts

@@ -1,59 +0,0 @@
-import { Tree } from '@nx/devkit';
-import { runFormUtilsGenerator } from '../../../shared/generators';
-import {
-  constants,
-  dynamicImport,
-  filterSource,
-  getNxLibsPaths,
-  LibraryType,
-  searchAliasPath,
-  searchNxLibsPaths,
-  selectProject,
-} from '../../../shared/utils';
-import { getAppName } from './get-app-name';
-
-function getFormUtilsPaths(): Array<string> {
-  const utilsLibsPaths = getNxLibsPaths([LibraryType.UTILS]);
-
-  return searchNxLibsPaths(utilsLibsPaths, 'utils/form/src', 'endsWith');
-}
-
-export async function getFormUtilsDirectory(tree: Tree, appName: string): Promise<string> {
-  const { default: autocomplete } = await dynamicImport<typeof import('inquirer-autocomplete-standalone')>(
-    'inquirer-autocomplete-standalone',
-  );
-
-  const formUtilsLibsPaths = getFormUtilsPaths();
-
-  if (!formUtilsLibsPaths.length) {
-    const formUtilsAppDirectory = (
-      await selectProject(
-        tree,
-        'application',
-        'It\'s necessary to generate form utilities. What application should they be in?',
-      )
-    ).name;
-    await runFormUtilsGenerator(tree, { directory: formUtilsAppDirectory });
-
-    return searchAliasPath(getFormUtilsPaths()[0]) as string;
-  }
-
-  if (formUtilsLibsPaths.length > 1) {
-    if (appName === constants.sharedValue) {
-      const path = formUtilsLibsPaths.find((path) => getAppName(path) === constants.sharedValue) as string;
-
-      return searchAliasPath(path) as string;
-    }
-
-    formUtilsLibsPaths[0] = await autocomplete({
-      message: 'Select the path of the library with the form utilities: ',
-      source: (input) =>
-        filterSource(
-          input as string,
-          formUtilsLibsPaths.filter((path) => [appName, constants.sharedValue].includes(getAppName(path))),
-        ),
-    });
-  }
-
-  return searchAliasPath(formUtilsLibsPaths[0]) as string;
-}

package/src/generators/form/utils/update-index.ts

@@ -1,15 +0,0 @@
-import { existsSync } from 'fs';
-import { Tree } from '@nx/devkit';
-import { kebabCase } from 'lodash';
-import { appendFileContent } from '../../../shared/utils';
-
-export function updateIndex(formsPath: string, fileName: string, tree: Tree): void {
-  const formsIndexFilePath = `${formsPath}/index.ts`;
-  const newIndexContent = `export * from './${kebabCase(fileName)}';\n`;
-
-  if (!existsSync(formsIndexFilePath)) {
-    tree.write(formsIndexFilePath, newIndexContent);
-  } else {
-    appendFileContent(formsIndexFilePath, newIndexContent, tree);
-  }
-}

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

@@ -1,57 +0,0 @@
-import { execSync } from 'child_process';
-import * as path from 'path';
-import { Tree } from '@nx/devkit';
-import {
-  LibraryType,
-  askQuestion,
-  constants,
-  dynamicImport,
-  filterSource,
-  getLibraryDetailsByName,
-  selectProject,
-  validateLibraryType,
-  getLibDirectoryName,
-} from '../../shared/utils';
-import { LibMoveGeneratorSchema } from './schema';
-
-export async function libMoveGenerator(tree: Tree, options: LibMoveGeneratorSchema) {
-  const { default: autocomplete } = await dynamicImport<typeof import('inquirer-autocomplete-standalone')>(
-    'inquirer-autocomplete-standalone',
-  );
-
-  const { name: srcLibraryName, path: srcLibraryPath } = await getLibraryDetailsByName(tree, options.srcLibName);
-
-  const libPathSegments = srcLibraryPath.split('/');
-  const defaultLibraryName = libPathSegments.pop();
-
-  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 libraryName =
-    options.name ||
-    (await askQuestion(
-      'If you want to rename the library, enter its new name. Otherwise just press Enter: ',
-      defaultLibraryName,
-    ));
-  const libDirectoryName = getLibDirectoryName(libraryName, options.scope);
-  const libPath = `libs/${path.normalize(`${options.app}/${options.scope}/${options.type}/${libDirectoryName}`)}`;
-
-  execSync(`npx nx g mv --project=${srcLibraryName} --destination=${libPath}`, { stdio: 'inherit' });
-
-  return (): void => {
-    execSync('npx nx g lib-tags --skipRepoCheck', { stdio: 'inherit' });
-  };
-}
-
-export default libMoveGenerator;

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

@@ -1,22 +0,0 @@
-import { execSync } from 'child_process';
-import { Tree } from '@nx/devkit';
-import { askQuestion, selectProject } from '../../shared/utils';
-import { LibRemoveGeneratorSchema } from './schema';
-
-export async function libRemoveGenerator(tree: Tree, options: LibRemoveGeneratorSchema): Promise<void> {
-  const libraryName = options.libName || (await selectProject(tree, 'library', 'Select the library to remove: ')).name;
-
-  if (!libraryName) {
-    throw new Error('No library found!');
-  }
-
-  const isConfirmed = await askQuestion(`Are you sure you want to remove ${libraryName} (y/n)?`);
-
-  if (!isConfirmed) {
-    return;
-  }
-
-  execSync(`npx nx g rm --project=${libraryName}`, { stdio: 'inherit' });
-}
-
-export default libRemoveGenerator;

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

@@ -1,25 +0,0 @@
-import { execSync } from 'child_process';
-import { Tree } from '@nx/devkit';
-import { askQuestion, getLibraryDetailsByName } from '../../shared/utils';
-import { LibRenameGeneratorSchema } from './schema';
-
-export async function libRenameGenerator(tree: Tree, options: LibRenameGeneratorSchema): Promise<void> {
-  const { name: currentLibraryName, path: currentLibraryPath } = await getLibraryDetailsByName(
-    tree,
-    options.currentLibName,
-  );
-
-  const libPathSegments = currentLibraryPath.split('/');
-  const defaultDestLibraryName = libPathSegments.pop();
-  const destLibraryName =
-    options.newLibName || (await askQuestion('Enter a new library name: ', defaultDestLibraryName));
-
-  // Remove `libs` path fragment
-  libPathSegments.shift();
-  libPathSegments.push(destLibraryName);
-
-  const destLibraryPath = `libs/${libPathSegments.join('/')}`;
-  execSync(`npx nx g mv --project=${currentLibraryName} --destination=${destLibraryPath}`, { stdio: 'inherit' });
-}
-
-export default libRenameGenerator;

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

@@ -1,66 +0,0 @@
-import { execSync } from 'child_process';
-import { Tree, getProjects, ProjectConfiguration, formatFiles, output } from '@nx/devkit';
-import { noop } from 'lodash';
-import { askQuestion, getNxRules, readESLintConfig, verifyEsLintConfig } from '../../shared/utils';
-import { LibTagsContext } from './interfaces';
-import { LibTagsGeneratorSchema } from './schema';
-import { checkApplicationTags, checkLibraryTags } from './utils';
-
-const context: LibTagsContext = {
-  config: {},
-  rules: [],
-  log: console.log,
-  reload: (tree: Tree) => {
-    context.config = readESLintConfig(tree).config;
-    context.rules = getNxRules(context.config);
-  },
-};
-
-export async function libTagsGenerator(tree: Tree, options: LibTagsGeneratorSchema): Promise<void> {
-  const hasUnstagedChanges = !options.skipRepoCheck && execSync('git status -s').toString('utf8');
-
-  if (hasUnstagedChanges) {
-    const shouldContinue =
-      (await askQuestion('You have unstaged changes. Are you sure you want to continue? (y/n): ')) === 'y';
-
-    if (!shouldContinue) {
-      return;
-    }
-  }
-
-  if (options.silent) {
-    context.log = noop;
-  }
-
-  // #1 Check eslint config nx-boundaries rule
-  output.log({ title: output.bold('1. Checking eslint config nx-boundaries rule...') });
-  context.config = verifyEsLintConfig(tree);
-
-  // #2 Check projects tags
-  output.log({ title: output.bold('2. Checking projects tags...') });
-  const projects = getProjects(tree);
-  const applications: Array<ProjectConfiguration> = [];
-  const libraries: Array<ProjectConfiguration> = [];
-
-  context.rules = getNxRules(context.config);
-
-  projects.forEach((project) => {
-    if (project.projectType === 'application') {
-      applications.push(project);
-    }
-
-    if (project.projectType === 'library' && project.root.startsWith('libs')) {
-      libraries.push(project);
-    }
-  });
-
-  applications.forEach((application) => checkApplicationTags(application, tree, context));
-
-  context.reload(tree);
-
-  libraries.forEach((library) => checkLibraryTags(library, tree, context));
-
-  await formatFiles(tree);
-}
-
-export default libTagsGenerator;

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,145 +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,104 +0,0 @@
-import { execSync } from 'child_process';
-import { existsSync } from 'fs';
-import * as path from 'path';
-import {
-  addDependenciesToPackageJson,
-  formatFiles,
-  generateFiles,
-  installPackagesTask,
-  readJson,
-  Tree,
-  writeJson,
-} from '@nx/devkit';
-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 { NextAppGeneratorSchema } from './schema';
-
-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 (): void => {
-    installPackagesTask(tree);
-  };
-}
-
-export default nextAppGenerator;