@teambit/isolator 0.0.551 → 0.0.556

package/dist/capsule/capsule.d.ts

@@ -4,13 +4,44 @@ import { Component } from '@teambit/component';
 import FsContainer, { BitExecOption } from './container';
 import ContainerExec from './container-exec';
 export default class Capsule extends CapsuleTemplate<Exec, NodeFS> {
+    /**
+     * container implementation the capsule is being executed within.
+     */
     protected container: FsContainer;
+    /**
+     * the capsule's file system.
+     */
     readonly fs: NodeFS;
+    /**
+     * console for controlling process streams as stdout, stdin and stderr.
+     */
     readonly console: Console;
+    /**
+     * capsule's state.
+     */
     readonly state: State;
     readonly component: Component;
     private _wrkDir;
-    constructor(container: FsContainer, fs: NodeFS, console: Console, state: State, component: Component);
+    constructor(
+    /**
+     * container implementation the capsule is being executed within.
+     */
+    container: FsContainer, 
+    /**
+     * the capsule's file system.
+     */
+    fs: NodeFS, 
+    /**
+     * console for controlling process streams as stdout, stdin and stderr.
+     */
+    console: Console, 
+    /**
+     * capsule's state.
+     */
+    state: State, component: Component);
+    /**
+     * @deprecated please use `this.path`
+     */
     get wrkDir(): string;
     get path(): string;
     start(): Promise<any>;
@@ -20,6 +51,13 @@ export default class Capsule extends CapsuleTemplate<Exec, NodeFS> {
     removePath(dir: string): Promise<any>;
     symlink(src: string, dest: string): Promise<any>;
     execute(cmd: string, options?: Record<string, any> | null | undefined): Promise<unknown>;
+    /**
+     * @todo: fix.
+     * it skips the capsule fs because for some reason `capsule.fs.promises.readdir` doesn't work
+     * the same as `capsule.fs.readdir` and it doesn't have the capsule dir as pwd.
+     *
+     * returns the paths inside the capsule
+     */
     getAllFilesPaths(dir?: string, options?: {
         ignore?: string[];
     }): any;

package/dist/isolator.main.runtime.d.ts

@@ -19,21 +19,60 @@ export declare type IsolateComponentsInstallOptions = {
     installTeambitBit?: boolean;
 };
 declare type CreateGraphOptions = {
+    /**
+     * include components that exists in nested hosts. for example include components that exist in scope but not in the workspace
+     */
     includeFromNestedHosts?: boolean;
+    /**
+     * Force specific host to get the component from.
+     */
     host?: ComponentFactory;
 };
 export declare type IsolateComponentsOptions = CreateGraphOptions & {
     name?: string;
+    /**
+     * absolute path to put all the capsules dirs inside.
+     */
     rootBaseDir?: string;
+    /**
+     * the capsule root-dir based on a *hash* of this baseDir, not on the baseDir itself.
+     * A folder with this hash as its name will be created in the rootBaseDir
+     * By default this value will be the host path
+     */
     baseDir?: string;
+    /**
+     * create a new capsule with a random string attached to the path suffix
+     */
     alwaysNew?: boolean;
+    /**
+     * installation options
+     */
     installOptions?: IsolateComponentsInstallOptions;
     linkingOptions?: LinkingOptions;
+    /**
+     * delete the capsule rootDir first. it makes sure that the isolation process starts fresh with
+     * no previous capsules. for build and tag this is true.
+     */
     emptyRootDir?: boolean;
+    /**
+     * skip the reproduction of the capsule in case it exists.
+     */
     skipIfExists?: boolean;
+    /**
+     * get existing capsule without doing any changes, no writes, no installations.
+     */
     getExistingAsIs?: boolean;
+    /**
+     * place the package-manager cache on the capsule-root
+     */
     cachePackagesOnCapsulesRoot?: boolean;
+    /**
+     * do not build graph with all dependencies. isolate the seeders only.
+     */
     seedersOnly?: boolean;
+    /**
+     * Force specific host to get the component from.
+     */
     host?: ComponentFactory;
 };
 export declare class IsolatorMain {
@@ -58,6 +97,13 @@ export declare class IsolatorMain {
     constructor(dependencyResolver: DependencyResolverMain, logger: Logger, componentAspect: ComponentMain, graphBuilder: GraphBuilder, globalConfig: GlobalConfigMain);
     isolateComponents(seeders: ComponentID[], opts?: IsolateComponentsOptions, legacyScope?: LegacyScope): Promise<Network>;
     private createGraph;
+    /**
+     * Create capsules for the provided components
+     * do not use this outside directly, use isolate components which build the entire network
+     * @param components
+     * @param opts
+     * @param legacyScope
+     */
     private createCapsules;
     private installInCapsules;
     private linkInCapsules;

package/dist/network.d.ts

@@ -6,7 +6,14 @@ export declare class Network {
     private seedersIds;
     private _capsulesRootDir;
     constructor(_graphCapsules: CapsuleList, seedersIds: ComponentID[], _capsulesRootDir: string);
+    /**
+     * seeders capsules only without the entire graph. normally, this includes the capsules of one
+     * env.
+     */
     get seedersCapsules(): CapsuleList;
+    /**
+     * all capsules, including the dependencies of the seeders. (even when they belong to another env)
+     */
     get graphCapsules(): CapsuleList;
     get capsulesRootDir(): PathOsBasedAbsolute;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/isolator",
-  "version": "0.0.551",
+  "version": "0.0.556",
   "homepage": "https://bit.dev/teambit/component/isolator",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.component",
     "name": "isolator",
-    "version": "0.0.551"
+    "version": "0.0.556"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -23,14 +23,14 @@
     "execa": "2.1.0",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/component": "0.0.551",
-    "@teambit/legacy-bit-id": "0.0.371",
-    "@teambit/cli": "0.0.382",
-    "@teambit/component-package-version": "0.0.368",
-    "@teambit/dependency-resolver": "0.0.551",
-    "@teambit/global-config": "0.0.383",
-    "@teambit/graph": "0.0.551",
-    "@teambit/logger": "0.0.467"
+    "@teambit/component": "0.0.556",
+    "@teambit/legacy-bit-id": "0.0.376",
+    "@teambit/cli": "0.0.387",
+    "@teambit/component-package-version": "0.0.373",
+    "@teambit/dependency-resolver": "0.0.556",
+    "@teambit/global-config": "0.0.388",
+    "@teambit/graph": "0.0.556",
+    "@teambit/logger": "0.0.472"
   },
   "devDependencies": {
     "@types/fs-extra": "9.0.7",
@@ -45,7 +45,7 @@
     "@types/node": "12.20.4"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.169",
+    "@teambit/legacy": "1.0.173",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -73,12 +73,18 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.169",
+        "@teambit/legacy": "1.0.173",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/capsule/capsule.ts

@@ -1,138 +0,0 @@
-import { NodeFS } from '@teambit/any-fs';
-import { Capsule as CapsuleTemplate, Console, Exec, State } from '@teambit/capsule';
-import { Component } from '@teambit/component';
-import filenamify from 'filenamify';
-import { realpathSync } from 'fs';
-import glob from 'glob';
-import path from 'path';
-import v4 from 'uuid';
-
-import FsContainer, { BitExecOption } from './container';
-import ContainerExec from './container-exec';
-
-export default class Capsule extends CapsuleTemplate<Exec, NodeFS> {
-  private _wrkDir: string;
-  constructor(
-    /**
-     * container implementation the capsule is being executed within.
-     */
-    protected container: FsContainer,
-    /**
-     * the capsule's file system.
-     */
-    readonly fs: NodeFS,
-    /**
-     * console for controlling process streams as stdout, stdin and stderr.
-     */
-    readonly console: Console = new Console(),
-    /**
-     * capsule's state.
-     */
-    readonly state: State,
-    readonly component: Component
-  ) {
-    super(container, fs, console, state);
-    this._wrkDir = container.wrkDir;
-  }
-
-  /**
-   * @deprecated please use `this.path`
-   */
-  get wrkDir(): string {
-    return this.path;
-  }
-
-  get path(): string {
-    return realpathSync(this._wrkDir);
-  }
-
-  start(): Promise<any> {
-    return this.container.start();
-  }
-
-  async execNode(executable: string, args: any, exec: ContainerExec) {
-    return this.typedExec(
-      {
-        command: ['node', executable, ...(args.args || [])],
-        cwd: '',
-      },
-      exec
-    );
-  }
-
-  async typedExec(opts: BitExecOption, exec = new ContainerExec()) {
-    return this.container.exec(opts, exec);
-  }
-
-  outputFile(file: string, data: any, options?: any): Promise<any> {
-    return this.container.outputFile(file, data, options);
-  }
-
-  removePath(dir: string): Promise<any> {
-    return this.container.removePath(dir);
-  }
-
-  symlink(src: string, dest: string): Promise<any> {
-    return this.container.symlink(src, dest);
-  }
-
-  // TODO: refactor this crap and simplify capsule API
-  async execute(cmd: string, options?: Record<string, any> | null | undefined) {
-    // @ts-ignore AUTO-ADDED-AFTER-MIGRATION-PLEASE-FIX!
-    const execResults = await this.exec({ command: cmd.split(' '), options });
-    let stdout = '';
-    let stderr = '';
-    return new Promise((resolve, reject) => {
-      execResults.stdout.on('data', (data: string) => {
-        stdout += data;
-      });
-      execResults.stdout.on('error', (error: string) => {
-        return reject(error);
-      });
-      // @ts-ignore
-      execResults.on('close', () => {
-        return resolve({ stdout, stderr });
-      });
-      execResults.stderr.on('error', (error: string) => {
-        return reject(error);
-      });
-      execResults.stderr.on('data', (data: string) => {
-        stderr += data;
-      });
-    });
-  }
-
-  /**
-   * @todo: fix.
-   * it skips the capsule fs because for some reason `capsule.fs.promises.readdir` doesn't work
-   * the same as `capsule.fs.readdir` and it doesn't have the capsule dir as pwd.
-   *
-   * returns the paths inside the capsule
-   */
-  getAllFilesPaths(dir = '.', options: { ignore?: string[] } = {}) {
-    const files = glob.sync('**', { cwd: path.join(this.path, dir), nodir: true, ...options });
-    return files.map((file) => path.join(dir, file));
-  }
-
-  static getCapsuleDirName(component: Component, config: { alwaysNew?: boolean; name?: string } = {}) {
-    return config.name || filenamify(component.id.toString(), { replacement: '_' });
-  }
-
-  static getCapsuleRootDir(component: Component, baseDir: string, config: { alwaysNew?: boolean; name?: string } = {}) {
-    return path.join(baseDir, Capsule.getCapsuleDirName(component, config));
-  }
-
-  static async createFromComponent(
-    component: Component,
-    baseDir: string,
-    config: { alwaysNew?: boolean; name?: string } = {}
-  ): Promise<Capsule> {
-    // TODO: make this a static method and combine with ComponentCapsule
-    const capsuleDirName = Capsule.getCapsuleDirName(component, config);
-    const wrkDir = path.join(baseDir, config.alwaysNew ? `${capsuleDirName}_${v4()}` : capsuleDirName);
-    const container = new FsContainer(wrkDir);
-    const capsule = new Capsule(container, container.fs, new Console(), new State(), component);
-    await capsule.start();
-    return capsule;
-  }
-}

package/capsule/container-exec.ts

@@ -1,31 +0,0 @@
-import { DuplexBufferStream, Exec, ExecStatus } from '@teambit/capsule';
-import { EventEmitter } from 'events';
-
-export default class ContainerExec extends EventEmitter implements Exec {
-  constructor(private _code: number = 0) {
-    super();
-  }
-
-  stdout: DuplexBufferStream = new DuplexBufferStream();
-  stderr: DuplexBufferStream = new DuplexBufferStream();
-  stdin: DuplexBufferStream = new DuplexBufferStream();
-
-  setStatus(status: number): void {
-    this._code = status;
-    this.emit('close');
-  }
-
-  get code(): number {
-    return this._code;
-  }
-
-  inspect(): Promise<ExecStatus> {
-    return Promise.resolve({
-      running: true,
-      pid: 1,
-    });
-  }
-  abort(): Promise<void> {
-    throw new Error('Method not implemented.');
-  }
-}

package/capsule/container.ts

@@ -1,128 +0,0 @@
-import { AnyFS, NodeFS } from '@teambit/any-fs';
-import { Container, ContainerFactoryOptions, ContainerStatus, Exec, ExecOptions } from '@teambit/capsule';
-import execa from 'execa';
-import fs from 'fs-extra';
-import * as path from 'path';
-import { Stream } from 'stream';
-
-import ContainerExec from './container-exec';
-
-const debug = require('debug')('fs-container');
-
-export interface BitExecOption extends ExecOptions {
-  cwd: string;
-  stdio?: 'pipe' | 'ipc' | 'ignore' | 'inherit' | Stream | number | undefined;
-}
-export interface BitContainerConfig extends ContainerFactoryOptions {
-  other?: string;
-}
-
-export default class FsContainer implements Container<Exec, AnyFS> {
-  id = 'FS Container';
-
-  fs: NodeFS = new NodeFS(this.wrkDir);
-
-  constructor(readonly wrkDir: string) {}
-
-  // TODO: do we need this?
-  public getPath() {
-    return this.wrkDir;
-  }
-
-  private composePath(pathToCompose) {
-    return path.join(this.getPath(), pathToCompose);
-  }
-
-  outputFile(file, data, options) {
-    const filePath = this.composePath(file);
-    debug(`writing file on ${filePath}`);
-    return fs.outputFile(filePath, data, options);
-  }
-
-  removePath(dir: string): Promise<any> {
-    const pathToRemove = this.composePath(dir);
-    return fs.remove(pathToRemove);
-  }
-
-  async symlink(src: string, dest: string): Promise<any> {
-    const srcPath = this.composePath(src);
-    const destPath = this.composePath(dest);
-    await fs.ensureDir(path.dirname(destPath));
-    return fs.ensureSymlink(srcPath, destPath);
-  }
-
-  async exec(execOptions: BitExecOption, exec = new ContainerExec()): Promise<ContainerExec> {
-    const cwd = execOptions.cwd ? this.composePath(execOptions.cwd) : this.getPath();
-    debug(`executing the following command: ${execOptions.command.join(' ')}, on cwd: ${cwd}`);
-    const subprocessP = execa.command(execOptions.command.join(' '), {
-      shell: true,
-      cwd,
-      stdio: ['ipc'],
-    });
-
-    // @TODO: FIX! This probably causes errors ad the promise is not handled properly!
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    subprocessP.on('message', function (msg: any) {
-      exec.emit('message', msg);
-    });
-    /* eslint-disable @typescript-eslint/no-non-null-assertion */
-    subprocessP.stderr?.pipe(exec.stderr);
-    subprocessP.stdout?.pipe(exec.stdout);
-    ['close', 'exit'].forEach(function (eventName: string) {
-      // @TODO: FIX! This probably causes errors ad the promise is not handled properly!
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      subprocessP.on(eventName, function (statusCode) {
-        exec.setStatus(statusCode);
-      });
-    });
-
-    return exec;
-  }
-
-  async execP(execOptions: BitExecOption): Promise<string> {
-    let hasError = false;
-    const exec = await this.exec(execOptions);
-    return new Promise((resolve, reject) => {
-      exec.stdout.on('error', () => {
-        hasError = true;
-      });
-      exec.on('close', () => {
-        if (hasError) reject(exec.stderr.getContents!(exec.stderr.size).toString());
-        resolve(exec.stdout.getContents!(exec.stdout.size).toString());
-      });
-    });
-  }
-
-  async terminal() {
-    const cwd = this.getPath();
-    return execa.command(process.env.SHELL || '/bin/zsh', { cwd, stdio: 'inherit' });
-  }
-
-  start(): Promise<void> {
-    return fs.ensureDir(this.wrkDir);
-  }
-  // @ts-ignore
-  async inspect(): Promise<ContainerStatus> {
-    // todo: probably not needed for this container
-  }
-  async pause(): Promise<void> {
-    // do nothing
-  }
-  async resume(): Promise<void> {
-    // do nothing
-  }
-  // eslint-disable-next-line
-  stop(ttl?: number | undefined): Promise<void> {
-    return fs.remove(this.wrkDir);
-  }
-  async destroy(): Promise<void> {
-    await this.stop();
-  }
-  log(): Promise<Exec> {
-    throw new Error('Method not implemented.');
-  }
-  on(event: string, fn: (data: any) => void): void {
-    return fn(event);
-    // throw new Error('Method not implemented.');
-  }
-}

package/capsule/index.ts

@@ -1,3 +0,0 @@
-export { default as Capsule } from './capsule';
-export { default as FsContainer } from './container';
-export { default as ContainerExec } from './container-exec';

package/capsule-list.ts

@@ -1,33 +0,0 @@
-import type { Component, ComponentID } from '@teambit/component';
-import { normalize } from 'path';
-import { BitId } from '@teambit/legacy-bit-id';
-import { Capsule } from './capsule';
-
-export default class CapsuleList extends Array<Capsule> {
-  getCapsule(id: ComponentID): Capsule | undefined {
-    return this.find((capsule) => capsule.component.id.isEqual(id));
-  }
-  getCapsuleByLegacyId(id: BitId): Capsule | undefined {
-    return this.find((capsule) => capsule.component.id._legacy.isEqual(id));
-  }
-  getCapsuleIgnoreVersion(id: ComponentID): Capsule | undefined {
-    return this.find((capsule) => capsule.component.id._legacy.isEqualWithoutVersion(id._legacy));
-  }
-  getCapsuleIgnoreScopeAndVersion(id: ComponentID): Capsule | undefined {
-    return this.find((capsule) => capsule.component.id._legacy.isEqualWithoutScopeAndVersion(id._legacy));
-  }
-  getAllCapsuleDirs(): string[] {
-    return this.map((capsule) => capsule.path);
-  }
-  getIdByPathInCapsule(pathInCapsule: string): ComponentID | null {
-    const normalizedPathInCapsule = normalize(pathInCapsule);
-    const found = this.find((capsule) => normalizedPathInCapsule === normalize(capsule.path));
-    return found ? found.component.id : null;
-  }
-  getAllComponents(): Component[] {
-    return this.map((c) => c.component);
-  }
-  static fromArray(capsules: Capsule[]) {
-    return new CapsuleList(...capsules);
-  }
-}

package/index.ts

@@ -1,6 +0,0 @@
-export { IsolateComponentsOptions } from './isolator.main.runtime';
-export { Network } from './network';
-export { FsContainer, Capsule, ContainerExec } from './capsule';
-export type { IsolatorMain } from './isolator.main.runtime';
-export { IsolatorAspect } from './isolator.aspect';
-export { default as CapsuleList } from './capsule-list';

package/isolator.aspect.ts

@@ -1,7 +0,0 @@
-import { Aspect } from '@teambit/harmony';
-
-export const IsolatorAspect = Aspect.create({
-  id: 'teambit.component/isolator',
-  dependencies: [],
-  defaultConfig: {},
-});

package/isolator.docs.md

@@ -1,41 +0,0 @@
----
-description: Isolate components for build, debugging, development and testing.
-labels: ['isolation', 'component']
----
-
-## Isolate a component
-
-```bash
-bit create-capsule ui/button
-```
-
-## Entities
-
-### Capsule
-
-Bit implements a filesystem capsule, which is an isolated folder containing the component files.
-Capsules include the component files and links to other capsules that include the component's dependencies.
-
-### Network
-
-A network is a group of capsules, related to one another by their dependencies.
-A network includes a graph of all seed components given to it, as well as a list of the capsules.
-
-Example:
-
-```javascript
-const Network = {
-  graph: Graph,
-  capsules: CapsuleList,
-};
-```
-
-## API
-
-The exact particularities of this API are beyond the scope of this readme. Instead, this document opts to
-provide a general description of the methods of this API and their purpose.
-
-### Isolator.isolateComponents
-
-This method receives a list of components, create capsule for the components and write the components data into the capsule.
-It returns a list of capsules.