@teambit/workspace 0.0.554 → 0.0.558

package/eject-conf.cmd.tsx

@@ -1,62 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import chalk from 'chalk';
-import { Text } from 'ink';
-import React from 'react';
-
-import { EjectConfOptions, EjectConfResult, Workspace } from './workspace';
-
-type EjectConfArgs = [string];
-// From the cli we might get those as string in case we run it like --propagate true (return string) as opposed to only --propagate
-type EjectConfOptionsCLI = {
-  propagate: string | boolean | undefined;
-  override: string | boolean | undefined;
-};
-
-export default class EjectConfCmd implements Command {
-  name = 'eject-conf [id]';
-  description = 'ejecting components configuration';
-  alias = '';
-  group = 'development';
-  shortDescription = 'eject the target component configuration file (e.g. create a `component.json` file)';
-  options = [
-    ['p', 'propagate', 'mark propagate true in the config file'],
-    ['o', 'override', 'override file if exist'],
-  ] as CommandOptions;
-
-  constructor(private workspace: Workspace) {}
-
-  // TODO: remove this ts-ignore
-  // @ts-ignore
-  async render(args: EjectConfArgs, options: EjectConfOptionsCLI) {
-    const ejectResult = await this.json(args, options);
-    const [componentId] = args;
-    return (
-      <Text color="yellow">
-        successfully ejected config for component {componentId} in path {ejectResult.configPath}
-      </Text>
-    );
-  }
-
-  async report(args: EjectConfArgs, options: EjectConfOptionsCLI): Promise<string> {
-    const ejectResult = await this.json(args, options);
-    const [componentId] = args;
-    return `successfully ejected config for component ${chalk.bold(componentId)} in path ${chalk.green(
-      ejectResult.configPath
-    )}`;
-  }
-
-  async json([componentId]: EjectConfArgs, options: EjectConfOptionsCLI): Promise<EjectConfResult> {
-    const ejectOptions = options;
-    if (ejectOptions.propagate === 'true') {
-      ejectOptions.propagate = true;
-    }
-    if (ejectOptions.override === 'true') {
-      ejectOptions.override = true;
-    }
-
-    const id = await this.workspace.resolveComponentId(componentId);
-
-    const results = await this.workspace.ejectConfig(id, ejectOptions as EjectConfOptions);
-    return results;
-  }
-}

package/events/index.ts

@@ -1,3 +0,0 @@
-export * from './on-component-change-event';
-export * from './on-component-add-event';
-export * from './on-component-removed-event';

package/events/on-component-add-event.ts

@@ -1,14 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { BitBaseEvent } from '@teambit/pubsub';
-
-class OnComponentAddEventData {
-  constructor(readonly idStr, readonly hook) {}
-}
-
-export class OnComponentAddEvent extends BitBaseEvent<OnComponentAddEventData> {
-  static readonly TYPE = 'on-component-add';
-
-  constructor(readonly timestamp, readonly idStr, readonly hook) {
-    super(OnComponentAddEvent.TYPE, '0.0.1', timestamp, new OnComponentAddEventData(idStr, hook));
-  }
-}

package/events/on-component-change-event.ts

@@ -1,14 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { BitBaseEvent } from '@teambit/pubsub';
-
-class OnComponentChangeEventData {
-  constructor(readonly idStr, readonly hook) {}
-}
-
-export class OnComponentChangeEvent extends BitBaseEvent<OnComponentChangeEventData> {
-  static readonly TYPE = 'on-component-change';
-
-  constructor(readonly timestamp, readonly idStr, readonly hook) {
-    super(OnComponentChangeEvent.TYPE, '0.0.1', timestamp, new OnComponentChangeEventData(idStr, hook));
-  }
-}

package/events/on-component-removed-event.ts

@@ -1,14 +0,0 @@
-/* eslint-disable max-classes-per-file */
-import { BitBaseEvent } from '@teambit/pubsub';
-
-class OnComponentRemovedEventData {
-  constructor(readonly idStr) {}
-}
-
-export class OnComponentRemovedEvent extends BitBaseEvent<OnComponentRemovedEventData> {
-  static readonly TYPE = 'on-component-removed';
-
-  constructor(readonly timestamp, readonly idStr) {
-    super(OnComponentRemovedEvent.TYPE, '0.0.1', timestamp, new OnComponentRemovedEventData(idStr));
-  }
-}

package/exceptions/dependency-type-not-supported-in-policy.ts

@@ -1,7 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export class DependencyTypeNotSupportedInPolicy extends BitError {
-  constructor(type: string) {
-    super(`the workspace policy does not support ${type} dependencies`);
-  }
-}

package/exceptions/incorrect-env-aspect.ts

@@ -1,8 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-
-export class IncorrectEnvAspect extends BitError {
-  constructor(id: string, envType: string, envId: string) {
-    super(`"${id}" is configured in workspace.json, but using the "${envId}" environment, which is type "${envType}".
-please make sure to either apply the aspect environment or a composition of the aspect environment for the aspect to load.`);
-  }
-}

package/exceptions/index.ts

@@ -1 +0,0 @@
-export { DependencyTypeNotSupportedInPolicy } from './dependency-type-not-supported-in-policy';

package/index.ts

@@ -1,19 +0,0 @@
-import { WorkspaceAspect } from './workspace.aspect';
-// eslint-disable-next-line import/prefer-default-export
-export type { default as Workspace } from './workspace';
-// TODO: change to module path once track the utils folder
-export type { ResolvedComponent } from '@teambit/harmony.modules.resolved-component';
-export type { AlreadyExistsError as ComponentConfigFileAlreadyExistsError } from './component-config-file';
-export type { WorkspaceMain } from './workspace.main.runtime';
-export type { WatchOptions } from './watch/watcher';
-export { CheckTypes } from './watch/check-types';
-export * from './events';
-export type { WorkspaceUI } from './workspace.ui.runtime';
-export type { SerializableResults, OnComponentEventResult } from './on-component-events';
-export { ComponentStatus } from './workspace-component';
-export { WorkspaceModelComponent } from './ui/workspace/workspace-model';
-export { WorkspaceContext } from './ui/workspace/workspace-context';
-export type { WorkspaceComponent } from './workspace-component';
-
-export { WorkspaceAspect };
-export default WorkspaceAspect;

package/install.cmd.tsx

@@ -1,67 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import { DependencyLifecycleType } from '@teambit/dependency-resolver';
-import { Logger } from '@teambit/logger';
-import chalk from 'chalk';
-
-import { Workspace, WorkspaceInstallOptions } from './workspace';
-
-type InstallCmdOptions = {
-  variants: string;
-  type: DependencyLifecycleType;
-  skipDedupe: boolean;
-  skipImport: boolean;
-  updateExisting: boolean;
-  savePrefix: string;
-};
-
-export default class InstallCmd implements Command {
-  name = 'install [packages...]';
-  description = 'install development workspace dependencies';
-  alias = 'in';
-  group = 'development';
-  shortDescription = '';
-  options = [
-    ['v', 'variants <variants>', 'add packages to specific variants'],
-    ['t', 'type [lifecycleType]', 'runtime (default), dev or peer dependency'],
-    ['u', 'update-existing [updateExisting]', 'update existing dependencies version and types'],
-    ['', 'save-prefix [savePrefix]', 'set the prefix to use when adding dependency to workspace.jsonc'],
-    ['', 'skip-dedupe [skipDedupe]', 'do not dedupe dependencies on installation'],
-    ['', 'skip-import [skipImport]', 'do not import bit objects post installation'],
-  ] as CommandOptions;
-
-  constructor(
-    /**
-     * workspace extension.
-     */
-    private workspace: Workspace,
-
-    /**
-     * logger extension.
-     */
-    private logger: Logger
-  ) {}
-
-  async report([packages = []]: [string[]], options: InstallCmdOptions) {
-    const startTime = Date.now();
-    this.logger.console(`Resolving component dependencies for workspace: '${chalk.cyan(this.workspace.name)}'`);
-    const installOpts: WorkspaceInstallOptions = {
-      variants: options.variants,
-      lifecycleType: options.type,
-      dedupe: !options.skipDedupe,
-      import: !options.skipImport,
-      updateExisting: options.updateExisting,
-      savePrefix: options.savePrefix,
-    };
-    const components = await this.workspace.install(packages, installOpts);
-    const endTime = Date.now();
-    const executionTime = calculateTime(startTime, endTime);
-    return `Successfully resolved dependencies for ${chalk.cyan(
-      components.toArray().length.toString()
-    )} component(s) in ${chalk.cyan(executionTime.toString())} seconds`;
-  }
-}
-
-function calculateTime(startTime: number, endTime: number) {
-  const diff = endTime - startTime;
-  return diff / 1000;
-}

package/link/component-list-links.ts

@@ -1,50 +0,0 @@
-import chalk from 'chalk';
-import { LinksResult as LegacyLinksResult } from '@teambit/legacy/dist/links/node-modules-linker';
-import { getPackageNameFromTarget } from './get-package-name-from-target';
-import { LinkRow, VerboseLinkRow } from './link-row';
-
-type ComponentListLinksProps = {
-  componentListLinks?: LegacyLinksResult[];
-  verbose: boolean;
-};
-
-export function ComponentListLinks({ componentListLinks, verbose = false }: ComponentListLinksProps) {
-  if (!componentListLinks || !componentListLinks.length) {
-    return chalk.cyan('No components link were generated');
-  }
-  const title = chalk.bold.cyan('Components links');
-  const links = componentListLinks.map((componentLinks) => ComponentLinks({ componentLinks, verbose })).join('\n');
-
-  return `${title}\n${links}`;
-}
-
-type ComponentLinksProps = {
-  componentLinks: LegacyLinksResult;
-  verbose: boolean;
-};
-function ComponentLinks({ componentLinks, verbose = false }: ComponentLinksProps) {
-  if (!componentLinks.bound || componentLinks.bound.length < 1) return '';
-  if (verbose) return VerboseComponentLinks({ componentLinks });
-  return RegularComponentLinks({ componentLinks });
-}
-
-type RegularComponentLinksProps = {
-  componentLinks: LegacyLinksResult;
-};
-function RegularComponentLinks({ componentLinks }: RegularComponentLinksProps) {
-  const id = componentLinks.id.toString();
-  if (!componentLinks.bound || componentLinks.bound.length < 1) return '';
-  const packagePath = getPackageNameFromTarget(componentLinks.bound[0].to);
-  return LinkRow({ title: id, target: packagePath, padding: 50 });
-}
-
-type VerboseComponentLinksProps = {
-  componentLinks: LegacyLinksResult;
-};
-function VerboseComponentLinks({ componentLinks }: VerboseComponentLinksProps) {
-  const id = componentLinks.id.toString();
-  if (!componentLinks.bound || componentLinks.bound.length < 1) return '';
-  const title = chalk.bold.cyan(id);
-  const links = componentLinks.bound.map((link) => VerboseLinkRow({ from: link.from, to: link.to })).join('\n');
-  return `${title}\n${links}\n`;
-}

package/link/core-aspects-links.ts

@@ -1,50 +0,0 @@
-import { CoreAspectLinkResult } from '@teambit/dependency-resolver';
-import chalk from 'chalk';
-
-import { getPackageNameFromTarget } from './get-package-name-from-target';
-import { LinkRow, VerboseLinkRow } from './link-row';
-
-type CoreAspectsLinksProps = {
-  coreAspectsLinks?: CoreAspectLinkResult[];
-  verbose: boolean;
-};
-
-export function CoreAspectsLinks({ coreAspectsLinks, verbose = false }: CoreAspectsLinksProps) {
-  if (!coreAspectsLinks || !coreAspectsLinks.length) {
-    return chalk.cyan('No core aspects were linked');
-  }
-  const title = chalk.cyan('Core aspects links');
-  const links = coreAspectsLinks.map((link) => CoreAspectLinkRow({ coreAspectLink: link, verbose })).join('\n');
-  return `${title}\n${links}`;
-}
-
-type CoreAspectLinkProps = {
-  coreAspectLink: CoreAspectLinkResult;
-  verbose: boolean;
-};
-function CoreAspectLinkRow({ coreAspectLink, verbose = false }: CoreAspectLinkProps) {
-  if (verbose) return VerboseCoreAspectLink({ coreAspectLink });
-  return RegularCoreAspectLink({ coreAspectLink });
-}
-
-type RegularCoreAspectLinkProps = {
-  coreAspectLink: CoreAspectLinkResult;
-};
-function RegularCoreAspectLink({ coreAspectLink }: RegularCoreAspectLinkProps) {
-  const id = coreAspectLink.aspectId.toString();
-  const packagePath = getPackageNameFromTarget(coreAspectLink.linkDetail.to);
-  return LinkRow({ title: id, target: packagePath, padding: 50 });
-}
-
-type VerboseCoreAspectLinkProps = {
-  coreAspectLink: CoreAspectLinkResult;
-};
-function VerboseCoreAspectLink({ coreAspectLink }: VerboseCoreAspectLinkProps) {
-  const id = coreAspectLink.aspectId.toString();
-  const title = chalk.bold.cyan(id);
-  const link = VerboseLinkRow({
-    from: coreAspectLink.linkDetail.from,
-    to: coreAspectLink.linkDetail.to,
-  });
-  return `${title}\n${link}`;
-}

package/link/get-package-name-from-target.ts

@@ -1,5 +0,0 @@
-export function getPackageNameFromTarget(targetPath: string): string {
-  const subPath = targetPath.substring(targetPath.lastIndexOf('node_modules'));
-  const packagePath = subPath.split('/').slice(0, 3).join('/');
-  return `./${packagePath}`;
-}

package/link/index.ts

@@ -1 +0,0 @@
-export { LinkCommand } from './link.cmd';

package/link/link-row.ts

@@ -1,20 +0,0 @@
-import chalk from 'chalk';
-
-type LinkRowProps = {
-  title: string;
-  target: string;
-  padding?: number;
-};
-export function LinkRow({ title, target, padding = 50 }: LinkRowProps) {
-  return chalk.bold(`${title.padEnd(padding)} ${'>'} ${target}`);
-}
-
-type VerboseLinkRowProps = {
-  from: string;
-  to: string;
-};
-export function VerboseLinkRow({ from, to }: VerboseLinkRowProps) {
-  return `${chalk.bold('from')}: ${from}
-${chalk.bold('to')}: ${to}
-`;
-}

package/link/link-to-dir.ts

@@ -1,13 +0,0 @@
-import { LinkToDirResult } from '@teambit/dependency-resolver';
-import chalk from 'chalk';
-import { LinkRow } from './link-row';
-
-export function linkToDir(links?: LinkToDirResult[]) {
-  if (!links || !links.length) return '';
-  const title = chalk.bold.cyan('Target Links');
-  const linksOutput = links
-    .map(({ componentId, linksDetail }) => LinkRow({ title: componentId, target: linksDetail.to }))
-    .join('\n');
-
-  return `${title}\n${linksOutput}\n`;
-}

package/link/link.cmd.ts

@@ -1,96 +0,0 @@
-import { Command, CommandOptions } from '@teambit/cli';
-import { LinkResults } from '@teambit/dependency-resolver';
-import { Logger } from '@teambit/logger';
-import { BASE_DOCS_DOMAIN } from '@teambit/legacy/dist/constants';
-import { timeFormat } from '@teambit/toolbox.time.time-format';
-import chalk from 'chalk';
-import { Workspace, WorkspaceLinkOptions } from '../workspace';
-import { ComponentListLinks } from './component-list-links';
-import { CoreAspectsLinks } from './core-aspects-links';
-import { NestedComponentLinksLinks } from './nested-deps-in-nm-links';
-import { RewireRow } from './rewire-row';
-import { linkToDir } from './link-to-dir';
-
-type LinkCommandOpts = {
-  rewire: boolean;
-  verbose: boolean;
-  target: string;
-  skipFetchingObjects?: boolean;
-};
-export class LinkCommand implements Command {
-  name = 'link [ids...]';
-  alias = '';
-  description = `generate symlinks to resolve module paths for imported components.\n  https://${BASE_DOCS_DOMAIN}/docs/dependencies#missing-links`;
-  shortDescription = 'link components and core aspects';
-  group = 'development';
-  private = false;
-  options = [
-    ['j', 'json', 'return the output as JSON'],
-    ['', 'verbose', 'verbose output'],
-    ['r', 'rewire', 'Replace relative paths with module paths in code (e.g. "../foo" => "@bit/foo")'],
-    [
-      '',
-      'target <dir>',
-      'EXPERIMENTAL. link to an external directory (similar to npm-link) so other projects could use these components',
-    ],
-    ['', 'skip-fetching-objects', 'skip fetch missing objects from remotes before linking'],
-  ] as CommandOptions;
-
-  constructor(
-    /**
-     * workspace extension.
-     */
-    private workspace: Workspace,
-
-    /**
-     * logger extension.
-     */
-    private logger: Logger
-  ) {}
-
-  async report([ids]: [string[]], opts: LinkCommandOpts) {
-    const startTime = Date.now();
-    const linkResults = await this.json([ids], opts);
-    const endTime = Date.now();
-    const numOfComponents = linkResults.legacyLinkResults?.length;
-    const timeDiff = timeFormat(endTime - startTime);
-    const coreAspectsLinksWithMainAspect = linkResults.coreAspectsLinks || [];
-    if (linkResults.teambitBitLink) {
-      coreAspectsLinksWithMainAspect.unshift(linkResults.teambitBitLink);
-    }
-    const numOfCoreAspects = coreAspectsLinksWithMainAspect.length;
-
-    const title = `Linked ${numOfComponents} components and ${numOfCoreAspects} core aspects to node_modules for workspace: ${this.workspace.name}`;
-    const coreLinks = CoreAspectsLinks({
-      coreAspectsLinks: coreAspectsLinksWithMainAspect,
-      verbose: opts.verbose,
-    });
-    const compsLinks = ComponentListLinks({ componentListLinks: linkResults.legacyLinkResults, verbose: opts.verbose });
-    const rewireRow = RewireRow({ legacyCodemodResults: linkResults.legacyLinkCodemodResults });
-    const nestedLinks = NestedComponentLinksLinks({
-      nestedDepsInNmLinks: linkResults.nestedDepsInNmLinks,
-      verbose: opts.verbose,
-    });
-    const targetLinks = linkToDir(linkResults.linkToDirResults);
-    const footer = `Finished. ${timeDiff}`;
-    return `${title}\n${coreLinks}\n${compsLinks}\n${rewireRow}${nestedLinks}${targetLinks}${footer}`;
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async json([ids]: [string[]], opts: LinkCommandOpts): Promise<LinkResults> {
-    this.logger.console(
-      `Linking components and core aspects to node_modules for workspaces: '${chalk.cyan(this.workspace.name)}'`
-    );
-
-    const linkOpts: WorkspaceLinkOptions = {
-      legacyLink: true,
-      rewire: opts.rewire,
-      linkCoreAspects: true,
-      linkTeambitBit: true,
-      linkToDir: opts.target,
-      fetchObject: !opts.skipFetchingObjects,
-    };
-    const linkResults = await this.workspace.link(linkOpts);
-    return linkResults;
-  }
-}

package/link/nested-deps-in-nm-links.ts

@@ -1,47 +0,0 @@
-import chalk from 'chalk';
-import { NestedNMDepsLinksResult } from '@teambit/dependency-resolver';
-import { VerboseLinkRow } from './link-row';
-
-type NestedComponentLinksLinksProps = {
-  nestedDepsInNmLinks?: NestedNMDepsLinksResult[];
-  verbose: boolean;
-};
-
-export function NestedComponentLinksLinks({ nestedDepsInNmLinks, verbose = false }: NestedComponentLinksLinksProps) {
-  if (!verbose) return '';
-  if (!nestedDepsInNmLinks || !nestedDepsInNmLinks.length) {
-    return '';
-  }
-  const title = chalk.bold.cyan('Nested dependencies links');
-  const links = nestedDepsInNmLinks
-    .map((nestedComponentLinks) =>
-      NestedComponentLinks({
-        nestedComponentLinks,
-        verbose,
-      })
-    )
-    .join('\n');
-  return `${title}\n${links}\n`;
-}
-
-type NestedComponentLinksProps = {
-  nestedComponentLinks: NestedNMDepsLinksResult;
-  verbose: boolean;
-};
-function NestedComponentLinks({ nestedComponentLinks, verbose = false }: NestedComponentLinksProps) {
-  if (!nestedComponentLinks.linksDetail || nestedComponentLinks.linksDetail.length < 1) return '';
-  if (verbose) return VerboseNestedComponentLinks({ nestedComponentLinks });
-  return '';
-}
-
-type VerboseNestedComponentLinksProps = {
-  nestedComponentLinks: NestedNMDepsLinksResult;
-};
-function VerboseNestedComponentLinks({ nestedComponentLinks }: VerboseNestedComponentLinksProps) {
-  const id = nestedComponentLinks.componentId.toString();
-  const title = chalk.cyan.bold(id);
-  const links = nestedComponentLinks.linksDetail
-    .map((link) => VerboseLinkRow({ from: link.from, to: link.to }))
-    .join('\n');
-  return `${title}\n${links}\n`;
-}

package/link/rewire-row.ts

@@ -1,17 +0,0 @@
-import { CodemodResult } from '@teambit/legacy/dist/consumer/component-ops/codemod-components';
-import chalk from 'chalk';
-
-type RewireRowProps = {
-  legacyCodemodResults?: CodemodResult[];
-};
-export function RewireRow({ legacyCodemodResults }: RewireRowProps) {
-  if (!legacyCodemodResults || legacyCodemodResults.length < 1) return '';
-  const totalComps = legacyCodemodResults?.length;
-  const totalFiles = legacyCodemodResults.reduce((acc, curr) => {
-    return acc + curr.changedFiles.length || 0;
-  }, 0);
-
-  return `rewired ${chalk.cyan(totalComps.toString())} components and total of ${chalk.cyan(
-    totalFiles.toString()
-  )} files\n`;
-}

package/list.cmd.tsx

@@ -1,30 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { Command } from '@teambit/cli';
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { Text } from 'ink';
-import React from 'react';
-
-import { Workspace } from './workspace';
-
-export class ListCmd implements Command {
-  constructor(private workspace: Workspace) {}
-
-  name = 'lister';
-
-  description = 'list all components in the workspace';
-
-  summery = 'a different text i dont really need';
-
-  group = 'workspace';
-
-  alias = '';
-
-  options = [];
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  async render(params: any, options: { [key: string]: any }) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const list = await this.workspace.list();
-    return <Text color="green">hi there</Text>;
-  }
-}

package/on-component-events.ts

@@ -1,14 +0,0 @@
-import { Component, ComponentID, AspectData } from '@teambit/component';
-import { CompilationInitiator } from '@teambit/compiler';
-
-export type SerializableResults = { results: any; toString: () => string };
-export type OnComponentChange = (
-  component: Component,
-  files: string[],
-  initiator?: CompilationInitiator
-) => Promise<SerializableResults>;
-export type OnComponentAdd = (component: Component, files: string[]) => Promise<SerializableResults>;
-export type OnComponentRemove = (componentId: ComponentID) => Promise<SerializableResults>;
-export type OnComponentEventResult = { extensionId: string; results: SerializableResults };
-
-export type OnComponentLoad = (component: Component) => Promise<AspectData>;