workspace.jsonc

/**




 * this is the main configuration file of your bit workspace.




 * for full documentation, please see: https://docs.bit.dev/configuration




**/{
  "$schema": "",
  /**




   * main configuration of the Bit workspace.




  **/
  "@teambit/workspace": {
    /**




     * applies only on bit.dev. configure the main owner of your workspace.




    **/
    // "defaultOwner": "teambit",
    /**




     * set the default scope when there is no matching for the component in the components array.




     **/
    // "defaultScope": "my-scope",
    /**




     * set the default directory when there is no matching for the component in the components array.




     **/
    "defaultDirectory": "components",
    /**




    * set the default structure of components in your project.




    **/
    "components": [
      {
        "defaultScope": "ui",
        "directory": "base"
      },
      {
        "defaultScope": "extensions",
        "directory": "extensions"
      }
    ]
  },
  /**




   * main configuration for component dependency resolution.




  **/
  "@teambit/dependency-resolver": {
    /**




     * choose the package manager for Bit to use. you can choose between 'npm', 'yarn', 'pnpm'




    */
    "packageManager": "npm",
    /**




    * If true, then Bit will add the "--strict-peer-dependencies" option when invoking package managers.




    * This causes "bit install" to fail if there are unsatisfied peer dependencies, which is




    * an invalid state that can cause build failures or incompatible dependency versions.




    * (For historical reasons, JavaScript package managers generally do not treat this invalid




    * state as an error.)




    *




    * The default value is false to avoid legacy compatibility issues.




    * It is strongly recommended to set strictPeerDependencies=true.




    */
    "strictPeerDependencies": true,
    /**




     * map of extra arguments to pass to the configured package manager upon the installation




     * of dependencies.




    */
    "extraArgs": []
  },
  /**




   * automate Bit workflow with Git.




  */
  // "@teambit/git": {
  /**




     * fetch dependency and component updates on `git pull`.




    **/
  // "dependencyUpdateOnPull": true
  // },
  /**




   * workspace variants allow to set different subsets of configuration for components in your workspace.




   * this is extremely useful for upgrading, aligning and building components with a




   * new set of dependencies.




  **/
  "@teambit/variants": {
    /**




     * wildcards can be used to configure components under a specific namespace.




     * this configuration applies the react extensions on all components the `ui` namespace.




    **/
    "base/*": {
      /**




      * apply the react environment on all ui components.




        **/
      "@teambit/react": {
        /**




        * turn on typescript compiler.




        **/
        "typescript": true,
        /**




        * root component is the one to be deployed and served.




        **/
        "root": "ui/homepage",
        /**




        * sets react version to be bigger or equal to 16.0.0.




        * this will add react and @types/react (in case typescript is turned on) as peer dependencies




        * with this SemVer.




        **/
        "version": ">=16.0.0"
      },
      "base/fragments/*": {
        /**




        * main configuration file for handling the build process of components.




        */
        "@teambit/flows": {
          /**




          * configure build tasks. configuration of build tasks is basically a map of `task name`




          * pointed to an array of tasks. each task can be either a bash command or an extension




          * which exposes a task. reserved task names: build, test, runs on pre-tag.




          */
          "tasks": {
            "build": [
              "@teambit/react:build",
              "mv dist dist-copy"
            ],
            "test": [
              "mocha ."
            ],
            "deploy": [
              "firebase deploy"
            ]
          }
        }
      },
      /**




       * configure storybook extension on all ui components. :TODO: @gilad please define config for




       * storybook extension




      */
      "@teambit/storybook": {}
    },
    /**




     * variants can be applied to a component in any namespace level.




     * the configuration below sets all components under `base` to be compatible with all versions of




     * react 15 as well.




    **/
    "ui/base/*": {
      "@teambit/component": {
        "peerDependencies": {
          "react": ">15.0.1"
        }
      }
    },
    "extensions/*": {
      // "@teambit/extension": {
      // need to decide configuration for extension environment.
      // },
      /**




      * configure the creation of new components in your workspace through the `bit create` command.




      * this is helpful for setting component structure standards.




      **/
      "@teambit/create": {
        /**




        * default component template for Bit to use for creation of components upon `bit create`.




        * default template is:




        */
        "defaultTemplate": "@teambit/extension-template"
      }
    }
  }
}