get-workspace-layout.ts

import { RawWorkspaceJsonConfiguration } from 'nx/src/config/workspace-json-project-json';

import { readNxJson } from '../generators/project-configuration';
import { readJson } from './json';

import type { Tree } from 'nx/src/config/tree';

/**
 * Returns workspace defaults. It includes defaults folders for apps and libs,
 * and the default scope.
 *
 * Example:
 *
 * ```typescript
 * { appsDir: 'apps', libsDir: 'libs', npmScope: 'myorg' }
 * ```
 * @param tree - file system tree
 */
export function getWorkspaceLayout(tree: Tree): {
  appsDir: string;
  libsDir: string;
  standaloneAsDefault: boolean;
  npmScope: string;
} {
  const nxJson = readNxJson(tree);
  const workspacePath = getWorkspacePath(tree);
  const rawWorkspace =
    workspacePath && tree.exists(workspacePath)
      ? readJson<RawWorkspaceJsonConfiguration>(tree, workspacePath)
      : null;

  return {
    appsDir: nxJson?.workspaceLayout?.appsDir ?? 'apps',
    libsDir: nxJson?.workspaceLayout?.libsDir ?? 'libs',
    npmScope: nxJson?.npmScope ?? '',
    standaloneAsDefault: !rawWorkspace
      ? true // if workspace.json doesn't exist, all projects **must** be standalone
      : Object.values(rawWorkspace.projects).reduce(
          // default for second, third... projects should be based on all projects being defined as a path
          // for configuration read from ng schematics, this is determined by configFilePath's presence
          (allStandalone, next) =>
            allStandalone &&
            (typeof next === 'string' || 'configFilePath' in next),

          // default for first project should be true if using Nx Schema
          rawWorkspace.version > 1
        ),
  };
}

export function getWorkspacePath(
  tree: Tree
): '/angular.json' | '/workspace.json' | null {
  const possibleFiles: ('/angular.json' | '/workspace.json')[] = [
    '/angular.json',
    '/workspace.json',
  ];
  return possibleFiles.filter((path) => tree.exists(path))[0];
}