@teambit/workspace 0.0.555 → 0.0.556

package/tag-cmd.ts

@@ -1,247 +0,0 @@
-import chalk from 'chalk';
-import semver, { ReleaseType } from 'semver';
-import { Command, CommandOptions } from '@teambit/cli';
-import { tagAction } from '@teambit/legacy/dist/api/consumer';
-import {
-  TagResults,
-  NOTHING_TO_TAG_MSG,
-  AUTO_TAGGED_MSG,
-  BasicTagParams,
-} from '@teambit/legacy/dist/api/consumer/lib/tag';
-import { isString } from '@teambit/legacy/dist/utils';
-import { DEFAULT_BIT_RELEASE_TYPE, BASE_DOCS_DOMAIN, WILDCARD_HELP } from '@teambit/legacy/dist/constants';
-import GeneralError from '@teambit/legacy/dist/error/general-error';
-import { isFeatureEnabled, BUILD_ON_CI } from '@teambit/legacy/dist/api/consumer/lib/feature-toggle';
-
-export class Tag implements Command {
-  name = 'tag [id...]';
-  group = 'development';
-  shortDescription = 'record component changes and lock versions';
-  description = `record component changes and lock versions.
-if component ids are entered, you can specify a version per id using "@" sign, e.g. bit tag foo@1.0.0 bar@minor baz@major
-https://${BASE_DOCS_DOMAIN}/docs/tag-component-version
-${WILDCARD_HELP('tag')}`;
-  alias = 't';
-  loader = true;
-  options = [
-    ['m', 'message <message>', 'log message describing the user changes'],
-    ['a', 'all [version]', 'tag all new and modified components'],
-    ['s', 'scope [version]', 'tag all components of the current scope'],
-    ['', 'snapped [version]', 'tag components that their head is a snap (not a tag)'],
-    ['', 'ver <version>', 'tag specified components with the given version'],
-    ['p', 'patch', 'increment the patch version number'],
-    ['', 'minor', 'increment the minor version number'],
-    ['', 'major', 'increment the major version number'],
-    ['', 'pre-release [identifier]', 'EXPERIMENTAL. increment a pre-release version (e.g. 1.0.0-dev.1)'],
-    ['f', 'force', 'force-tag even if tests are failing and even when component has not changed'],
-    ['v', 'verbose', 'show specs output on failure'],
-    ['', 'ignore-unresolved-dependencies', 'DEPRECATED. use --ignore-issues instead'],
-    ['i', 'ignore-issues', 'ignore component issues (shown in "bit status" as "issues found")'],
-    ['I', 'ignore-newest-version', 'ignore existing of newer versions (default = false)'],
-    ['', 'skip-tests', 'skip running component tests during tag process'],
-    ['', 'skip-auto-tag', 'skip auto tagging dependents'],
-    ['b', 'build', 'EXPERIMENTAL. not needed for now. run the pipeline build and complete the tag'],
-    ['', 'soft', 'do not persist. only keep note of the changes to be made'],
-    ['', 'persist', 'persist the changes generated by --soft tag'],
-    ['', 'disable-deploy-pipeline', 'DEPRECATED. use --disable-tag-pipeline instead'],
-    ['', 'disable-tag-pipeline', 'skip the tag pipeline to avoid publishing the components'],
-    ['', 'force-deploy', 'run the tag pipeline although the build failed'],
-    [
-      '',
-      'increment-by <number>',
-      '(default to 1) increment semver flag (patch/minor/major) by. e.g. incrementing patch by 2: 0.0.1 -> 0.0.3.',
-    ],
-  ] as CommandOptions;
-  migration = true;
-  remoteOp = true; // In case a compiler / tester is not installed
-
-  // eslint-disable-next-line complexity
-  async report(
-    [id = []]: [string[]],
-    {
-      message = '',
-      ver,
-      all = false,
-      snapped = false,
-      patch,
-      minor,
-      major,
-      preRelease,
-      force = false,
-      verbose = false,
-      ignoreUnresolvedDependencies,
-      ignoreIssues = false,
-      ignoreNewestVersion = false,
-      skipTests = false,
-      skipAutoTag = false,
-      scope,
-      build,
-      soft = false,
-      persist = false,
-      disableDeployPipeline = false,
-      disableTagPipeline = false,
-      forceDeploy = false,
-      incrementBy = 1,
-    }: {
-      all?: boolean | string;
-      snapped?: boolean | string;
-      ver?: string;
-      patch?: boolean;
-      minor?: boolean;
-      major?: boolean;
-      ignoreUnresolvedDependencies?: boolean;
-      ignoreIssues?: boolean;
-      scope?: string | boolean;
-      incrementBy?: number;
-      disableDeployPipeline?: boolean;
-      disableTagPipeline?: boolean;
-    } & Partial<BasicTagParams>
-  ): Promise<string> {
-    build = isFeatureEnabled(BUILD_ON_CI) ? Boolean(build) : true;
-    if (soft) build = false;
-    function getVersion(): string | undefined {
-      if (scope && isString(scope)) return scope;
-      if (all && isString(all)) return all;
-      if (snapped && isString(snapped)) return snapped;
-      return ver;
-    }
-
-    if (!id.length && !all && !snapped && !scope && !persist) {
-      throw new GeneralError('missing [id]. to tag all components, please use --all flag');
-    }
-    if (id.length && all) {
-      throw new GeneralError(
-        'you can use either a specific component [id] to tag a particular component or --all flag to tag them all'
-      );
-    }
-    if (typeof ignoreUnresolvedDependencies === 'boolean') {
-      ignoreIssues = ignoreUnresolvedDependencies;
-    }
-    if (id.length === 2) {
-      const secondArg = id[1];
-      // previously, the synopsis of this command was `bit tag [id] [version]`, show a descriptive
-      // error when users still use it.
-      if (semver.valid(secondArg)) {
-        throw new GeneralError(
-          `seems like you entered a version as the second arg, this is not supported anymore, please use "@" sign or --ver flag instead`
-        );
-      }
-    }
-    const disableTagAndSnapPipelines = disableTagPipeline || disableDeployPipeline;
-    if (disableTagAndSnapPipelines && forceDeploy) {
-      throw new GeneralError('you can use either force-deploy or disable-tag-pipeline, but not both');
-    }
-    if (all && persist) {
-      throw new GeneralError('you can use either --all or --persist, but not both');
-    }
-
-    const releaseFlags = [patch, minor, major, preRelease].filter((x) => x);
-    if (releaseFlags.length > 1) {
-      throw new GeneralError('you can use only one of the following - patch, minor, major, pre-release');
-    }
-
-    let releaseType: ReleaseType = DEFAULT_BIT_RELEASE_TYPE;
-    const includeImported = Boolean(scope && all);
-
-    if (major) releaseType = 'major';
-    else if (minor) releaseType = 'minor';
-    else if (patch) releaseType = 'patch';
-    else if (preRelease) releaseType = 'prerelease';
-
-    const params = {
-      ids: id,
-      all: Boolean(all),
-      snapped: Boolean(snapped),
-      message,
-      exactVersion: getVersion(),
-      releaseType,
-      preRelease: typeof preRelease === 'string' ? preRelease : '',
-      force,
-      verbose,
-      ignoreIssues,
-      ignoreNewestVersion,
-      skipTests,
-      skipAutoTag,
-      build,
-      soft,
-      persist,
-      scope,
-      includeImported,
-      disableTagAndSnapPipelines,
-      forceDeploy,
-      incrementBy,
-    };
-
-    const results = await tagAction(params);
-    if (!results) return chalk.yellow(NOTHING_TO_TAG_MSG);
-    const { taggedComponents, autoTaggedResults, warnings, newComponents }: TagResults = results;
-    const changedComponents = taggedComponents.filter((component) => !newComponents.searchWithoutVersion(component.id));
-    const addedComponents = taggedComponents.filter((component) => newComponents.searchWithoutVersion(component.id));
-    const autoTaggedCount = autoTaggedResults ? autoTaggedResults.length : 0;
-
-    const warningsOutput = warnings && warnings.length ? `${chalk.yellow(warnings.join('\n'))}\n\n` : '';
-    const tagExplanationPersist = `\n(use "bit export [collection]" to push these components to a remote")
-(use "bit untag" to unstage versions)\n`;
-    const tagExplanationSoft = `\n(use "bit tag --persist" to persist the changes")
-(use "bit untag --soft" to remove the soft-tags)\n`;
-
-    const tagExplanation = results.isSoftTag ? tagExplanationSoft : tagExplanationPersist;
-
-    const outputComponents = (comps) => {
-      return comps
-        .map((component) => {
-          let componentOutput = `     > ${component.id.toString()}`;
-          const autoTag = autoTaggedResults.filter((result) =>
-            result.triggeredBy.searchWithoutScopeAndVersion(component.id)
-          );
-          if (autoTag.length) {
-            const autoTagComp = autoTag.map((a) => a.component.id.toString());
-            componentOutput += `\n       ${AUTO_TAGGED_MSG}:
-            ${autoTagComp.join('\n            ')}`;
-          }
-          return componentOutput;
-        })
-        .join('\n');
-    };
-
-    const publishOutput = () => {
-      const { publishedPackages } = results;
-      if (!publishedPackages || !publishedPackages.length) return '';
-      const successTitle = `\n\n${chalk.green(
-        `published the following ${publishedPackages.length} component(s) successfully\n`
-      )}`;
-      const successCompsStr = publishedPackages.join('\n');
-      const successOutput = successCompsStr ? successTitle + successCompsStr : '';
-      return successOutput;
-    };
-
-    const softTagPrefix = results.isSoftTag ? 'soft-tagged ' : '';
-    const outputIfExists = (label, explanation, components) => {
-      if (!components.length) return '';
-      return `\n${chalk.underline(softTagPrefix + label)}\n(${explanation})\n${outputComponents(components)}\n`;
-    };
-
-    const newDesc = results.isSoftTag
-      ? 'set to be tagged first version for components'
-      : 'first version for components';
-    const changedDesc = results.isSoftTag
-      ? 'components that set to get a version bump'
-      : 'components that got a version bump';
-    const softTagClarification = results.isSoftTag
-      ? chalk.bold(
-          'keep in mind that this is a soft-tag (changes recorded to be tagged), to persist the changes use --persist flag'
-        )
-      : '';
-    return (
-      warningsOutput +
-      chalk.green(
-        `${taggedComponents.length + autoTaggedCount} component(s) ${results.isSoftTag ? 'soft-' : ''}tagged`
-      ) +
-      tagExplanation +
-      outputIfExists('new components', newDesc, addedComponents) +
-      outputIfExists('changed components', changedDesc, changedComponents) +
-      publishOutput() +
-      softTagClarification
-    );
-  }
-}

package/tsconfig.json

@@ -1,34 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
-    ],
-    "target": "es2015",
-    "module": "commonjs",
-    "jsx": "react",
-    "declaration": true,
-    "sourceMap": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "composite": true,
-    "emitDeclarationOnly": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "rootDir": ".",
-    "preserveConstEnums": true,
-    "resolveJsonModule": true
-  },
-  "exclude": [
-    "dist"
-  ]
-}

package/types/asset.d.ts

@@ -1,29 +0,0 @@
-declare module '*.png' {
-  const value: any;
-  export = value;
-}
-declare module '*.svg' {
-  import type { FunctionComponent, SVGProps } from 'react';
-
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
-  const src: string;
-  export default src;
-}
-
-// @TODO Gilad
-declare module '*.jpg' {
-  const value: any;
-  export = value;
-}
-declare module '*.jpeg' {
-  const value: any;
-  export = value;
-}
-declare module '*.gif' {
-  const value: any;
-  export = value;
-}
-declare module '*.bmp' {
-  const value: any;
-  export = value;
-}

package/types/style.d.ts

@@ -1,42 +0,0 @@
-declare module '*.module.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-declare module '*.module.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.module.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.less' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.css' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.sass' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.scss' {
-  const classes: { readonly [key: string]: string };
-  export default classes;
-}
-
-declare module '*.mdx' {
-  const component: any;
-  export default component;
-}

package/types.ts

@@ -1,40 +0,0 @@
-interface VendorConfig {
-  directory: string;
-}
-
-export interface WorkspaceExtConfig {
-  /**
-   * name of the workspace.
-   */
-  name: string;
-
-  /**
-   * path to icon.
-   */
-  icon: string;
-
-  /**
-   * applies only on bit.dev. configure the main owner of your workspace
-   */
-  defaultOwner: string;
-
-  /**
-   * set the default scope when there is no matching for the component in the components array.
-   */
-  defaultScope: string;
-
-  /**
-   * set the default directory when there is no matching for the component in the components array.
-   */
-  defaultDirectory: string;
-
-  /**
-   * set the default structure of components in your project
-   */
-  vendor: VendorConfig;
-
-  /**
-   * All component extensions applied by default on all components in the workspace (except vendor components)
-   */
-  extensions: { [extensionsId: string]: string };
-}

package/ui/index.ts

@@ -1 +0,0 @@
-export { Workspace } from './workspace';

package/ui/workspace/default-component.ts

@@ -1,7 +0,0 @@
-export const defaultComponent = {
-  id: '',
-  server: {
-    url: '',
-    env: '',
-  },
-};

package/ui/workspace/index.ts

@@ -1 +0,0 @@
-export * from './workspace';

package/ui/workspace/use-workspace.ts

@@ -1,193 +0,0 @@
-import { useEffect, useMemo } from 'react';
-import { ComponentModel } from '@teambit/component';
-import useLatest from '@react-hook/latest';
-import { useDataQuery } from '@teambit/ui-foundation.ui.hooks.use-data-query';
-import { gql } from '@apollo/client';
-import { ComponentID, ComponentIdObj } from '@teambit/component-id';
-
-import { Workspace } from './workspace-model';
-
-type UseWorkspaceOptions = {
-  onComponentAdded?: (component: ComponentModel[]) => void;
-  onComponentUpdated?: (component: ComponentModel[]) => void;
-  onComponentRemoved?: (compId: ComponentID[]) => void;
-};
-type RawComponent = { id: ComponentIdObj };
-
-const wcComponentFields = gql`
-  fragment wcComponentFields on Component {
-    id {
-      name
-      version
-      scope
-    }
-    compositions {
-      identifier
-    }
-    description
-    issuesCount
-    status {
-      isOutdated
-      isNew
-      isInScope
-      isStaged
-      modifyInfo {
-        hasModifiedFiles
-        hasModifiedDependencies
-      }
-      isDeleted
-    }
-    deprecation {
-      isDeprecate
-    }
-    server {
-      env
-      url
-    }
-    env {
-      id
-      icon
-    }
-  }
-`;
-
-const WORKSPACE = gql`
-  query workspace {
-    workspace {
-      name
-      path
-      icon
-      components {
-        ...wcComponentFields
-      }
-    }
-  }
-  ${wcComponentFields}
-`;
-
-const COMPONENT_SUBSCRIPTION_ADDED = gql`
-  subscription OnComponentAdded {
-    componentAdded {
-      component {
-        ...wcComponentFields
-      }
-    }
-  }
-  ${wcComponentFields}
-`;
-
-const COMPONENT_SUBSCRIPTION_CHANGED = gql`
-  subscription OnComponentChanged {
-    componentChanged {
-      component {
-        ...wcComponentFields
-      }
-    }
-  }
-  ${wcComponentFields}
-`;
-
-const COMPONENT_SUBSCRIPTION_REMOVED = gql`
-  subscription OnComponentRemoved {
-    componentRemoved {
-      componentIds {
-        name
-        version
-        scope
-      }
-    }
-  }
-`;
-
-export function useWorkspace(options: UseWorkspaceOptions = {}) {
-  const { data, subscribeToMore, ...rest } = useDataQuery(WORKSPACE);
-  const optionsRef = useLatest(options);
-
-  useEffect(() => {
-    const unSubCompAddition = subscribeToMore({
-      document: COMPONENT_SUBSCRIPTION_ADDED,
-      updateQuery: (prev, { subscriptionData }) => {
-        const update = subscriptionData.data;
-        const addedComponent = update?.componentAdded?.component;
-        if (!addedComponent) return prev;
-
-        const componentExists = prev.workspace.components.find((component: any) =>
-          ComponentID.isEqualObj(component.id, addedComponent.id, { ignoreVersion: true })
-        );
-        if (componentExists) return prev;
-
-        // side effect - trigger observers
-        setTimeout(() => optionsRef.current.onComponentAdded?.([ComponentModel.from(addedComponent)]));
-
-        return {
-          ...prev,
-          workspace: {
-            ...prev.workspace,
-            components: [...prev.workspace.components, addedComponent],
-          },
-        };
-      },
-    });
-
-    const unSubCompChange = subscribeToMore({
-      document: COMPONENT_SUBSCRIPTION_CHANGED,
-      updateQuery: (prev, { subscriptionData }) => {
-        const update = subscriptionData.data;
-        if (!update) return prev;
-
-        const updatedComponent = update.componentChanged.component;
-        // side effect - trigger observers
-        setTimeout(() => optionsRef.current.onComponentUpdated?.([ComponentModel.from(updatedComponent)]));
-
-        return {
-          ...prev,
-          workspace: {
-            ...prev.workspace,
-            components: prev.workspace.components.map((component) =>
-              component.id.name === updatedComponent.id.name ? updatedComponent : component
-            ),
-          },
-        };
-      },
-    });
-
-    const unSubCompRemoved = subscribeToMore({
-      document: COMPONENT_SUBSCRIPTION_REMOVED,
-      updateQuery: (prev, { subscriptionData }) => {
-        const idsToRemove: ComponentIdObj[] | undefined = subscriptionData.data?.componentRemoved?.componentIds;
-        if (!idsToRemove || idsToRemove.length === 0) return prev;
-
-        // side effect - trigger observers
-        setTimeout(() => optionsRef.current.onComponentRemoved?.(idsToRemove.map((id) => ComponentID.fromObject(id))));
-
-        return {
-          ...prev,
-          workspace: {
-            ...prev.workspace,
-            components: prev.workspace.components.filter((component: RawComponent) =>
-              idsToRemove.every((id) => !ComponentID.isEqualObj(id, component.id))
-            ),
-          },
-        };
-      },
-    });
-
-    // TODO - sub to component removal
-
-    return () => {
-      unSubCompAddition();
-      unSubCompChange();
-      unSubCompRemoved();
-    };
-  }, [optionsRef]);
-
-  const workspace = useMemo(() => {
-    return data?.workspace ? Workspace.from(data?.workspace) : undefined;
-  }, [data?.workspace]);
-
-  return {
-    workspace,
-    subscribeToMore,
-    ...rest,
-  };
-}

package/ui/workspace/workspace-context.tsx

@@ -1,5 +0,0 @@
-import { createContext } from 'react';
-
-import { Workspace as WorkspaceModel } from './workspace-model';
-
-export const WorkspaceContext: React.Context<WorkspaceModel> = createContext<WorkspaceModel>(WorkspaceModel.empty());

package/ui/workspace/workspace-model.ts

@@ -1,66 +0,0 @@
-// import { ComponentMeta } from '@teambit/component';
-import { ComponentID, ComponentModel, ComponentModelProps } from '@teambit/component';
-import { DeprecationInfo } from '@teambit/deprecation';
-import { Descriptor } from '@teambit/envs';
-
-import { ComponentStatus } from '../../workspace-component/component-status';
-
-export type WorkspaceModelComponent = {
-  id: ComponentID;
-  status: ComponentStatus;
-  deprecation: DeprecationInfo;
-  env: Descriptor;
-};
-
-export type WorkspaceProps = {
-  name: string;
-  path: string;
-  components: ComponentModelProps[];
-  icon: string;
-};
-
-export class Workspace {
-  constructor(
-    /**
-     * name of the workspace.
-     */
-    readonly name: string,
-
-    /**
-     * absolute path of the workspace.
-     */
-    readonly path: string,
-
-    /**
-     * icon of the workspace.
-     */
-    readonly icon: string,
-
-    /**
-     * components container in the workspace.
-     */
-    readonly components: ComponentModel[]
-  ) {}
-
-  /**
-   * return a component from the workspace.
-   */
-  getComponent(id: ComponentID) {
-    return this.components.find((component) => component.id.fullName === id.fullName);
-  }
-
-  static from({ name, path, components, icon }: WorkspaceProps) {
-    return new Workspace(
-      name,
-      path,
-      icon,
-      components.map((value) => {
-        return ComponentModel.from(value);
-      })
-    );
-  }
-
-  static empty() {
-    return new Workspace('', '', '', []);
-  }
-}

package/ui/workspace/workspace-overview/index.ts

@@ -1 +0,0 @@
-export { WorkspaceOverview } from './workspace-overview';

package/ui/workspace/workspace-overview/workspace-overview.module.scss

@@ -1,6 +0,0 @@
-.container {
-  padding: 80px 5% 150px 5%;
-  overflow-y: auto;
-  height: 100%;
-  box-sizing: border-box;
-}