@teambit/workspace 1.0.106 → 1.0.108

package/filter.ts

@@ -0,0 +1,139 @@
+import { ComponentID, ComponentIdList } from '@teambit/component-id';
+import pMapSeries from 'p-map-series';
+import { ModelComponent } from '@teambit/legacy/dist/scope/models';
+import { compact } from 'lodash';
+import { Workspace } from './workspace';
+
+export const statesFilter = [
+  'new',
+  'modified',
+  'deprecated',
+  'deleted',
+  'snappedOnMain',
+  'softTagged',
+  'codeModified',
+] as const;
+export type StatesFilter = typeof statesFilter[number];
+
+export class Filter {
+  constructor(private workspace: Workspace) {}
+
+  async by(criteria: StatesFilter | string, ids: ComponentID[]): Promise<ComponentID[]> {
+    return criteria.includes(':') ? this.byMultiParamState(criteria, ids) : this.byState(criteria as StatesFilter, ids);
+  }
+
+  async byState(state: StatesFilter, ids: ComponentID[]): Promise<ComponentID[]> {
+    const statePerMethod = {
+      new: this.byNew,
+      modified: this.byModified,
+      deprecated: this.byDeprecated,
+      deleted: this.byDeleted,
+      snappedOnMain: this.bySnappedOnMain,
+      softTagged: this.bySoftTagged,
+      codeModified: this.byCodeModified,
+    };
+    if (!statePerMethod[state]) {
+      throw new Error(`state ${state} is not recognized, possible values: ${statesFilter.join(', ')}`);
+    }
+    return statePerMethod[state].bind(this)(ids);
+  }
+
+  async byMultiParamState(state: string, ids: ComponentID[]): Promise<ComponentID[]> {
+    const stateSplit = state.split(':');
+    if (stateSplit.length < 2) {
+      throw new Error(`byMultiParamState expect the state to have at least one param after the colon, got ${state}`);
+    }
+    const [stateName, ...stateParams] = stateSplit;
+    if (stateName === 'env') {
+      return this.byEnv(stateParams[0], ids);
+    }
+    throw new Error(`byMultiParamState expect the state to be one of the following: ['env'], got ${stateName}`);
+  }
+
+  async byEnv(env: string, withinIds?: ComponentID[]): Promise<ComponentID[]> {
+    const ids = withinIds || (await this.workspace.listIds());
+    const comps = await this.workspace.getMany(ids);
+    const compsUsingEnv = comps.filter((c) => {
+      const envId = this.workspace.envs.getEnvId(c);
+      const envIdWithoutVer = ComponentID.getStringWithoutVersion(envId);
+      return envIdWithoutVer === env;
+    });
+    return compsUsingEnv.map((c) => c.id);
+  }
+
+  async byModified(withinIds?: ComponentID[]): Promise<ComponentID[]> {
+    const ids = withinIds || (await this.workspace.listIds());
+    const comps = await this.workspace.getMany(ids);
+    const modifiedIds = await Promise.all(comps.map(async (comp) => ((await comp.isModified()) ? comp.id : undefined)));
+    return compact(modifiedIds);
+  }
+
+  async byCodeModified(withinIds?: ComponentID[]): Promise<ComponentID[]> {
+    const ids = withinIds || (await this.workspace.listIds());
+    const compFiles = await pMapSeries(ids, (id) => this.workspace.getFilesModification(id));
+    const modifiedIds = compFiles.filter((c) => c.isModified()).map((c) => c.id);
+    return compact(modifiedIds);
+  }
+
+  async byNew(withinIds?: ComponentID[]): Promise<ComponentID[]> {
+    const ids = withinIds || (await this.workspace.listIds());
+    return ids.filter((id) => !id.hasVersion());
+  }
+
+  async byDeprecated(withinIds?: ComponentID[]) {
+    const ids = withinIds || (await this.workspace.listIds());
+    const comps = await this.workspace.getMany(ids);
+    const results = await Promise.all(
+      comps.map(async (c) => {
+        const modelComponent = await this.workspace.consumer.scope.getModelComponentIfExist(c.id);
+        const deprecated = await modelComponent?.isDeprecated(this.workspace.consumer.scope.objects);
+        return deprecated ? c.id : null;
+      })
+    );
+    return compact(results);
+  }
+
+  async byDeleted(withinIds?: ComponentID[]) {
+    const ids = withinIds || (await this.workspace.listIds());
+    const comps = await this.workspace.getMany(ids);
+    const deletedIds = comps.filter((c) => c.isDeleted()).map((c) => c.id);
+    return compact(deletedIds);
+  }
+
+  byDuringMergeState(): ComponentIdList {
+    const unmergedComponents = this.workspace.scope.legacyScope.objects.unmergedComponents.getComponents();
+    return ComponentIdList.fromArray(unmergedComponents.map((u) => ComponentID.fromObject(u.id)));
+  }
+
+  /**
+   * list components that their head is a snap, not a tag.
+   * this is relevant only when the lane is the default (main), otherwise, the head is always a snap.
+   * components that are during-merge are filtered out, we don't want them during tag and don't want
+   * to show them in the "snapped" section in bit-status.
+   */
+  async bySnappedOnMain(withinIds?: ComponentID[]) {
+    if (!this.workspace.isOnMain()) {
+      return [];
+    }
+    const ids = withinIds || (await this.workspace.listIds());
+    const compIds = ComponentIdList.fromArray(ids);
+    const componentsFromModel = await this.getModelComps(ids);
+    const compsDuringMerge = this.byDuringMergeState();
+    const comps = componentsFromModel
+      .filter((c) => compIds.hasWithoutVersion(c.toComponentId()))
+      .filter((c) => !compsDuringMerge.hasWithoutVersion(c.toComponentId()))
+      .filter((c) => c.isHeadSnap());
+    return comps.map((c) => c.toComponentIdWithHead());
+  }
+
+  bySoftTagged(withinIds?: ComponentID[]): ComponentID[] {
+    const withCompIds = ComponentIdList.fromArray(withinIds || []);
+    const all = this.workspace.consumer.bitMap.components.filter((c) => c.nextVersion).map((c) => c.id);
+    return withinIds ? all.filter((id) => withCompIds.hasWithoutVersion(id)) : all;
+  }
+
+  private async getModelComps(ids: ComponentID[]): Promise<ModelComponent[]> {
+    const comps = await Promise.all(ids.map((id) => this.workspace.scope.getBitObjectModelComponent(id, false)));
+    return compact(comps);
+  }
+}

package/index.ts

@@ -0,0 +1,22 @@
+import { WorkspaceAspect } from './workspace.aspect';
+// eslint-disable-next-line import/prefer-default-export
+export type { default as Workspace, ExtensionsOrigin } 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 * from './events';
+export type { WorkspaceUI } from './workspace.ui.runtime';
+export type { SerializableResults, OnComponentLoad, OnComponentEventResult } from './on-component-events';
+export { ComponentStatus } from './workspace-component';
+export type { WorkspaceModelComponent } from './ui/workspace/workspace-model';
+export { Workspace as WorkspaceModel } from './ui/workspace/workspace-model';
+export { WorkspaceContext } from './ui/workspace/workspace-context';
+export { OutsideWorkspaceError } from './exceptions/outside-workspace';
+export type { WorkspaceComponent } from './workspace-component';
+export type { ComponentConfigFile } from './component-config-file';
+export type { CompFiles, FilesStatus } from './workspace-component/comp-files';
+export type { MergeOptions as BitmapMergeOptions } from './bit-map';
+export type { WorkspaceExtConfig } from './types';
+export { WorkspaceAspect };
+export default WorkspaceAspect;

package/merge-conflict-file.ts

@@ -0,0 +1,129 @@
+import { MergeConfigFilename } from '@teambit/legacy/dist/constants';
+import path from 'path';
+import fs from 'fs-extra';
+import { MergeConfigConflict } from './exceptions/merge-config-conflict';
+
+const idPrefix = `[*]`;
+const idDivider = '-'.repeat(80);
+type ConflictPerId = { [compIdWithoutVersion: string]: string };
+
+export class MergeConflictFile {
+  conflictPerId: ConflictPerId | undefined;
+  constructor(private workspacePath: string) {}
+
+  addConflict(id: string, conflict: string) {
+    if (!this.conflictPerId) this.conflictPerId = {};
+    this.conflictPerId[id] = conflict;
+  }
+
+  removeConflict(id: string) {
+    delete this.conflictPerId?.[id];
+  }
+
+  async getConflict(id: string): Promise<string | undefined> {
+    await this.loadIfNeeded();
+    if (!this.conflictPerId) throw new Error(`this.conflictPerId must be instantiated after load`);
+    return this.conflictPerId[id];
+  }
+
+  getConflictAssumeIsLoaded(id: string): string | undefined {
+    if (!this.conflictPerId)
+      throw new Error(`MergeConflictFile was not loaded yet, please load it before calling this function`);
+    return this.conflictPerId[id];
+  }
+
+  getConflictParsed(id: string): Record<string, any> | undefined {
+    const configMergeContent = this.getConflictAssumeIsLoaded(id);
+    if (!configMergeContent) return undefined;
+    try {
+      return JSON.parse(configMergeContent);
+    } catch (err: any) {
+      if (this.stringHasConflictMarker(configMergeContent)) {
+        throw new MergeConfigConflict(this.getPath());
+      }
+      throw new Error(`unable to parse the merge-conflict entry for ${id} as the JSON is invalid. err: ${err.message}`);
+    }
+  }
+
+  hasConflict(): boolean {
+    return Boolean(this.conflictPerId && Object.keys(this.conflictPerId).length);
+  }
+
+  getPath() {
+    return path.join(this.workspacePath, MergeConfigFilename);
+  }
+
+  async loadIfNeeded() {
+    if (this.conflictPerId) return; // already loaded
+    const fileContent = await this.getFileContentIfExists();
+    if (!fileContent) {
+      this.conflictPerId = {}; // to indicate that it's loaded
+      return;
+    }
+    const parsedConflict = this.parseConflict(fileContent);
+    this.conflictPerId = parsedConflict;
+  }
+
+  async write() {
+    if (!this.hasConflict()) return;
+    const afterFormat = this.formatConflicts();
+    await fs.writeFile(this.getPath(), afterFormat);
+  }
+
+  async delete() {
+    await fs.remove(this.getPath());
+  }
+
+  private formatConflicts(): string {
+    const conflictPerId = this.conflictPerId;
+    if (!conflictPerId) throw new Error('conflictPerId is not populated');
+    const title = `# Resolve configuration conflicts per component and make sure the Component ID remain in place`;
+    const conflicts = Object.keys(conflictPerId)
+      .map((id) => {
+        const conflict = conflictPerId[id];
+        return `${idDivider}
+${idPrefix} ${id}
+${idDivider}
+${conflict}`;
+      })
+      .join('\n\n');
+    return `${title}\n\n${conflicts}`;
+  }
+
+  private stringHasConflictMarker(str: string): boolean {
+    return str.includes('<<<<<<<') || str.includes('>>>>>>>');
+  }
+
+  private parseConflict(conflict: string): ConflictPerId {
+    // remove irrelevant lines
+    conflict = conflict
+      .split('\n')
+      .filter((line) => line !== idDivider && !line.startsWith('#'))
+      .join('\n');
+    // split by id
+    const conflictPerId: ConflictPerId = {};
+    const split = conflict.split(idPrefix);
+    split.forEach((conflictItem) => {
+      const conflictItemSplit = conflictItem.split('\n');
+      const [rawId, ...conflictStr] = conflictItemSplit;
+      const id = rawId.trim();
+      if (!id) return; // first line has it empty
+      conflictPerId[id] = conflictStr.join('\n');
+    });
+    return conflictPerId;
+  }
+
+  private async getFileContentIfExists(): Promise<string | undefined> {
+    const filePath = this.getPath();
+    let fileContent: string;
+    try {
+      fileContent = await fs.readFile(filePath, 'utf-8');
+    } catch (err: any) {
+      if (err.code === 'ENOENT') {
+        return undefined;
+      }
+      throw err;
+    }
+    return fileContent;
+  }
+}

package/on-component-events.ts

@@ -0,0 +1,24 @@
+import { Component, ComponentID, AspectData } from '@teambit/component';
+import { ComponentLoadOptions } from '@teambit/legacy/dist/consumer/component/component-loader';
+import type { PathOsBasedAbsolute } from '@teambit/legacy/dist/utils/path';
+import { WatchOptions } from '@teambit/watcher';
+
+export type SerializableResults = { results: any; toString: () => string };
+export type OnComponentChange = (
+  component: Component,
+  files: PathOsBasedAbsolute[],
+  removedFiles: PathOsBasedAbsolute[],
+  watchOpts: WatchOptions
+) => Promise<SerializableResults | void>;
+export type OnComponentAdd = (
+  component: Component,
+  files: string[],
+  watchOpts: WatchOptions
+) => Promise<SerializableResults | void>;
+export type OnComponentRemove = (componentId: ComponentID) => Promise<SerializableResults>;
+export type OnComponentEventResult = { extensionId: string; results: SerializableResults };
+
+export type OnComponentLoad = (
+  component: Component,
+  loadOpts?: ComponentLoadOptions
+) => Promise<AspectData | undefined>;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace",
-  "version": "1.0.106",
+  "version": "1.0.108",
   "homepage": "https://bit.cloud/teambit/workspace/workspace",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace",
-    "version": "1.0.106"
+    "version": "1.0.108"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -25,8 +25,6 @@
     "classnames": "2.2.6",
     "pluralize": "8.0.0",
     "reset-css": "5.0.1",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/component-id": "1.2.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
@@ -34,8 +32,8 @@
     "@teambit/graph.cleargraph": "0.0.1",
     "@teambit/component.ui.component-status-resolver": "0.0.510",
     "@teambit/component-version": "1.0.3",
-    "@teambit/dependencies.modules.packages-excluder": "1.0.8",
     "@teambit/legacy-bit-id": "1.1.0",
+    "@teambit/dependencies.modules.packages-excluder": "1.0.8",
     "@teambit/design.ui.tree": "0.0.15",
     "@teambit/lanes.hooks.use-lane-components": "0.0.253",
     "@teambit/lanes.hooks.use-lanes": "0.0.254",
@@ -61,58 +59,56 @@
     "@teambit/explorer.ui.gallery.component-grid": "0.0.496",
     "@teambit/workspace.ui.empty-workspace": "0.0.508",
     "@teambit/workspace.ui.workspace-component-card": "0.0.516",
-    "@teambit/component": "1.0.106",
-    "@teambit/dependency-resolver": "1.0.106",
-    "@teambit/envs": "1.0.106",
-    "@teambit/logger": "0.0.932",
-    "@teambit/scope": "1.0.106",
-    "@teambit/graph": "1.0.106",
-    "@teambit/cli": "0.0.839",
-    "@teambit/isolator": "1.0.106",
-    "@teambit/component-tree": "1.0.106",
+    "@teambit/component": "1.0.108",
+    "@teambit/dependency-resolver": "1.0.108",
+    "@teambit/envs": "1.0.108",
+    "@teambit/logger": "0.0.933",
+    "@teambit/scope": "1.0.108",
+    "@teambit/graph": "1.0.108",
+    "@teambit/cli": "0.0.840",
+    "@teambit/isolator": "1.0.108",
+    "@teambit/component-tree": "1.0.108",
     "@teambit/harmony.modules.resolved-component": "0.0.495",
-    "@teambit/watcher": "1.0.106",
-    "@teambit/aspect-loader": "1.0.106",
-    "@teambit/config": "0.0.857",
-    "@teambit/global-config": "0.0.841",
+    "@teambit/watcher": "1.0.108",
+    "@teambit/aspect-loader": "1.0.108",
+    "@teambit/config": "0.0.859",
+    "@teambit/global-config": "0.0.842",
     "@teambit/harmony.modules.requireable-component": "0.0.495",
     "@teambit/toolbox.modules.module-resolver": "0.0.5",
-    "@teambit/workspace.modules.node-modules-linker": "0.0.157",
-    "@teambit/graphql": "1.0.106",
-    "@teambit/bundler": "1.0.106",
-    "@teambit/pubsub": "1.0.106",
-    "@teambit/ui": "1.0.106",
-    "@teambit/variants": "0.0.950",
-    "@teambit/component-issues": "0.0.137",
+    "@teambit/workspace.modules.node-modules-linker": "0.0.158",
+    "@teambit/graphql": "1.0.108",
+    "@teambit/bundler": "1.0.108",
+    "@teambit/pubsub": "1.0.108",
+    "@teambit/ui": "1.0.108",
+    "@teambit/variants": "0.0.952",
+    "@teambit/component-issues": "0.0.138",
     "@teambit/workspace.modules.match-pattern": "0.0.502",
-    "@teambit/component.ui.component-drawer": "0.0.380",
-    "@teambit/command-bar": "1.0.106",
-    "@teambit/sidebar": "1.0.106",
-    "@teambit/component-descriptor": "0.0.407",
-    "@teambit/deprecation": "1.0.106"
+    "@teambit/component.ui.component-drawer": "0.0.381",
+    "@teambit/command-bar": "1.0.108",
+    "@teambit/sidebar": "1.0.108",
+    "@teambit/component-descriptor": "0.0.408",
+    "@teambit/deprecation": "1.0.108"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
     "@types/lodash.compact": "3.0.6",
-    "@types/react": "^17.0.8",
     "@types/fs-extra": "9.0.7",
     "@types/find-root": "1.1.2",
     "@types/memoizee": "0.4.5",
     "@types/classnames": "2.2.11",
     "@types/pluralize": "0.0.29",
     "@types/mocha": "9.1.0",
-    "@types/node": "12.20.4",
-    "@types/react-dom": "^17.0.5",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5",
-    "@teambit/workspace.content.workspace-overview": "1.95.0"
+    "@types/jest": "^29.2.2",
+    "@types/testing-library__jest-dom": "^5.9.5",
+    "@teambit/workspace.content.workspace-overview": "1.95.0",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
   },
   "peerDependencies": {
     "@apollo/client": "^3.6.0",
-    "react-router-dom": "^6.0.0",
-    "@teambit/legacy": "1.0.624",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "react": "^17.0.0 || ^18.0.0",
+    "react-router-dom": "^6.8.1",
+    "@types/react": "^18.2.12",
+    "@teambit/legacy": "1.0.624"
   },
   "license": "Apache-2.0",
   "optionalDependencies": {},
@@ -126,7 +122,7 @@
   },
   "private": false,
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -135,12 +131,9 @@
   "keywords": [
     "bit",
     "bit-aspect",
+    "bit-core-aspect",
     "components",
     "collaboration",
-    "web",
-    "react",
-    "react-components",
-    "angular",
-    "angular-components"
+    "web"
   ]
 }

package/pattern.cmd.ts

@@ -0,0 +1,53 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import chalk from 'chalk';
+import { Workspace } from './workspace';
+import { statesFilter } from './filter';
+
+export class PatternCommand implements Command {
+  name = 'pattern <pattern>';
+  alias = '';
+  description = 'list the component ids matching the given pattern';
+  extendedDescription = `this command helps validating a pattern before using it in other commands.
+NOTE: always wrap the pattern with quotes to avoid collision with shell commands. depending on your shell, it might be single or double quotes.
+a pattern can be a simple component-id or component-name. e.g. 'ui/button'.
+a pattern can be used with wildcards for multiple component ids, e.g. 'org.scope/utils/**' or '**/utils/**' to capture all org/scopes.
+to enter multiple patterns, separate them by a comma, e.g. 'ui/*, lib/*'
+to exclude, use '!'. e.g. 'ui/**, !ui/button'
+the matching algorithm is from multimatch (@see https://github.com/sindresorhus/multimatch).
+
+to filter by a state or attribute, prefix the pattern with "$". e.g. '$deprecated', '$modified'.
+list of supported states: [${statesFilter.join(', ')}].
+to filter by multi-params state/attribute, separate the params with ":", e.g. '$env:teambit.react/react'.
+list of supported multi-params states: [env].
+to match a state and another criteria, use " AND " keyword. e.g. '$modified AND teambit.workspace/**'. note that the state must be first.
+`;
+  examples = [
+    { cmd: "bit pattern '**'", description: 'matches all components' },
+    {
+      cmd: "bit pattern '*/ui/*'",
+      description:
+        'matches components with any scope-name and the "ui" namespace. e.g. "ui/button" but not "ui/elements/button"',
+    },
+    {
+      cmd: "bit pattern '*/ui/**'",
+      description: 'matches components whose namespace starts with "ui/" e.g. "ui/button", "ui/elements/button"',
+    },
+    { cmd: "bit pattern 'bar, foo'", description: 'matches two components: bar and foo' },
+    { cmd: "bit pattern 'my-scope.org/**'", description: 'matches all components of the scope "my-scope.org"' },
+  ];
+  group = 'development';
+  private = false;
+  options = [['j', 'json', 'return the output as JSON']] as CommandOptions;
+
+  constructor(private workspace: Workspace) {}
+
+  async report([pattern]: [string]) {
+    const ids = await this.json([pattern]);
+    const title = chalk.green(`found ${chalk.bold(ids.length.toString())} components matching the pattern`);
+    return `${title}\n${ids.join('\n')}`;
+  }
+
+  async json([pattern]: [string]) {
+    return this.workspace.idsByPattern(pattern, false);
+  }
+}

package/tsconfig.json

@@ -1,38 +1,33 @@
 {
   "compilerOptions": {
     "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
+      "esnext",
+      "dom",
+      "dom.Iterable"
     ],
-    "target": "es2015",
-    "module": "CommonJS",
-    "jsx": "react",
-    "allowJs": true,
-    "composite": true,
+    "target": "es2020",
+    "module": "es2020",
+    "jsx": "react-jsx",
     "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
-    "outDir": "dist",
+    "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "rootDir": ".",
     "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "preserveConstEnums": true
+    "allowJs": true,
+    "outDir": "dist",
+    "emitDeclarationOnly": true
   },
   "exclude": [
+    "artifacts",
+    "public",
     "dist",
+    "node_modules",
+    "package.json",
     "esm.mjs",
-    "package.json"
+    "**/*.cjs",
+    "./dist"
   ],
   "include": [
     "**/*",

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}