@teambit/aspect-loader 1.0.108 → 1.0.109

package/constants.ts

@@ -1,16 +0,0 @@
-import chalk from 'chalk';
-
-export const UNABLE_TO_LOAD_EXTENSION = (id: string, errMsg?: string) =>
-  `error: Bit received an error loading "${id}", due to the error "${
-    errMsg || '<unknown-error>'
-  }", please use the '--log=error' flag for the full error.`;
-export const UNABLE_TO_LOAD_EXTENSION_FROM_LIST = (ids: string[], errMsg?: string, neededFor?: string) => {
-  // const installOutput = err?.code === 'MODULE_NOT_FOUND' ? `try running "bit install" to install the missing dependencies` : '';
-  const installOutput = `try running ${chalk.cyan('"bit install"')} to fix this issue`;
-  return `Bit received an error loading ${chalk.cyan(ids.join(', '))}, due to the error:
-"${errMsg || '<unknown-error>'}".
-This is required for the component: ${chalk.cyan(neededFor || 'unknown')}
-Please use the ${chalk.cyan("'--log=error'")} flag for the full error.
-${installOutput}
-`;
-};

package/core-aspects.spec.ts

@@ -1,10 +0,0 @@
-import { getCoreAspectName } from './core-aspects';
-
-describe('core-aspects', () => {
-  describe('getCoreAspectName', () => {
-    it('should include the namespace in the aspect name', () => {
-      const aspectName = getCoreAspectName('teambit.workspace/e2e/workspace');
-      expect(aspectName).toEqual('e2e.workspace');
-    });
-  });
-});

package/core-aspects.ts

@@ -1,153 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-import { existsSync, readdir } from 'fs-extra';
-import { join, resolve } from 'path';
-import { Config } from '@teambit/bvm.config';
-import { findCurrentBvmDir } from '@teambit/bvm.path';
-
-let _bvmConfig;
-
-export function getBvmDir(): string {
-  if (!_bvmConfig) {
-    _bvmConfig = Config.load(false, ['env', 'file']);
-  }
-
-  const bvmConfig = _bvmConfig;
-  return bvmConfig.getBvmDirectory();
-}
-
-function isRunFromBvm() {
-  return __dirname.includes('.bvm') || __dirname.includes(getBvmDir());
-}
-
-function resolveFromPaths(packageName: string, aspectName: string, pathsToResolveAspects: string[]): string {
-  const moduleDirectory = require.resolve(packageName, { paths: pathsToResolveAspects });
-  const dirPath = join(moduleDirectory, '../..'); // to remove the "index.js" at the end
-  if (!existsSync(dirPath)) {
-    throw new Error(`unable to find ${aspectName} in ${dirPath}`);
-  }
-  return dirPath;
-}
-
-function resolveFromCurrDir(packageName: string, aspectName: string): string | undefined {
-  try {
-    const moduleDirectory = require.resolve(packageName);
-    const dirPath = join(moduleDirectory, '../..'); // to remove the "index.js" at the end
-    if (!existsSync(dirPath)) {
-      throw new Error(`unable to find ${aspectName} in ${dirPath}`);
-    }
-    return dirPath;
-  } catch (err) {
-    return undefined;
-  }
-}
-function resolveFromBvmDir(packageName: string): string | undefined {
-  const currentBitDir = findCurrentBvmDir();
-  if (currentBitDir) {
-    return resolve(currentBitDir, 'node_modules', packageName);
-  }
-  return undefined;
-}
-
-function getAspectDirFromPath(id: string, pathsToResolveAspects?: string[]): string {
-  const aspectName = getCoreAspectName(id);
-  const packageName = getCoreAspectPackageName(id);
-
-  if (pathsToResolveAspects && pathsToResolveAspects.length) {
-    const fromPaths = resolveFromPaths(packageName, aspectName, pathsToResolveAspects);
-    return fromPaths;
-  }
-  const isRunFromBvmDir = isRunFromBvm();
-  const resolvers = isRunFromBvmDir ? [resolveFromBvmDir, resolveFromCurrDir] : [resolveFromCurrDir, resolveFromBvmDir];
-  for (const resolver of resolvers) {
-    const currResolved = resolver(packageName, aspectName);
-    if (currResolved) return currResolved;
-  }
-  throw new Error(`unable to find ${aspectName}`);
-}
-
-export function getAspectDir(id: string): string {
-  const aspectName = getCoreAspectName(id);
-  let dirPath;
-
-  try {
-    dirPath = getAspectDirFromPath(id);
-  } catch (err: any) {
-    dirPath = resolve(__dirname, '../..', aspectName, 'dist');
-  }
-  if (!existsSync(dirPath)) {
-    throw new Error(`unable to find ${aspectName} in ${dirPath}`);
-  }
-  return dirPath;
-}
-
-type BvmDirOptions = {
-  version?: string;
-  linkName?: string;
-};
-
-export function getAspectDirFromBvm(id: string, bvmDirOptions?: BvmDirOptions): string {
-  // Resolve from default link
-  if (!bvmDirOptions) {
-    const packageName = getCoreAspectPackageName(id);
-    const resolved = resolveFromBvmDir(packageName);
-    if (resolved) return resolved;
-  }
-
-  if (!_bvmConfig) {
-    _bvmConfig = Config.load(false, ['env', 'file']);
-  }
-
-  const bvmConfig = _bvmConfig;
-  let version;
-  if (bvmDirOptions?.version) {
-    version = bvmDirOptions?.version;
-  } else {
-    const link = bvmDirOptions?.linkName || bvmConfig.getDefaultLinkName();
-    if (!link) {
-      throw new BitError(`can't find link in bvm config. most likely bvm is not installed`);
-    }
-    const links = bvmConfig.getLinks();
-    version = links[link];
-    if (!version) {
-      throw new BitError(`can't find link named ${bvmDirOptions?.linkName} in bvm config`);
-    }
-  }
-  const { versionDir, exists } = bvmConfig.getSpecificVersionDir(version, true);
-  if (!exists) {
-    throw new BitError(`can't find version ${version} in bvm folder`);
-  }
-  return getAspectDirFromPath(id, [versionDir]);
-}
-
-export function getAspectDistDir(id: string) {
-  return resolve(`${getAspectDir(id)}/dist`);
-}
-
-export function getCoreAspectName(id: string): string {
-  const [, ...name] = id.split('/');
-  const aspectName = name.join('.');
-  return aspectName;
-}
-
-export function getCoreAspectPackageName(id: string): string {
-  const aspectName = getCoreAspectName(id);
-  return `@teambit/${aspectName}`;
-}
-
-export async function getAspectDef(aspectName: string, runtime?: string) {
-  const dirPath = getAspectDistDir(aspectName);
-
-  const files = await readdir(dirPath);
-  let runtimeFile;
-  if (runtime) {
-    runtimeFile = files.find((file) => file.includes(`.${runtime}.runtime.js`)) || null;
-  }
-  const aspectFile = files.find((file) => file.includes(`.aspect.js`)) || null;
-
-  return {
-    id: aspectName,
-    aspectPath: join(dirPath, '..'),
-    aspectFilePath: aspectFile ? resolve(`${dirPath}/${aspectFile}`) : null,
-    runtimePath: runtimeFile ? resolve(`${dirPath}/${runtimeFile}`) : null,
-  };
-}

package/index.ts

@@ -1,23 +0,0 @@
-import { AspectLoaderAspect } from './aspect-loader.aspect';
-
-export type {
-  AspectLoaderMain,
-  AspectDescriptor,
-  MainAspect,
-  OnLoadRequireableExtension,
-  AspectResolver,
-  ResolvedAspect,
-} from './aspect-loader.main.runtime';
-export {
-  getAspectDef,
-  getAspectDir,
-  getAspectDistDir,
-  getCoreAspectPackageName,
-  getCoreAspectName,
-  getAspectDirFromBvm,
-} from './core-aspects';
-export type { PluginDefinition } from './plugin-definition';
-export { AspectDefinition } from './aspect-definition';
-export { UNABLE_TO_LOAD_EXTENSION } from './constants';
-export { AspectLoaderAspect };
-export default AspectLoaderAspect;

package/is-esm-module.ts

@@ -1,14 +0,0 @@
-import findRoot from 'find-root';
-import { join } from 'path';
-import { readFileSync } from 'fs';
-
-export function isEsmModule(path: string) {
-  try {
-    const root = findRoot(path);
-    const packageJsonString = readFileSync(join(root, 'package.json')).toString('utf-8');
-    const packageJson = JSON.parse(packageJsonString);
-    return packageJson.type === 'module';
-  } catch (err) {
-    return false;
-  }
-}

package/plugin-definition.ts

@@ -1,24 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export interface PluginDefinition {
-  /**
-   * regex pattern for detecting the definition file within a component.
-   */
-  pattern: string | RegExp;
-
-  /**
-   * runtimes for the plugin to apply.
-   */
-  runtimes: string[];
-
-  /**
-   * register the plugin to its slot registry.
-   */
-
-  /**
-   * Plugin implementation.
-   * @param object The object that was exported as default by the *.plugin-pattern file.
-   * @param sourceAspect Pointer to the aspect that is using the plugin (the aspect that contain the *.plugin-pattern file).
-   */
-  register<T>(object: T, sourceAspect: Aspect): void;
-}

package/plugin.ts

@@ -1,27 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-import { PluginDefinition } from './plugin-definition';
-
-export class Plugin {
-  constructor(readonly def: PluginDefinition, readonly path: string) {}
-
-  // consider adding a more abstract type here to allow users to ask for dependencies.
-  private _instance: undefined | unknown;
-
-  /**
-   * determines whether the plugin supports a certain runtime.
-   */
-  supportsRuntime(runtime: string) {
-    return this.def.runtimes.includes(runtime);
-  }
-
-  register(sourceAspect: Aspect, module?: unknown) {
-    const object = module || this.require();
-    this.def.register<unknown>(object, sourceAspect);
-  }
-
-  require() {
-    // eslint-disable-next-line global-require, import/no-dynamic-require
-    this._instance = require(this.path).default;
-    return this._instance;
-  }
-}

package/plugins.ts

@@ -1,150 +0,0 @@
-import { Component } from '@teambit/component';
-import esmLoader from '@teambit/node.utils.esm-loader';
-import { NativeCompileCache } from '@teambit/toolbox.performance.v8-cache';
-import { Logger } from '@teambit/logger';
-import { Aspect } from '@teambit/harmony';
-import { PluginDefinition } from './plugin-definition';
-import { isEsmModule } from './is-esm-module';
-import { Plugin } from './plugin';
-import { OnAspectLoadErrorHandler } from './aspect-loader.main.runtime';
-
-export type PluginMap = { [filePath: string]: PluginDefinition };
-
-export class Plugins {
-  constructor(
-    readonly component: Component,
-    readonly plugins: Plugin[],
-    private triggerOnAspectLoadError: OnAspectLoadErrorHandler,
-    private logger: Logger
-  ) {}
-
-  // computeDependencies(runtime: string): Aspect[] {
-  //   const inRuntime = this.getByRuntime(runtime);
-  //   return inRuntime.flatMap((plugin) => {
-  //     return plugin.def.dependencies;
-  //   });
-  // }
-
-  getByRuntime(runtime: string) {
-    return this.plugins.filter((plugin) => {
-      return plugin.supportsRuntime(runtime);
-    });
-  }
-
-  async load(runtime: string) {
-    const plugins = this.getByRuntime(runtime);
-    const aspect = Aspect.create({
-      id: this.component.id.toString(),
-    });
-
-    aspect.addRuntime({
-      provider: async () => {
-        await Promise.all(
-          plugins.map(async (plugin) => {
-            return this.registerPluginWithTryCatch(plugin, aspect);
-          })
-        );
-        // Return an empty object so haromny will have something in the extension instance
-        // otherwise it will throw an error when trying to access the extension instance (harmony.get)
-        return {};
-      },
-      runtime,
-      // dependencies: this.computeDependencies(runtime)
-      dependencies: [],
-    });
-
-    return aspect;
-  }
-
-  async loadModule(path: string) {
-    NativeCompileCache.uninstall();
-    const module = await esmLoader(path);
-    return module.default;
-  }
-
-  async registerPluginWithTryCatch(plugin: Plugin, aspect: Aspect) {
-    const isModule = isEsmModule(plugin.path);
-    const module = isModule ? await this.loadModule(plugin.path) : undefined;
-
-    try {
-      if (isModule && !module) {
-        this.logger.consoleFailure(
-          `failed to load plugin ${plugin.path}, make sure to use 'export default' to expose your plugin`
-        );
-        return undefined;
-      }
-      return plugin.register(aspect, module);
-    } catch (firstErr: any) {
-      this.logger.warn(
-        `failed loading plugin with pattern "${
-          plugin.def.pattern
-        }", in component ${this.component.id.toString()}, will try to fix and reload`,
-        firstErr
-      );
-      const isFixed = await this.triggerOnAspectLoadError(firstErr, this.component);
-      let errAfterReLoad;
-      if (isFixed) {
-        this.logger.info(
-          `the loading issue might be fixed now, re-loading plugin with pattern "${
-            plugin.def.pattern
-          }", in component ${this.component.id.toString()}`
-        );
-        try {
-          return plugin.register(aspect, module);
-        } catch (err: any) {
-          this.logger.warn(
-            `re-load of the plugin with pattern "${
-              plugin.def.pattern
-            }", in component ${this.component.id.toString()} failed as well`,
-            err
-          );
-          errAfterReLoad = err;
-        }
-      }
-      const error = errAfterReLoad || firstErr;
-      throw error;
-    }
-  }
-
-  has() {
-    return Boolean(this.plugins.length);
-  }
-
-  static from(
-    component: Component,
-    defs: PluginDefinition[],
-    triggerOnAspectLoadError: OnAspectLoadErrorHandler,
-    logger: Logger,
-    resolvePath?: (path: string) => string
-  ) {
-    const plugins = defs.flatMap((pluginDef) => {
-      const files =
-        typeof pluginDef.pattern === 'string'
-          ? component.filesystem.byGlob([pluginDef.pattern])
-          : component.filesystem.byRegex(pluginDef.pattern);
-
-      return files.map((file) => {
-        return new Plugin(pluginDef, resolvePath ? resolvePath(file.relative) : file.path);
-      });
-    });
-
-    return new Plugins(component, plugins, triggerOnAspectLoadError, logger);
-  }
-
-  /**
-   * Get the plugin files from the component.
-   */
-  static files(component: Component, defs: PluginDefinition[], resolvePath?: (path: string) => string): string[] {
-    const files = defs.flatMap((pluginDef) => {
-      const matches =
-        typeof pluginDef.pattern === 'string'
-          ? component.filesystem.byGlob([pluginDef.pattern])
-          : component.filesystem.byRegex(pluginDef.pattern);
-
-      return matches.map((file) => {
-        return resolvePath ? resolvePath(file.relative) : file.path;
-      });
-    });
-    return files;
-  }
-}