@teambit/node 1.0.41 → 1.0.43

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

@@ -1,178 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function docFile({ name, componentId }: ComponentContext) {
-  return `---
-description: 'A standard Node component development environment'
-labels: ['node', 'typescript', 'env', 'extension']
----
-
-## Overview
-
-A customized version which extends the default Node component development environment created by teambit.
-
-This environment can be applied to all your components or a set of components via the command \`bit env set <pattern or component_id> ${componentId}\`, or under the variants of your \`workspace.json\` file.
-That means they will use your custom environment instead of the default environment. Environment components are just like any other Bit components in that they can be
-exported and then shared and used in various projects which makes it easier to create standards when working with many teams.
-
-### Usage instructions
-
-#### Recommended usage:
-
-Run the command \`bit env set <"pattern" or component_id> ${componentId}\` where the pattern is a glob pattern to select multiple components. This will put the env
-config in your component's entry in the \`.bitmap\` file.
-
-:::Note - this will override any variants policy that tries to set an env for this component in the workspace.jsonc
-:::
-
-#### Alternative Usage
-Under the **variant** section of your \`workspace.json\` file choose which components you want to have the custom environment set. You can find the id of the extension in the \`${name}.aspect.ts\` file.
-
-\`\`\`json
-{
-  "teambit.workspace/variants": {
-    "{ui/**}, {pages/**}": {
-      "${componentId}": {}
-    }
-  }
-}
-\`\`\`
-
-This usage may be deprecated in future in favour of the recommended usage above
-
-## Runtime Configurations
-
-Extend the \`main.runtime\` file when you want to add custom configurations at runtime.
-
-### Compilation
-
-By default, Component compilation is done with the TypeScript compiler. Target format is \`ES2015\` which
-supports execution from both NodeJS and browser runtimes for server-side rendering. You can modify the \`tsconfig.json\` file to add your own compiler options which will then be merged with the default configs set by teambit.
-
-Example:
-
-\`\`\`json
-{
-  "compilerOptions": {
-    "target": "es2017",
-    "module": "es2015",
-    "moduleResolution": "node",
-    "lib": ["es2017", "dom"],
-    "experimentalDecorators": true,
-    "esModuleInterop": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "emitDecoratorMetadata": true,
-    "allowJs": true,
-    "baseUrl": ".",
-    "jsx": "react"
-  }
-}
-\`\`\`
-
-### Testing
-
-Component testing is done through [Jest](https://jestjs.io/) with the default \`teambit.react/react\` environment. You can modify the \`jestconfig.js\` file to add your own configurations which will then be merged with the default configs set by teambit.
-
-Example:
-
-To Override the Jest config to ignore transpiling from specific folders add this to the \`jestconfig.js\` file:
-
-\`\`\`js
-const reactJestConfig = require('@teambit/react/jest/jest.config');
-module.exports = {
-  ...reactJestConfig,
-  transformIgnorePatterns: ['/node_modules/(?!(prop-types|@teambit))']
-};
-\`\`\`
-
-### Webpack
-
-Bit uses webpack 5 to bundle components. You can modify the \`webpack.config.js\` file to add your own configurations which will then be merged with the default configs set by teambit.
-
-Example:
-
-\`\`\`ts
-module.exports = {
-  module: {
-    // add your custom rules here
-    rules: []
-  }
-};
-\`\`\`
-
-### ESLint
-
-Bit uses ESLint to lint your components. You can add your own rules in the \`${name}.main.runtime\` file.
-
-Example:
-
-\`\`\`ts
-react.useEslint({
-  transformers: [
-    (config) => {
-      config.setRule('no-console', ['error']);
-      // add more rules here
-      return config;
-    }
-  ]
-}),
-\`\`\`
-
-To use ESLint:
-
-\`\`\`bash
-bit lint
-bit lint --fix
-\`\`\`
-
-### Formatting
-
-Bit uses Prettier to format your components. You can add your own rules in the \`${name}.main.runtime\` file.
-
-Example:
-
-\`\`\`ts
-react.usePrettier({
-  transformers: [
-    (config) => {
-      config.setKey('tabWidth', 2);
-      // add more rules here
-      return config;
-    }
-  ]
-}),
-\`\`\`
-
-To use Prettier:
-
-\`\`\`bash
-bit format --check
-bit format
-\`\`\`
-
-### Dependencies
-
-Override the default dependencies in the \`${name}.main.runtime\` file to include react types of a different version for example.
-
-\`\`\`ts
-react.overrideDependencies({
-  devDependencies: {
-    '@types/react': '17.0.3'
-  }
-});
-\`\`\`
-
-## Preview Configurations
-
-Extend the \`${name}.preview.runtime\` file when you want to add your own customizations only for previewing in the Bit UI.
-
-### Adding a Theme
-
-A custom theme has been added to the env which wraps all the composition files with the required theme so they can be developed with the correct themeing rather than the browsers default. This is added only in the preview runtime and not in the main runtime meaning it is only applied to compositions and not when consuming components. Adding a theme when consuming should be done at App level as you component may be consumed in various apps and have different themes applied depending on where it is consumed.
-
-Example:
-
-\`\`\`ts
-react.registerProvider([ThemeCompositions]);
-`;
-}

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

@@ -1,10 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function indexFile({ namePascalCase: Name, name }: ComponentContext) {
-  return `import { ${Name}Aspect } from './${name}.aspect';
-
-export type { ${Name}Main } from './${name}.main.runtime';
-export default ${Name}Aspect;
-export { ${Name}Aspect };
-`;
-}

package/templates/node-env/files/jest.config.ts

@@ -1,21 +0,0 @@
-export function jestConfigFile() {
-  return `
-  // Override the Jest config to ignore transpiling from specific folders
-  // See the base Jest config: https://bit.cloud/teambit/react/react/~code/jest/jest.config.js
-
-  // const reactJestConfig = require('@teambit/react/jest/jest.config');
-  // uncomment the line below and install the package if you want to use this function
-  // const {
-  //   generateNodeModulesPattern,
-  // } = require('@teambit/dependencies.modules.packages-excluder');
-  // const packagesToExclude = ['@my-org', 'my-package-name'];
-
-  // module.exports = {
-  //   ...reactJestConfig,
-  //   transformIgnorePatterns: [
-  //     '^.+\\.module\\.(css|sass|scss)$',
-  //     generateNodeModulesPattern({ packages: packagesToExclude }),
-  //   ],
-  // };
-  `;
-}

package/templates/node-env/files/main.runtime.ts

@@ -1,95 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function mainRuntimeFile({ namePascalCase: Name, name }: ComponentContext) {
-  return `import { MainRuntime } from '@teambit/cli';
-import { NodeAspect, NodeMain } from '@teambit/node'
-import { EnvsAspect, EnvsMain } from '@teambit/envs';
-import type { UseTypescriptModifiers, UseWebpackModifiers } from '@teambit/react';
-import { ${Name}Aspect } from './${name}.aspect';
-//import {
-//  previewConfigTransformer,
-//  devServerConfigTransformer
-//} from './webpack/webpack-transformers';
-//import {
-//  devConfigTransformer,
-//  buildConfigTransformer,
-//} from "./typescript/ts-transformer";
-
-export class ${Name}Main {
-  static slots = [];
-
-  static dependencies = [NodeAspect, EnvsAspect];
-
-  static runtime = MainRuntime;
-
-  static async provider([node, envs]: [NodeMain, EnvsMain]) {
-
-    //const webpackModifiers: UseWebpackModifiers = {
-      //  previewConfig: [previewConfigTransformer],
-      //  devServerConfig: [devServerConfigTransformer],
-    //};
-
-    //const tsModifiers: UseTypescriptModifiers = {
-      //  devConfig: [devConfigTransformer],
-      //  buildConfig: [buildConfigTransformer],
-    //};
-
-    const ${Name}Env = node.compose([
-      /**
-       * Uncomment to override the config files for TypeScript, Webpack or Jest
-       * Your config gets merged with the defaults
-       */
-
-      // node.useTypescript(tsModifiers),  // note: this cannot be used in conjunction with node.overrideCompiler
-      // node.useWebpack(webpackModifiers),
-      // node.overrideJestConfig(require.resolve('./jest/jest.config')),
-
-      /**
-       * override the ESLint default config here then check your files for lint errors
-       * @example
-       * bit lint
-       * bit lint --fix
-       */
-      node.useEslint({
-        transformers: [
-          (config) => {
-            config.setRule('no-console', ['error']);
-            return config;
-          }
-        ]
-      }),
-
-      /**
-       * override the Prettier default config here the check your formatting
-       * @example
-       * bit format --check
-       * bit format
-       */
-      node.usePrettier({
-        transformers: [
-          (config) => {
-            config.setKey('tabWidth', 2);
-            return config;
-          }
-        ]
-      }),
-
-      /**
-       * override dependencies here
-       * @example
-       * Uncomment types to include version 17.0.3 of the types package
-       */
-      node.overrideDependencies({
-        devDependencies: {
-          // '@types/node': '16.11.7'
-        }
-      })
-    ]);
-    envs.registerEnv(${Name}Env);
-    return new ${Name}Main();
-  }
-}
-
-${Name}Aspect.addRuntime(${Name}Main);
-`;
-}

package/templates/node-env/files/preview.runtime.ts

@@ -1,27 +0,0 @@
-import { ComponentContext } from '@teambit/generator';
-
-export function previewRuntimeFile({ namePascalCase: Name, nameCamelCase: nameCamel, name }: ComponentContext) {
-  return `import { PreviewRuntime } from '@teambit/preview';
-import { ReactAspect, ReactPreview } from '@teambit/react'; // the node env uses the react env's preview feature
-// uncomment the line below and install the theme if you want to use our theme or create your own and import it here
-// import { ThemeCompositions } from '@teambit/documenter.theme.theme-compositions';
-
-import { ${Name}Aspect } from './${name}.aspect';
-
-export class ${Name}PreviewMain {
-  static runtime = PreviewRuntime;
-
-  static dependencies = [ReactAspect];
-
-  static async provider([react]: [ReactPreview]) {
-    const ${nameCamel}PreviewMain = new ${Name}PreviewMain();
-    // uncomment the line below to register a new provider to wrap all compositions using this environment with a custom theme.
-    // react.registerProvider([ThemeCompositions]);
-
-    return ${nameCamel}PreviewMain;
-  }
-}
-
-${Name}Aspect.addRuntime(${Name}PreviewMain);
-`;
-}

package/templates/node-env/files/typescript/styles.ts

@@ -1,7 +0,0 @@
-export function globalStylesFile() {
-  return `
-  /*
-  Add your global styles here to be added for any component using this env
-  */
-  `;
-}

package/templates/node-env/files/typescript/ts-transformer.ts

@@ -1,50 +0,0 @@
-export function tsTransformerFile() {
-  return `
-  import * as path from 'path';
-import {
-  TsConfigTransformer,
-  TypescriptConfigMutator,
-} from "@teambit/typescript";
-
-const tsConfig = require('./tsconfig.json');
-
-export const commonTransformer: TsConfigTransformer = (
-  config: TypescriptConfigMutator
-) => {
-  const newConfig = config.addTypes([path.join(__dirname, 'styles.d.ts')])
-  newConfig.mergeTsConfig(tsConfig);
-  // Some examples of other built in mutator functions:
-  //newConfig.addExclude(['someExclude']);
-  //newConfig.setCompileJs(true)
-  return newConfig;
-};
-
-/**
- * Transformation for the dev config only
- * @param config
- * @param context
- * @returns
- */
-export const devConfigTransformer: TsConfigTransformer = (
-  config: TypescriptConfigMutator,
-) => {
-  const newConfig = commonTransformer(config, {});
-  return newConfig;
-};
-
-/**
- * Transformation for the build only
- * @param config
- * @param context
- * @returns
- */
-export const buildConfigTransformer: TsConfigTransformer = (
-  config: TypescriptConfigMutator
-) => {
-  const newConfig = commonTransformer(config, {});
-  newConfig.mergeTsConfig(tsConfig);
-  return newConfig;
-};
-
-`;
-}

package/templates/node-env/files/typescript/typescript.config.ts

@@ -1,21 +0,0 @@
-export function typescriptConfigFile() {
-  return `{
-  // add your compiler options here
-
-  "compilerOptions": {
-    // "target": "es2017",
-    // "module": "es2015",
-    // "moduleResolution": "node",
-    // "lib": ["es2017", "dom"],
-    // "experimentalDecorators": true,
-    // "esModuleInterop": true,
-    // "outDir": "dist",
-    // "sourceMap": true,
-    // "emitDecoratorMetadata": true,
-    // "allowJs": true,
-    // "baseUrl": ".",
-    // "jsx": "react"
-  }
-}
-`;
-}

package/templates/node-env/files/webpack.config.ts

@@ -1,48 +0,0 @@
-export function webpackConfigFile() {
-  return `
-  import { WebpackConfigTransformer, WebpackConfigMutator, WebpackConfigTransformContext } from '@teambit/webpack';
-
-  /**
-   * Transformation to apply for both preview and dev server
-   * @param config
-   * @param _context
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  function commonTransformation(config: WebpackConfigMutator, _context: WebpackConfigTransformContext) {
-    // Merge config with the webpack.config.js file if you choose to import a module export format config.
-    // config.merge([webpackConfig]);
-    // config.addAliases({});
-    // config.addModuleRule(youRuleHere);
-    return config;
-  }
-
-  /**
-   * Transformation for the preview only
-   * @param config
-   * @param context
-   * @returns
-   */
-  export const previewConfigTransformer: WebpackConfigTransformer = (
-    config: WebpackConfigMutator,
-    context: WebpackConfigTransformContext
-  ) => {
-    const newConfig = commonTransformation(config, context);
-    return newConfig;
-  };
-
-  /**
-   * Transformation for the dev server only
-   * @param config
-   * @param context
-   * @returns
-   */
-  export const devServerConfigTransformer: WebpackConfigTransformer = (
-    config: WebpackConfigMutator,
-    context: WebpackConfigTransformContext
-  ) => {
-    const newConfig = commonTransformation(config, context);
-    return newConfig;
-  };
-
-`;
-}

package/templates/node-env/index.ts

@@ -1,68 +0,0 @@
-import { ComponentContext, ComponentTemplate } from '@teambit/generator';
-import { indexFile } from './files/index';
-import { docFile } from './files/doc';
-import { mainRuntimeFile } from './files/main.runtime';
-import { previewRuntimeFile } from './files/preview.runtime';
-import { aspectFile } from './files/aspect';
-import { webpackConfigFile } from './files/webpack.config';
-import { typescriptConfigFile } from './files/typescript/typescript.config';
-import { globalStylesFile } from './files/typescript/styles';
-import { tsTransformerFile } from './files/typescript/ts-transformer';
-import { jestConfigFile } from './files/jest.config';
-
-export const nodeEnvTemplate: ComponentTemplate = {
-  name: 'node-env',
-  description: 'customize the base Node env with your configs and tools',
-  hidden: true,
-  generateFiles: (context: ComponentContext) => {
-    return [
-      {
-        relativePath: 'index.ts',
-        content: indexFile(context),
-        isMain: true,
-      },
-      {
-        relativePath: `${context.name}.docs.mdx`,
-        content: docFile(context),
-      },
-      {
-        relativePath: `${context.name}.main.runtime.ts`,
-        content: mainRuntimeFile(context),
-      },
-      {
-        relativePath: `${context.name}.preview.runtime.ts`,
-        content: previewRuntimeFile(context),
-      },
-      {
-        relativePath: `${context.name}.aspect.ts`,
-        content: aspectFile(context),
-      },
-      {
-        relativePath: `webpack/webpack-transformers.ts`,
-        content: webpackConfigFile(),
-      },
-      {
-        relativePath: `typescript/tsconfig.json`,
-        content: typescriptConfigFile(),
-      },
-      {
-        relativePath: `typescript/styles.d.ts`,
-        content: globalStylesFile(),
-      },
-      {
-        relativePath: `typescript/ts-transformer.ts`,
-        content: tsTransformerFile(),
-      },
-      {
-        relativePath: `jest/jest.config.js`,
-        content: jestConfigFile(),
-      },
-    ];
-  },
-  config: {
-    'teambit.envs/env': {},
-    'teambit.envs/envs': {
-      env: 'teambit.envs/env',
-    },
-  },
-};