@teambit/node 0.0.554 → 0.0.558

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

@@ -14,21 +14,72 @@ export declare class NodeMain {
     private envs;
     constructor(react: ReactMain, nodeEnv: NodeEnv, envs: EnvsMain);
     icon(): string;
+    /**
+     * @deprecated use useTypescript()
+     * override the TS config of the environment.
+     */
     overrideTsConfig: (tsconfig: TsConfigSourceFile, compilerOptions?: Partial<TsCompilerOptionsWithoutTsConfig>, tsModule?: any) => EnvTransformer;
+    /**
+     * override the jest config of the environment.
+     */
     overrideJestConfig: (jestConfigPath: string, jestModulePath?: string | undefined) => EnvTransformer;
+    /**
+     * override the env build pipeline.
+     */
     overrideBuildPipe: (tasks: BuildTask[]) => EnvTransformer;
+    /**
+     * override the env compilers list.
+     */
     overrideCompiler: (compiler: Compiler) => EnvTransformer;
+    /**
+     * override the env compilers tasks in the build pipe.
+     */
     overrideCompilerTasks: (tasks: BuildTask[]) => EnvTransformer;
+    /**
+     * @deprecated use useTypescript()
+     * override the build ts config.
+     */
     overrideBuildTsConfig: (tsconfig: any, compilerOptions?: Partial<TsCompilerOptionsWithoutTsConfig>) => EnvTransformer;
+    /**
+     * override package json properties.
+     */
     overridePackageJsonProps: (props: PackageJsonProps) => EnvTransformer;
+    /**
+     * @deprecated - use useWebpack
+     * override the preview config in the env.
+     */
     overridePreviewConfig: (config: import("webpack").Configuration) => EnvTransformer;
+    /**
+     * @deprecated - use useWebpack
+     * override the dev server configuration.
+     */
     overrideDevServerConfig: (config: import("webpack").Configuration) => EnvTransformer;
+    /**
+     * override the env's typescript config for both dev and build time.
+     * Replaces both overrideTsConfig (devConfig) and overrideBuildTsConfig (buildConfig)
+     */
     useTypescript: (modifiers?: import("@teambit/react").UseTypescriptModifiers | undefined, tsModule?: any) => EnvTransformer;
+    /**
+     * override the env's dev server and preview webpack configurations.
+     * Replaces both overrideDevServerConfig and overridePreviewConfig
+     */
     useWebpack: (modifiers?: import("@teambit/react").UseWebpackModifiers | undefined) => EnvTransformer;
+    /**
+     * An API to mutate the prettier config
+     */
     usePrettier: (modifiers?: import("@teambit/react/react.main.runtime").UsePrettierModifiers | undefined) => EnvTransformer;
+    /**
+     * An API to mutate the eslint config
+     */
     useEslint: (modifiers?: import("@teambit/react/react.main.runtime").UseEslintModifiers | undefined) => EnvTransformer;
+    /**
+     * override the dependency configuration of the component environment.
+     */
     overrideDependencies(dependencyPolicy: VariantPolicyConfigObject): EnvTransformer;
     overrideMounter: (mounterPath: string) => EnvTransformer;
+    /**
+     * create a new composition of the node environment.
+     */
     compose(transformers: EnvTransformer[], targetEnv?: Environment): Environment;
     static runtime: import("@teambit/harmony").RuntimeDefinition;
     static dependencies: import("@teambit/harmony").Aspect[];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/node",
-  "version": "0.0.554",
+  "version": "0.0.558",
   "homepage": "https://bit.dev/teambit/harmony/node",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "node",
-    "version": "0.0.554"
+    "version": "0.0.558"
   },
   "dependencies": {
     "@teambit/harmony": "0.2.11",
@@ -14,19 +14,19 @@
     "typescript": "4.4.2",
     "@babel/runtime": "7.12.18",
     "core-js": "^3.0.0",
-    "@teambit/dependency-resolver": "0.0.554",
-    "@teambit/envs": "0.0.554",
-    "@teambit/builder": "0.0.554",
-    "@teambit/cli": "0.0.385",
-    "@teambit/compiler": "0.0.554",
-    "@teambit/generator": "0.0.554",
-    "@teambit/pkg": "0.0.554",
-    "@teambit/react": "0.0.554",
-    "@teambit/typescript": "0.0.554",
-    "@teambit/compositions": "0.0.554",
+    "@teambit/dependency-resolver": "0.0.558",
+    "@teambit/envs": "0.0.558",
+    "@teambit/builder": "0.0.558",
+    "@teambit/cli": "0.0.388",
+    "@teambit/compiler": "0.0.558",
+    "@teambit/generator": "0.0.558",
+    "@teambit/pkg": "0.0.558",
+    "@teambit/react": "0.0.558",
+    "@teambit/typescript": "0.0.558",
+    "@teambit/compositions": "0.0.558",
     "@teambit/design.ui.empty-box": "0.0.352",
-    "@teambit/tester": "0.0.554",
-    "@teambit/ui": "0.0.554"
+    "@teambit/tester": "0.0.558",
+    "@teambit/ui": "0.0.558"
   },
   "devDependencies": {
     "@types/react": "^17.0.8",
@@ -36,10 +36,10 @@
     "@types/jest": "^26.0.0",
     "@types/react-dom": "^17.0.5",
     "@types/node": "12.20.4",
-    "@teambit/harmony.aspect-docs.node": "0.0.104"
+    "@teambit/harmony.aspect-docs.node": "0.0.107"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.171",
+    "@teambit/legacy": "1.0.174",
     "react-dom": "^16.8.0 || ^17.0.0",
     "react": "^16.8.0 || ^17.0.0"
   },
@@ -67,12 +67,20 @@
         "react": "-"
       },
       "peerDependencies": {
-        "@teambit/legacy": "1.0.171",
+        "@teambit/legacy": "1.0.174",
         "react-dom": "^16.8.0 || ^17.0.0",
         "react": "^16.8.0 || ^17.0.0"
       }
     }
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "README.md",
+    "README.mdx",
+    "*.js",
+    "*.json"
+  ],
   "private": false,
   "engines": {
     "node": ">=12.22.0"

package/tsconfig.json

@@ -15,9 +15,9 @@
     "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "outDir": "dist",
     "composite": true,
     "emitDeclarationOnly": true,
+    "outDir": "dist",
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
     "allowSyntheticDefaultImports": true,
@@ -25,7 +25,6 @@
     "strict": true,
     "noImplicitAny": false,
     "rootDir": ".",
-    "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true
   },

package/index.ts

@@ -1,2 +0,0 @@
-export type { NodeMain } from './node.main.runtime';
-export { NodeAspect, NodeAspect as default } from './node.aspect';

package/node.aspect.ts

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

package/node.composition.tsx

@@ -1,7 +0,0 @@
-import React from 'react';
-
-export const Logo = () => (
-  <div style={{ height: '100%', display: 'flex', justifyContent: 'center' }}>
-    <img style={{ width: 70 }} src="https://static.bit.dev/brands/logo-nodejs.svg" />
-  </div>
-);

package/node.docs.mdx

@@ -1,8 +0,0 @@
----
-description: A Bit development environment for Node Components
-labels: ['node', 'environment', 'env', 'aspect', 'extension']
----
-
-import { Node } from '@teambit/harmony.aspect-docs.node';
-
-<Node />

package/node.env.ts

@@ -1,17 +0,0 @@
-import { DependenciesEnv } from '@teambit/envs';
-import { VariantPolicyConfigObject } from '@teambit/dependency-resolver';
-
-export class NodeEnv implements DependenciesEnv {
-  icon = 'https://static.bit.dev/extensions-icons/nodejs.svg';
-
-  getDependencies(): VariantPolicyConfigObject {
-    return {
-      devDependencies: {
-        '@types/jest': '26.0.20',
-        '@types/node': '12.20.4',
-        // This is added as dev dep since our jest file transformer uses babel plugins that require this to be installed
-        '@babel/runtime': '7.12.18',
-      },
-    };
-  }
-}

package/node.main.runtime.ts

@@ -1,139 +0,0 @@
-import { VariantPolicyConfigObject } from '@teambit/dependency-resolver';
-import { merge } from 'lodash';
-import { TsConfigSourceFile } from 'typescript';
-import type { TsCompilerOptionsWithoutTsConfig } from '@teambit/typescript';
-import { MainRuntime } from '@teambit/cli';
-import { GeneratorAspect, GeneratorMain } from '@teambit/generator';
-import { BuildTask } from '@teambit/builder';
-import { Compiler } from '@teambit/compiler';
-import { PackageJsonProps } from '@teambit/pkg';
-import { EnvsAspect, EnvsMain, EnvTransformer, Environment } from '@teambit/envs';
-import { ReactAspect, ReactMain } from '@teambit/react';
-import { NodeAspect } from './node.aspect';
-import { NodeEnv } from './node.env';
-import { nodeEnvTemplate } from './templates/node-env';
-import { nodeTemplate } from './templates/node';
-
-export class NodeMain {
-  constructor(
-    private react: ReactMain,
-
-    readonly nodeEnv: NodeEnv,
-
-    private envs: EnvsMain
-  ) {}
-
-  icon() {
-    return 'https://static.bit.dev/extensions-icons/nodejs.svg';
-  }
-
-  /**
-   * @deprecated use useTypescript()
-   * override the TS config of the environment.
-   */
-  overrideTsConfig: (
-    tsconfig: TsConfigSourceFile,
-    compilerOptions?: Partial<TsCompilerOptionsWithoutTsConfig>,
-    tsModule?: any
-  ) => EnvTransformer = this.react.overrideTsConfig.bind(this.react);
-
-  /**
-   * override the jest config of the environment.
-   */
-  overrideJestConfig = this.react.overrideJestConfig.bind(this.react);
-
-  /**
-   * override the env build pipeline.
-   */
-  overrideBuildPipe: (tasks: BuildTask[]) => EnvTransformer = this.react.overrideBuildPipe.bind(this.react);
-
-  /**
-   * override the env compilers list.
-   */
-  overrideCompiler: (compiler: Compiler) => EnvTransformer = this.react.overrideCompiler.bind(this.react);
-
-  /**
-   * override the env compilers tasks in the build pipe.
-   */
-  overrideCompilerTasks: (tasks: BuildTask[]) => EnvTransformer = this.react.overrideCompilerTasks.bind(this.react);
-
-  /**
-   * @deprecated use useTypescript()
-   * override the build ts config.
-   */
-  overrideBuildTsConfig: (
-    tsconfig: any,
-    compilerOptions?: Partial<TsCompilerOptionsWithoutTsConfig>
-  ) => EnvTransformer = this.react.overrideBuildTsConfig.bind(this.react);
-
-  /**
-   * override package json properties.
-   */
-  overridePackageJsonProps: (props: PackageJsonProps) => EnvTransformer = this.react.overridePackageJsonProps.bind(
-    this.react
-  );
-
-  /**
-   * @deprecated - use useWebpack
-   * override the preview config in the env.
-   */
-  overridePreviewConfig = this.react.overridePreviewConfig.bind(this.react);
-
-  /**
-   * @deprecated - use useWebpack
-   * override the dev server configuration.
-   */
-  overrideDevServerConfig = this.react.overrideDevServerConfig.bind(this.react);
-
-  /**
-   * override the env's typescript config for both dev and build time.
-   * Replaces both overrideTsConfig (devConfig) and overrideBuildTsConfig (buildConfig)
-   */
-  useTypescript = this.react.useTypescript.bind(this.react);
-
-  /**
-   * override the env's dev server and preview webpack configurations.
-   * Replaces both overrideDevServerConfig and overridePreviewConfig
-   */
-  useWebpack = this.react.useWebpack.bind(this.react);
-
-  /**
-   * An API to mutate the prettier config
-   */
-  usePrettier = this.react.usePrettier.bind(this.react);
-
-  /**
-   * An API to mutate the eslint config
-   */
-  useEslint = this.react.useEslint.bind(this.react);
-
-  /**
-   * override the dependency configuration of the component environment.
-   */
-  overrideDependencies(dependencyPolicy: VariantPolicyConfigObject) {
-    return this.envs.override({
-      getDependencies: () => merge(dependencyPolicy, this.nodeEnv.getDependencies()),
-    });
-  }
-
-  overrideMounter = this.react.overrideMounter.bind(this.react);
-
-  /**
-   * create a new composition of the node environment.
-   */
-  compose(transformers: EnvTransformer[], targetEnv: Environment = {}) {
-    return this.envs.compose(this.envs.merge(targetEnv, this.nodeEnv), transformers);
-  }
-
-  static runtime = MainRuntime;
-  static dependencies = [EnvsAspect, ReactAspect, GeneratorAspect];
-
-  static async provider([envs, react, generator]: [EnvsMain, ReactMain, GeneratorMain]) {
-    const nodeEnv: NodeEnv = envs.merge(new NodeEnv(), react.reactEnv);
-    envs.registerEnv(nodeEnv);
-    generator.registerComponentTemplate([nodeEnvTemplate, nodeTemplate]);
-    return new NodeMain(react, nodeEnv, envs);
-  }
-}
-
-NodeAspect.addRuntime(NodeMain);

package/node.ui.runtime.tsx

@@ -1,42 +0,0 @@
-import React from 'react';
-import { CompositionsAspect, CompositionsUI } from '@teambit/compositions';
-import { UIRuntime } from '@teambit/ui';
-import { TesterAspect, TesterUI } from '@teambit/tester';
-import { EmptyBox } from '@teambit/design.ui.empty-box';
-import { NodeAspect } from './node.aspect';
-
-export class NodeEnvUI {
-  static runtime = UIRuntime;
-  static slots = [];
-  static dependencies = [CompositionsAspect, TesterAspect];
-
-  static async provider([compositionsUI, testerUi]: [CompositionsUI, TesterUI]) {
-    const nodeEnvUI = new NodeEnvUI();
-
-    testerUi.registerEmptyState(() => {
-      return (
-        <EmptyBox
-          title="This component doesn’t have any tests."
-          linkText="Learn how to add tests to your node components"
-          link="https://harmony-docs.bit.dev/testing/overview/"
-        />
-      );
-    });
-
-    compositionsUI.registerEmptyState(() => {
-      return (
-        <EmptyBox
-          title="This component doesn’t have any compositions."
-          linkText="Learn how to add compositions to your node components"
-          link="https://harmony-docs.bit.dev/compositions/overview/"
-        />
-      );
-    });
-
-    return nodeEnvUI;
-  }
-}
-
-NodeAspect.addRuntime(NodeEnvUI);
-
-export default NodeEnvUI;

package/templates/node/files/composition.ts

@@ -1,14 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function compositionFile(context: ComponentContext) {
-  return {
-    relativePath: `${context.name}.composition.tsx`,
-    content: `import React from 'react';
-import { ${context.nameCamelCase} } from './${context.name}';
-
-export function ReturnsCorrectValue() {
-  return <div>{${context.nameCamelCase}()}</div>;
-}
-`,
-  };
-}

package/templates/node/files/doc.ts

@@ -1,18 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function docFile(context: ComponentContext) {
-  return {
-    relativePath: `${context.name}.docs.mdx`,
-    content: `---
-labels: ['module']
-description: 'A general purpose node module'
----
-
-API:
-
-\`\`\`ts
-function ${context.nameCamelCase}(): string;
-\`\`\`
-`,
-  };
-}

package/templates/node/files/index.ts

@@ -1,10 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function indexFile(context: ComponentContext) {
-  return {
-    relativePath: 'index.ts',
-    content: `export { ${context.nameCamelCase} } from './${context.name}';
-`,
-    isMain: true,
-  };
-}

package/templates/node/files/main.ts

@@ -1,11 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function mainFile(context: ComponentContext) {
-  return {
-    relativePath: `${context.name}.ts`,
-    content: `export function ${context.nameCamelCase}() {
-  return 'Hello world!';
-}
-`,
-  };
-}

package/templates/node/files/test.ts

@@ -1,13 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function testFile(context: ComponentContext) {
-  return {
-    relativePath: `${context.name}.spec.ts`,
-    content: `import { ${context.nameCamelCase} } from './${context.name}';
-
-it('should return the correct value', () => {
-  expect(${context.nameCamelCase}()).toBe('Hello world!');
-});
-`,
-  };
-}

package/templates/node/index.ts

@@ -1,14 +0,0 @@
-import { ComponentContext, ComponentTemplate } from '@teambit/generator';
-import { indexFile } from './files/index';
-import { docFile } from './files/doc';
-import { mainFile } from './files/main';
-import { testFile } from './files/test';
-import { compositionFile } from './files/composition';
-
-export const nodeTemplate: ComponentTemplate = {
-  name: 'node',
-  description: 'a Node.js module',
-  generateFiles: (context: ComponentContext) => {
-    return [indexFile(context), docFile(context), mainFile(context), compositionFile(context), testFile(context)];
-  },
-};

package/templates/node-env/files/doc.ts

@@ -1,11 +0,0 @@
-export function docFile() {
-  return `---
-labels: ['extension', 'node', 'env', 'environment']
-description: 'A customized extension for Node environment.'
----
-
-This is a customized extension for Node, based of the [Node Aspect](https://bit.dev/teambit/harmony/node).
-
-Explain here the modified configurations and tools applied.
-`;
-}

package/templates/node-env/files/extension.ts

@@ -1,25 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function extensionFile({ namePascalCase: Name }: ComponentContext) {
-  return `import { EnvsMain, EnvsAspect } from '@teambit/envs'
-import { NodeAspect, NodeMain } from '@teambit/node'
-
-export class ${Name}Extension {
-  constructor(private node: NodeMain) {}
-
-  static dependencies: any = [EnvsAspect, NodeAspect]
-
-  static async provider([envs, node]: [EnvsMain, NodeMain]) {
-    const ${Name}Env = node.compose([
-      /*
-        Use any of the "node.override..." transformers to
-      */
-    ])
-
-    envs.registerEnv(${Name}Env)
-
-    return new ${Name}Extension(node)
-  }
-}
-`;
-}

package/templates/node-env/files/index.ts

@@ -1,8 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function indexFile({ namePascalCase: Name, name }: ComponentContext) {
-  return `import { ${Name}Extension } from './${name}.extension';
-export { ${Name}Extension };
-export default ${Name}Extension;
-`;
-}

package/templates/node-env/index.ts

@@ -1,26 +0,0 @@
-import { ComponentContext, ComponentTemplate } from '@teambit/generator';
-import { indexFile } from './files/index';
-import { docFile } from './files/doc';
-import { extensionFile } from './files/extension';
-
-export const nodeEnvTemplate: ComponentTemplate = {
-  name: 'node-env',
-  description: 'customize the base Node env with your configs and tools',
-  generateFiles: (context: ComponentContext) => {
-    return [
-      {
-        relativePath: 'index.ts',
-        content: indexFile(context),
-        isMain: true,
-      },
-      {
-        relativePath: `${context.name}.docs.mdx`,
-        content: docFile(),
-      },
-      {
-        relativePath: `${context.name}.extension.ts`,
-        content: extensionFile(context),
-      },
-    ];
-  },
-};

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;
-}