@teambit/snapping 1.0.108 → 1.0.110

package/snap-cmd.ts

@@ -1,195 +0,0 @@
-import chalk from 'chalk';
-import { ComponentID } from '@teambit/component-id';
-import ConsumerComponent from '@teambit/legacy/dist/consumer/component/consumer-component';
-import { IssuesClasses } from '@teambit/component-issues';
-import { GlobalConfigMain } from '@teambit/global-config';
-import { Command, CommandOptions } from '@teambit/cli';
-import {
-  NOTHING_TO_SNAP_MSG,
-  AUTO_SNAPPED_MSG,
-  COMPONENT_PATTERN_HELP,
-  CFG_FORCE_LOCAL_BUILD,
-} from '@teambit/legacy/dist/constants';
-import { Logger } from '@teambit/logger';
-import { SnappingMain, SnapResults } from './snapping.main.runtime';
-import { outputIdsIfExists } from './tag-cmd';
-import { BasicTagSnapParams } from './tag-model-component';
-
-export class SnapCmd implements Command {
-  name = 'snap [component-pattern]';
-  description = 'create an immutable and exportable component snapshot (non-release version)';
-  extendedDescription: string;
-  group = 'development';
-  arguments = [
-    {
-      name: 'component-pattern',
-      description: `${COMPONENT_PATTERN_HELP}. By default, only new and modified components are snapped (add --unmodified to snap all components in the workspace).`,
-    },
-  ];
-  helpUrl = 'reference/components/snaps';
-  alias = '';
-  options = [
-    ['m', 'message <message>', 'snap message describing the latest changes - will appear in component history log'],
-    ['u', 'unmodified', 'include unmodified components (by default, only new and modified components are snapped)'],
-    ['', 'unmerged', 'complete a merge process by snapping the unmerged components'],
-    ['b', 'build', 'locally run the build pipeline (i.e. not via rippleCI) and complete the snap'],
-    [
-      '',
-      'editor [editor]',
-      'open an editor to write a snap message per component. optionally specify the editor-name (defaults to vim).',
-    ],
-    ['', 'skip-tests', 'skip running component tests during snap process'],
-    ['', 'skip-auto-snap', 'skip auto snapping dependents'],
-    [
-      '',
-      'disable-snap-pipeline',
-      'skip the snap pipeline. this will for instance skip packing and publishing component version for install, and app deployment',
-    ],
-    ['', 'force-deploy', 'DEPRECATED. use --ignore-build-error instead'],
-    ['', 'ignore-build-errors', 'proceed to snap pipeline even when build pipeline fails'],
-    ['', 'rebuild-deps-graph', 'do not reuse the saved dependencies graph, instead build it from scratch'],
-    [
-      'i',
-      'ignore-issues [issues]',
-      `ignore component issues (shown in "bit status" as "issues found"), issues to ignore:
-[${Object.keys(IssuesClasses).join(', ')}]
-to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "*".`,
-    ],
-    ['a', 'all', 'DEPRECATED (not needed anymore, now the default). snap all new and modified components'],
-    [
-      '',
-      'fail-fast',
-      'stop pipeline execution on the first failed task (by default a task is skipped only when its dependency failed)',
-    ],
-    [
-      'f',
-      'force',
-      'DEPRECATED (use "--skip-tests" or "--unmodified" instead). force-snap even if tests are failing and even when component has not changed',
-    ],
-  ] as CommandOptions;
-  loader = true;
-  migration = true;
-
-  constructor(private snapping: SnappingMain, private logger: Logger, private globalConfig: GlobalConfigMain) {}
-
-  async report(
-    [pattern]: string[],
-    {
-      message = '',
-      all = false,
-      force = false,
-      unmerged = false,
-      editor = '',
-      ignoreIssues,
-      build,
-      skipTests = false,
-      skipAutoSnap = false,
-      disableSnapPipeline = false,
-      forceDeploy = false,
-      ignoreBuildErrors = false,
-      rebuildDepsGraph,
-      unmodified = false,
-      failFast = false,
-    }: {
-      all?: boolean;
-      force?: boolean;
-      unmerged?: boolean;
-      editor?: string;
-      ignoreIssues?: string;
-      skipAutoSnap?: boolean;
-      disableSnapPipeline?: boolean;
-      forceDeploy?: boolean;
-      unmodified?: boolean;
-      failFast?: boolean;
-    } & BasicTagSnapParams
-  ) {
-    build = (await this.globalConfig.getBool(CFG_FORCE_LOCAL_BUILD)) || Boolean(build);
-    const disableTagAndSnapPipelines = disableSnapPipeline;
-    if (all) {
-      this.logger.consoleWarning(
-        `--all is deprecated, please omit it. By default all new and modified components are snapped, to snap all components add --unmodified`
-      );
-    }
-    if (force) {
-      this.logger.consoleWarning(
-        `--force is deprecated, use either --skip-tests or --ignore-build-errors depending on the use case`
-      );
-      if (pattern) unmodified = true;
-    }
-    if (!message && !editor) {
-      this.logger.consoleWarning(
-        `--message will be mandatory in the next few releases. make sure to add a message with your snap, will be displayed in the version history`
-      );
-    }
-    if (forceDeploy) {
-      this.logger.consoleWarning(`--force-deploy is deprecated, use --ignore-build-errors instead`);
-      ignoreBuildErrors = true;
-    }
-
-    const results = await this.snapping.snap({
-      pattern,
-      message,
-      unmerged,
-      editor,
-      ignoreIssues,
-      build,
-      skipTests,
-      skipAutoSnap,
-      disableTagAndSnapPipelines,
-      ignoreBuildErrors,
-      rebuildDepsGraph,
-      unmodified,
-      exitOnFirstFailedTask: failFast,
-    });
-
-    if (!results) return chalk.yellow(NOTHING_TO_SNAP_MSG);
-    const { snappedComponents, autoSnappedResults, warnings, newComponents, laneName, removedComponents }: SnapResults =
-      results;
-    const changedComponents = snappedComponents.filter((component) => {
-      return (
-        !newComponents.searchWithoutVersion(component.id) && !removedComponents?.searchWithoutVersion(component.id)
-      );
-    });
-    const addedComponents = snappedComponents.filter((component) => newComponents.searchWithoutVersion(component.id));
-    const autoTaggedCount = autoSnappedResults ? autoSnappedResults.length : 0;
-
-    const warningsOutput = warnings && warnings.length ? `${chalk.yellow(warnings.join('\n'))}\n\n` : '';
-    const snapExplanation = `\n(use "bit export" to push these components to a remote")
-(use "bit reset" to unstage all local versions, or "bit reset --head" to only unstage the latest local snap)`;
-
-    const compInBold = (id: ComponentID) => {
-      const version = id.hasVersion() ? `@${id.version}` : '';
-      return `${chalk.bold(id.toStringWithoutVersion())}${version}`;
-    };
-
-    const outputComponents = (comps: ConsumerComponent[]) => {
-      return comps
-        .map((component) => {
-          let componentOutput = `     > ${compInBold(component.id)}`;
-          const autoTag = autoSnappedResults.filter((result) => result.triggeredBy.searchWithoutVersion(component.id));
-          if (autoTag.length) {
-            const autoTagComp = autoTag.map((a) => compInBold(a.component.id));
-            componentOutput += `\n       ${AUTO_SNAPPED_MSG} (${autoTagComp.length} total):
-            ${autoTagComp.join('\n            ')}`;
-          }
-          return componentOutput;
-        })
-        .join('\n');
-    };
-
-    const outputIfExists = (label, explanation, components) => {
-      if (!components.length) return '';
-      return `\n${chalk.underline(label)}\n(${explanation})\n${outputComponents(components)}\n`;
-    };
-    const laneStr = laneName ? ` on "${laneName}" lane` : '';
-
-    return (
-      outputIfExists('new components', 'first version for components', addedComponents) +
-      outputIfExists('changed components', 'components that got a version bump', changedComponents) +
-      outputIdsIfExists('removed components', removedComponents) +
-      warningsOutput +
-      chalk.green(`\n${snappedComponents.length + autoTaggedCount} component(s) snapped${laneStr}`) +
-      snapExplanation
-    );
-  }
-}

package/snap-distance-cmd.ts

@@ -1,29 +0,0 @@
-import { BitError } from '@teambit/bit-error';
-import { ScopeMain } from '@teambit/scope';
-import { Command, CommandOptions } from '@teambit/cli';
-
-export class SnapDistanceCmd implements Command {
-  name = 'snap-distance <component-id> [source-snap] [target-snap]';
-  description = 'show common-snap and distance between two given snaps or between local and remote snaps';
-  extendedDescription = `in case source and target snaps are not provided, the command will use the local and remote heads.
-by "head" we mean component-head if on main, or lane-head if on lane.
-if source and target snaps are provided, the command will use them to calculate the distance.`;
-  alias = '';
-  options = [] as CommandOptions;
-  loader = true;
-  migration = true;
-  private = true;
-
-  constructor(private scope: ScopeMain) {}
-
-  async report([id, sourceSnap, targetSnap]: [string, string, string]) {
-    const compId = await this.scope.resolveComponentId(id);
-    const getSnapDistance = async () => {
-      if (!sourceSnap) return this.scope.getSnapDistance(compId, false);
-      if (!targetSnap) throw new BitError('either provide both source and target snaps or none');
-      return this.scope.getSnapsDistanceBetweenTwoSnaps(compId, sourceSnap, targetSnap, false);
-    };
-    const snapDistance = await getSnapDistance();
-    return JSON.stringify(snapDistance, null, 2);
-  }
-}

package/snap-from-scope.cmd.ts

@@ -1,155 +0,0 @@
-import chalk from 'chalk';
-import { IssuesClasses } from '@teambit/component-issues';
-import { Command, CommandOptions } from '@teambit/cli';
-import { BitError } from '@teambit/bit-error';
-import { Logger } from '@teambit/logger';
-import { SnappingMain } from './snapping.main.runtime';
-import { BasicTagSnapParams } from './tag-model-component';
-
-export type FileData = { path: string; content: string; delete?: boolean };
-
-export type SnapDataPerCompRaw = {
-  componentId: string;
-  dependencies?: string[];
-  aspects?: Record<string, any>;
-  message?: string;
-  files?: FileData[];
-  isNew?: boolean;
-  mainFile?: string; // relevant when isNew is true. default to "index.ts".
-  newDependencies?: Array<{
-    id: string; // component-id or package-name. e.g. "teambit.react/react" or "lodash".
-    version?: string; // version of the package. e.g. "2.0.3". for packages, it is mandatory.
-    isComponent?: boolean; // default true. if false, it's a package dependency
-    type?: 'runtime' | 'dev' | 'peer'; // default "runtime".
-  }>;
-};
-
-type SnapFromScopeOptions = {
-  push?: boolean;
-  lane?: string;
-  ignoreIssues?: string;
-  disableSnapPipeline?: boolean;
-  forceDeploy?: boolean;
-} & BasicTagSnapParams;
-
-export class SnapFromScopeCmd implements Command {
-  name = '_snap <data>';
-  description = 'snap components from a bare-scope';
-  extendedDescription = `this command should be running from a new bare scope, it first imports the components it needs and then processes the snap.
-the input data is a stringified JSON of an array of the following object.
-{
-  componentId: string;     // ids always have scope, so it's safe to parse them from string
-  dependencies?: string[]; // dependencies to update their versions, e.g. [teambit/compiler@1.0.0, teambit/tester@1.0.0]
-  aspects?: Record<string,any> // e.g. { "teambit.react/react": {}, "teambit.envs/envs": { "env": "teambit.react/react" } }
-  message?: string;       // tag-message.
-  files?: Array<{path: string, content: string}>; // replace content of specified source-files. the content is base64 encoded.
-  isNew?: boolean;        // if it's new, it'll be generated from the given files. otherwise, it'll be fetched from the scope and updated.
-  mainFile?: string;      // relevant when isNew is true. default to "index.ts".
-  newDependencies?: Array<{  // new dependencies (components and packages) to add.
-    id: string;              // component-id or package-name. e.g. "teambit.react/react" or "lodash".
-    version?: string;        // version of the package. e.g. "2.0.3". for packages, it is mandatory.
-    isComponent?: boolean;   // default true. if false, it's a package dependency
-    type?: 'runtime' | 'dev' | 'peer'; // default "runtime".
-  }>;
-}
-an example of the final data: '[{"componentId":"ci.remote2/comp-b","message": "first snap"}]'
-`;
-  alias = '';
-  options = [
-    ['', 'push', 'export the updated objects to the original scopes once done'],
-    ['m', 'message <message>', 'log message describing the latest changes'],
-    ['', 'lane <lane-id>', 'fetch the components from the given lane'],
-    ['', 'build', 'run the build pipeline'],
-    ['', 'skip-tests', 'skip running component tests during snap process'],
-    ['', 'disable-snap-pipeline', 'skip the snap pipeline'],
-    ['', 'force-deploy', 'DEPRECATED. use --ignore-build-error instead'],
-    ['', 'ignore-build-errors', 'run the snap pipeline although the build pipeline failed'],
-    ['', 'rebuild-deps-graph', 'do not reuse the saved dependencies graph, instead build it from scratch'],
-    [
-      'i',
-      'ignore-issues [issues]',
-      `ignore component issues (shown in "bit status" as "issues found"), issues to ignore:
-[${Object.keys(IssuesClasses).join(', ')}]
-to ignore multiple issues, separate them by a comma and wrap with quotes. to ignore all issues, specify "*".`,
-    ],
-    ['j', 'json', 'output as json format'],
-  ] as CommandOptions;
-  loader = true;
-  private = true;
-  migration = true;
-
-  constructor(private snapping: SnappingMain, private logger: Logger) {}
-
-  async report([data]: [string], options: SnapFromScopeOptions) {
-    const results = await this.json([data], options);
-
-    const { snappedIds, exportedIds } = results;
-
-    const snappedOutput = `${chalk.bold('snapped components')}\n${snappedIds.join('\n')}`;
-    const exportedOutput =
-      exportedIds && exportedIds.length ? `\n\n${chalk.bold('exported components')}\n${exportedIds.join('\n')}` : '';
-
-    return `${snappedOutput}${exportedOutput}`;
-  }
-  async json(
-    [data]: [string],
-    {
-      push = false,
-      message = '',
-      lane,
-      ignoreIssues,
-      build = false,
-      skipTests = false,
-      disableSnapPipeline = false,
-      ignoreBuildErrors = false,
-      rebuildDepsGraph,
-      forceDeploy = false,
-    }: SnapFromScopeOptions
-  ) {
-    const disableTagAndSnapPipelines = disableSnapPipeline;
-    if (forceDeploy) {
-      ignoreBuildErrors = true;
-    }
-    if (disableTagAndSnapPipelines && ignoreBuildErrors) {
-      throw new BitError('you can use either ignore-build-errors or disable-snap-pipeline, but not both');
-    }
-
-    const snapDataPerCompRaw = this.parseData(data);
-
-    const results = await this.snapping.snapFromScope(snapDataPerCompRaw, {
-      push,
-      message,
-      lane,
-      ignoreIssues,
-      build,
-      skipTests,
-      disableTagAndSnapPipelines,
-      ignoreBuildErrors,
-      rebuildDepsGraph,
-    });
-
-    return results;
-  }
-  private parseData(data: string): SnapDataPerCompRaw[] {
-    let dataParsed: unknown;
-    try {
-      dataParsed = JSON.parse(data);
-    } catch (err: any) {
-      throw new Error(`failed parsing the data entered as JSON. err ${err.message}`);
-    }
-    if (!Array.isArray(dataParsed)) {
-      throw new Error('expect data to be an array');
-    }
-    dataParsed.forEach((dataItem) => {
-      if (!dataItem.componentId) throw new Error('expect data item to have "componentId" prop');
-      dataItem.files?.forEach((file) => {
-        if (!file.path) throw new Error('expect file to have "path" prop');
-        if (file.content) {
-          file.content = Buffer.from(file.content, 'base64').toString();
-        }
-      });
-    });
-
-    return dataParsed;
-  }
-}

package/snapping.aspect.ts

@@ -1,5 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const SnappingAspect = Aspect.create({
-  id: 'teambit.component/snapping',
-});