@vis.gl/dev-tools/src/helpers/get-ocular-config.ts

Dev tools for vis.gl frameworks

/* @typedef {import('./get-ocular-config')} default */

import fs from 'fs';
import {resolve} from 'path';
import getAliases, {getModuleInfo} from './aliases.js';
import {shallowMerge, getValidPath, ocularRoot} from '../utils/utils.js';
import type {BrowserTestDriver} from '@probe.gl/test-utils';

// TODO - export from probe.gl
type BrowserTestOptions = Parameters<BrowserTestDriver['run']>[0];

/** User configuration from .ocularrc.js */
export type OcularConfig = {
  root?: string;

  aliases?: {[module: string]: string};

  nodeAliases?: {[module: string]: string};

  bundle?: {
    target?: string[];
    globalName?: string;
    format?: 'cjs' | 'esm' | 'umd' | 'iife';
    externals?: string[];
    globals?: {[pattern: string]: string};
  };

  typescript?: {
    project: string;
  };

  lint?: {
    paths?: string[];
    extensions?: string[];
  };

  vite?: {
    version?: number;
    configPath?: string;
  };

  coverage?: {
    test?: 'node' | 'browser';
  };

  browserTest?: {
    server?: BrowserTestOptions['server'];
    browser?: BrowserTestOptions['browser'];
  };

  entry?: {
    test?: string;
    'test-browser'?: `${string}.html`;
    bench?: string;
    'bench-browser'?: `${string}.html`;
    size?: string[] | string;
  };
};

/** Internal type to typecheck resolved ocular config inside ocular-dev-tools */
export type MaterializedOcularConfig = {
  root: string;
  ocularPath: string;
  esm: boolean;

  aliases: {[module: string]: string};

  bundle: {
    target?: string[];
    globalName?: string;
    format?: 'cjs' | 'esm' | 'umd' | 'iife';
    externals?: string[];
    globals: {[pattern: string]: string};
  };

  typescript: {
    project: string;
  };

  lint: {
    paths: string[];
    extensions: string[];
  };

  vite: {
    version: number;
    configPath: string;
  };

  coverage: {
    test: 'node' | 'browser';
  };

  browserTest?: {
    server?: BrowserTestOptions['server'];
    browser?: BrowserTestOptions['browser'];
  };

  entry: {
    test: string;
    'test-browser': `${string}.html`;
    bench: string;
    'bench-browser': `${string}.html`;
    size: string[];
  };
};

export async function getOcularConfig(
  options: {
    root?: string;
    aliasMode?: 'src' | 'dist';
  } = {}
): Promise<MaterializedOcularConfig> {
  const packageRoot = options.root || process.env.PWD!;

  const IS_MONOREPO = fs.existsSync(resolve(packageRoot, './modules'));

  const userConfig = await getUserConfig(packageRoot);

  const config: MaterializedOcularConfig = {
    root: packageRoot,
    ocularPath: ocularRoot,

    esm: getModuleInfo(packageRoot)?.packageInfo.type === 'module',

    bundle: {
      globals: {}
    },

    typescript: {
      project: 'tsconfig.json'
    },

    lint: {
      paths: IS_MONOREPO ? ['modules'] : ['src'],
      extensions: ['js', 'mjs', 'jsx', 'ts', 'tsx', 'd.ts']
    },

    coverage: {
      test: 'node'
    },

    aliases: {},

    entry: {
      test: 'test/index.ts',
      'test-browser': 'test/index.html',
      bench: 'test/bench/index.ts',
      'bench-browser': 'test/bench/index.html',
      size: ['test/size.ts']
    },

    vite: {
      version: 4,
      configPath: getValidPath(
        resolve(packageRoot, './vite.config.js'),
        resolve(packageRoot, './vite.config.cjs'),
        resolve(ocularRoot, 'dist/configuration/vite.config.js')
      )!
    }
  };

  shallowMerge(config, userConfig);

  // Backward compatibility
  if (typeof userConfig.entry?.size === 'string') {
    userConfig.entry.size = [userConfig.entry.size];
  }

  const aliasMode = options.aliasMode || 'src';

  // User's aliases need to come first, due to module-alias resolve order
  Object.assign(config.aliases, getAliases(aliasMode, packageRoot));

  if (aliasMode && !aliasMode.includes('browser')) {
    Object.assign(config.aliases, userConfig.nodeAliases);
  }

  return config;
}

// HELPERS

/**
 * TODO better error messages
 */
async function getUserConfig(packageRoot: string): Promise<OcularConfig> {
  const userConfigPath = getValidPath(
    resolve(packageRoot, './.ocularrc.js'),
    resolve(packageRoot, './.ocularrc.cjs'),
    resolve(packageRoot, './.ocular.config.js'),
    resolve(packageRoot, './.ocular.config.cjs'),
    // deprecated
    resolve(packageRoot, './ocular-dev-tools.config.js')
  );

  if (userConfigPath) {
    const userConfigModule = (await import(userConfigPath)) as
      | OcularConfig
      | {default: OcularConfig};
    if ('default' in userConfigModule) {
      return userConfigModule.default;
    }
    return userConfigModule;
  }

  throw new Error('No valid user config found');
}