@teambit/workspace-config-files 1.0.381 → 1.0.383

package/artifacts/__bit_junit.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites tests="6" failures="0" errors="0" skipped="0">
-  <testsuite name="teambit.workspace/workspace-config-files@1.0.381" tests="6" failures="0" errors="0" skipped="0">
+  <testsuite name="teambit.workspace/workspace-config-files@1.0.383" tests="6" failures="0" errors="0" skipped="0">
     <testcase classname="dist/dedup-paths.spec.js" name="should reduce files to minimum necessary" time="0.001"/>
     <testcase classname="dist/dedup-paths.spec.js" name="should place files in correct folders"/>
     <testcase classname="dist/dedup-paths.spec.js" name="should reduce files to minimum necessary"/>

package/artifacts/preview/teambit_workspace_workspace_config_files-preview.js

@@ -1 +1 @@
-!function(e,n){"object"==typeof exports&&"object"==typeof module?module.exports=n():"function"==typeof define&&define.amd?define([],n):"object"==typeof exports?exports["teambit.workspace/workspace-config-files-preview"]=n():e["teambit.workspace/workspace-config-files-preview"]=n()}(self,(()=>(()=>{"use strict";var e={d:(n,o)=>{for(var t in o)e.o(o,t)&&!e.o(n,t)&&Object.defineProperty(n,t,{enumerable:!0,get:o[t]})},o:(e,n)=>Object.prototype.hasOwnProperty.call(e,n),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},n={};e.r(n),e.d(n,{compositions:()=>p,compositions_metadata:()=>m,overview:()=>d});var o={};e.r(o),e.d(o,{default:()=>c}),React;const t=MdxJsReact,i=TeambitMdxUiMdxScopeContext;var r=["components"];function a(){return a=Object.assign?Object.assign.bind():function(e){for(var n=1;n<arguments.length;n++){var o=arguments[n];for(var t in o)({}).hasOwnProperty.call(o,t)&&(e[t]=o[t])}return e},a.apply(null,arguments)}var l={},s="wrapper";function c(e){var n=e.components,o=function(e,n){if(null==e)return{};var o,t,i=function(e,n){if(null==e)return{};var o={};for(var t in e)if({}.hasOwnProperty.call(e,t)){if(n.includes(t))continue;o[t]=e[t]}return o}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(t=0;t<r.length;t++)o=r[t],n.includes(o)||{}.propertyIsEnumerable.call(e,o)&&(i[o]=e[o])}return i}(e,r);return(0,t.mdx)(s,a({},l,o,{components:n,mdxType:"MDXLayout"}),(0,t.mdx)(i.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,t.mdx)("p",null,"This aspect provides the ability to write configuration files in the workspace.\nIt provides an API to write configuration files in the workspace, and also provides cli commands to write configuration files."),(0,t.mdx)("h3",null,"Commands"),(0,t.mdx)("p",null,"Main command is ",(0,t.mdx)("inlineCode",{parentName:"p"},"bit ws-config")," which has the following sub commands:"),(0,t.mdx)("ul",null,(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("inlineCode",{parentName:"li"},"bit ws-config write")," - write configuration files according to the components' envs"),(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("inlineCode",{parentName:"li"},"bit ws-config clean")," - remove all configuration files from the workspace"),(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("inlineCode",{parentName:"li"},"bit ws-config list")," - list all registered configuration writers.\nthis is useful for filtering used configuration writers when using the ",(0,t.mdx)("inlineCode",{parentName:"li"},"--writers")," flag in the write/clean commands."))))}c.isMDXComponent=!0;const p=[],d=[o],m={compositions:[]};return n})()));
+!function(e,n){"object"==typeof exports&&"object"==typeof module?module.exports=n():"function"==typeof define&&define.amd?define([],n):"object"==typeof exports?exports["teambit.workspace/workspace-config-files-preview"]=n():e["teambit.workspace/workspace-config-files-preview"]=n()}(self,(()=>(()=>{"use strict";var e={d:(n,o)=>{for(var t in o)e.o(o,t)&&!e.o(n,t)&&Object.defineProperty(n,t,{enumerable:!0,get:o[t]})},o:(e,n)=>Object.prototype.hasOwnProperty.call(e,n),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},n={};e.r(n),e.d(n,{compositions:()=>s,compositions_metadata:()=>c,overview:()=>d});var o={};e.r(o),e.d(o,{default:()=>p}),React;const t=MdxJsReact,a=TeambitMdxUiMdxScopeContext;var i=["components"];function r(){return r=Object.assign?Object.assign.bind():function(e){for(var n=1;n<arguments.length;n++){var o=arguments[n];for(var t in o)({}).hasOwnProperty.call(o,t)&&(e[t]=o[t])}return e},r.apply(null,arguments)}var m={},l="wrapper";function p(e){var n=e.components,o=function(e,n){if(null==e)return{};var o,t,a=function(e,n){if(null==e)return{};var o={};for(var t in e)if({}.hasOwnProperty.call(e,t)){if(n.includes(t))continue;o[t]=e[t]}return o}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(t=0;t<i.length;t++)o=i[t],n.includes(o)||{}.propertyIsEnumerable.call(e,o)&&(a[o]=e[o])}return a}(e,i);return(0,t.mdx)(l,r({},m,o,{components:n,mdxType:"MDXLayout"}),(0,t.mdx)(a.MDXScopeProvider,{components:{},mdxType:"MDXScopeProvider"},(0,t.mdx)("p",null,"This aspect provides the ability to write configuration files in the workspace.\nThe main goal for these config file writers is to ensure that the LSP/IDE produces the same results as running the relevant commands (such as bit lint, bit format, or bit check types/TypeScript during build). It provides an API to write configuration files in the workspace, and also provides CLI commands to do so."),(0,t.mdx)("h3",null,"Commands"),(0,t.mdx)("p",null,"Main command is ",(0,t.mdx)("inlineCode",{parentName:"p"},"bit ws-config")," which has the following sub commands:"),(0,t.mdx)("ul",null,(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("inlineCode",{parentName:"li"},"bit ws-config write")," - write configuration files according to the components' envs"),(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("inlineCode",{parentName:"li"},"bit ws-config clean")," - remove all configuration files from the workspace"),(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("inlineCode",{parentName:"li"},"bit ws-config list")," - list all registered configuration writers.\nthis is useful for filtering used configuration writers when using the ",(0,t.mdx)("inlineCode",{parentName:"li"},"--writers")," flag in the write/clean commands.")),(0,t.mdx)("h3",null,"How it works"),(0,t.mdx)("p",null,(0,t.mdx)("strong",{parentName:"p"},"Background:")),(0,t.mdx)("p",null,"Bit structures its workspaces in a manner that, while reminiscent of monorepos, introduces additional complexities:"),(0,t.mdx)("ol",null,(0,t.mdx)("li",{parentName:"ol"},(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("strong",{parentName:"p"},"Component Isolation:")," Each component behaves as an isolated package with its own ",(0,t.mdx)("inlineCode",{parentName:"p"},"package.json")," and configuration files (like ",(0,t.mdx)("inlineCode",{parentName:"p"},"tsconfig"),", ",(0,t.mdx)("inlineCode",{parentName:"p"},"eslint"),", ",(0,t.mdx)("inlineCode",{parentName:"p"},"prettier"),", ",(0,t.mdx)("inlineCode",{parentName:"p"},"jest"),", etc.). Some components might share configurations.")),(0,t.mdx)("li",{parentName:"ol"},(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("strong",{parentName:"p"},"Directory Structure Example:")),(0,t.mdx)("pre",{parentName:"li"},(0,t.mdx)("code",{parentName:"pre"},"- Root\n    - node_modules\n        - React-env\n            - config1\n        - Node-env\n            - config2\n        - Lit-env\n            - config3\n    - Users-domain\n        - React-comp1\n        - React-comp2\n        - Node-comp1\n    - Ecommerce-domain\n        - React-comp3\n        - React-comp4\n        - Node-comp1\n        - Node-comp2\n        - Lit-comp1\n        - Lit-comp2\n        - Lit-comp3\n")),(0,t.mdx)("ul",{parentName:"li"},(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("strong",{parentName:"li"},"Observations:"),(0,t.mdx)("ul",{parentName:"li"},(0,t.mdx)("li",{parentName:"ul"},"Sibling directories may require different configs at any hierarchy level."),(0,t.mdx)("li",{parentName:"ul"},"Components across different domains might share the same config."),(0,t.mdx)("li",{parentName:"ul"},"Actual config files reside within ",(0,t.mdx)("inlineCode",{parentName:"li"},"node_modules")," packages, not directly in the source folders.")))))),(0,t.mdx)("p",null,(0,t.mdx)("strong",{parentName:"p"},"Flow:")),(0,t.mdx)("ol",null,(0,t.mdx)("li",{parentName:"ol"},(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("strong",{parentName:"p"},"Determining Config Associations:")),(0,t.mdx)("ul",{parentName:"li"},(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("strong",{parentName:"li"},"Step 1:")," Identify the relevant config files for each component (e.g., for ESLint)."),(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("strong",{parentName:"li"},"Step 2:")," Group components sharing the same config."),(0,t.mdx)("li",{parentName:"ul"},(0,t.mdx)("strong",{parentName:"li"},"Step 3:")," Map the relevant paths for each config.")),(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("em",{parentName:"p"},"Example Outcome:")),(0,t.mdx)("pre",{parentName:"li"},(0,t.mdx)("code",{parentName:"pre",className:"language-json"},'{\n  "Config1": [\n    "users-domain/react-comp1",\n    "users-domain/react-comp2",\n    "ecommerce-domain/react-comp3",\n    "ecommerce-domain/react-comp4"\n  ],\n  "Config2": ["..."],\n  "Config3": ["..."]\n}\n'))),(0,t.mdx)("li",{parentName:"ol"},(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("strong",{parentName:"p"},"Optimizing Config File Placement:")),(0,t.mdx)("ul",{parentName:"li"},(0,t.mdx)("li",{parentName:"ul"},"Develop an algorithm to determine optimal locations for generated config files, minimizing workspace pollution.")),(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("em",{parentName:"p"},"Example Outcome:")),(0,t.mdx)("pre",{parentName:"li"},(0,t.mdx)("code",{parentName:"pre",className:"language-json"},'{\n  "root": "generated-config1", // Predominantly React components\n  "users-domain": "generated-config2", // Exclusively Node components\n  "ecommerce-domain": "generated-config3",\n  "ecommerce-domain/node-comp1": "generated-config2",\n  "ecommerce-domain/node-comp2": "generated-config2"\n}\n'))),(0,t.mdx)("li",{parentName:"ol"},(0,t.mdx)("p",{parentName:"li"},(0,t.mdx)("strong",{parentName:"p"},"Filesystem Structure:")),(0,t.mdx)("pre",{parentName:"li"},(0,t.mdx)("code",{parentName:"pre"},"- Root\n    - node_modules\n        - .config-files-dir\n            - Config1.<hash>.js\n            - Config2.<hash>.js\n            - Config3.<hash>.js\n- generated-config1\n- ...\n")),(0,t.mdx)("p",{parentName:"li"},"Each ",(0,t.mdx)("inlineCode",{parentName:"p"},"generated-config")," extends its respective config file:"),(0,t.mdx)("pre",{parentName:"li"},(0,t.mdx)("code",{parentName:"pre",className:"language-json"},'{\n  "extends": ["./node_modules/.config-files-dir/.eslintrc.bit.<hash>.json"]\n}\n'))))))}p.isMDXComponent=!0;const s=[],d=[o],c={compositions:[]};return n})()));

package/artifacts/schema.json

@@ -7056,7 +7056,7 @@
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.381"
+    "version": "1.0.383"
   },
   "taggedModuleExports": []
 }

package/dist/{preview-1723519217877.js → preview-1724037552319.js}

@@ -1,5 +1,5 @@
 ;
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.workspace_workspace-config-files@1.0.381/dist/workspace-config-files.docs.mdx';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.workspace_workspace-config-files@1.0.383/dist/workspace-config-files.docs.mdx';
 
 export const compositions = [];
 export const overview = [overview_0];

package/dist/workspace-config-files.docs.mdx

@@ -4,7 +4,7 @@ labels: ['core aspect', 'cli', 'configuration', 'workspace']
 ---
 
 This aspect provides the ability to write configuration files in the workspace.
-It provides an API to write configuration files in the workspace, and also provides cli commands to write configuration files.
+The main goal for these config file writers is to ensure that the LSP/IDE produces the same results as running the relevant commands (such as bit lint, bit format, or bit check types/TypeScript during build). It provides an API to write configuration files in the workspace, and also provides CLI commands to do so.
 
 ### Commands
 
@@ -14,3 +14,101 @@ Main command is `bit ws-config` which has the following sub commands:
 - `bit ws-config clean` - remove all configuration files from the workspace
 - `bit ws-config list` - list all registered configuration writers.
   this is useful for filtering used configuration writers when using the `--writers` flag in the write/clean commands.
+
+### How it works
+
+**Background:**
+
+Bit structures its workspaces in a manner that, while reminiscent of monorepos, introduces additional complexities:
+
+1. **Component Isolation:** Each component behaves as an isolated package with its own `package.json` and configuration files (like `tsconfig`, `eslint`, `prettier`, `jest`, etc.). Some components might share configurations.
+
+2. **Directory Structure Example:**
+
+   ```
+   - Root
+       - node_modules
+           - React-env
+               - config1
+           - Node-env
+               - config2
+           - Lit-env
+               - config3
+       - Users-domain
+           - React-comp1
+           - React-comp2
+           - Node-comp1
+       - Ecommerce-domain
+           - React-comp3
+           - React-comp4
+           - Node-comp1
+           - Node-comp2
+           - Lit-comp1
+           - Lit-comp2
+           - Lit-comp3
+   ```
+
+   - **Observations:**
+     - Sibling directories may require different configs at any hierarchy level.
+     - Components across different domains might share the same config.
+     - Actual config files reside within `node_modules` packages, not directly in the source folders.
+
+**Flow:**
+
+1. **Determining Config Associations:**
+
+   - **Step 1:** Identify the relevant config files for each component (e.g., for ESLint).
+   - **Step 2:** Group components sharing the same config.
+   - **Step 3:** Map the relevant paths for each config.
+
+   _Example Outcome:_
+
+   ```json
+   {
+     "Config1": [
+       "users-domain/react-comp1",
+       "users-domain/react-comp2",
+       "ecommerce-domain/react-comp3",
+       "ecommerce-domain/react-comp4"
+     ],
+     "Config2": ["..."],
+     "Config3": ["..."]
+   }
+   ```
+
+2. **Optimizing Config File Placement:**
+
+   - Develop an algorithm to determine optimal locations for generated config files, minimizing workspace pollution.
+
+   _Example Outcome:_
+
+   ```json
+   {
+     "root": "generated-config1", // Predominantly React components
+     "users-domain": "generated-config2", // Exclusively Node components
+     "ecommerce-domain": "generated-config3",
+     "ecommerce-domain/node-comp1": "generated-config2",
+     "ecommerce-domain/node-comp2": "generated-config2"
+   }
+   ```
+
+3. **Filesystem Structure:**
+
+   ```
+   - Root
+       - node_modules
+           - .config-files-dir
+               - Config1.<hash>.js
+               - Config2.<hash>.js
+               - Config3.<hash>.js
+   - generated-config1
+   - ...
+   ```
+
+   Each `generated-config` extends its respective config file:
+
+   ```json
+   {
+     "extends": ["./node_modules/.config-files-dir/.eslintrc.bit.<hash>.json"]
+   }
+   ```

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace-config-files",
-  "version": "1.0.381",
+  "version": "1.0.383",
   "homepage": "https://bit.cloud/teambit/workspace/workspace-config-files",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.381"
+    "version": "1.0.383"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -19,12 +19,12 @@
     "string-format": "0.5.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/envs": "1.0.381",
+    "@teambit/envs": "1.0.383",
     "@teambit/toolbox.path.path": "0.0.2",
-    "@teambit/cli": "0.0.958",
+    "@teambit/cli": "0.0.960",
     "@teambit/legacy.cli.prompts": "0.0.1",
-    "@teambit/logger": "0.0.1051",
-    "@teambit/workspace": "1.0.381",
+    "@teambit/logger": "0.0.1053",
+    "@teambit/workspace": "1.0.383",
     "@teambit/toolbox.crypto.sha1": "0.0.1"
   },
   "devDependencies": {
@@ -34,7 +34,7 @@
     "@types/fs-extra": "9.0.7",
     "@types/normalize-path": "^3.0.0",
     "@types/mocha": "9.1.0",
-    "@teambit/harmony.envs.core-aspect-env": "0.0.42"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.47"
   },
   "peerDependencies": {
     "@teambit/legacy": "1.0.624"

package/workspace-config-files.docs.mdx

@@ -4,7 +4,7 @@ labels: ['core aspect', 'cli', 'configuration', 'workspace']
 ---
 
 This aspect provides the ability to write configuration files in the workspace.
-It provides an API to write configuration files in the workspace, and also provides cli commands to write configuration files.
+The main goal for these config file writers is to ensure that the LSP/IDE produces the same results as running the relevant commands (such as bit lint, bit format, or bit check types/TypeScript during build). It provides an API to write configuration files in the workspace, and also provides CLI commands to do so.
 
 ### Commands
 
@@ -14,3 +14,101 @@ Main command is `bit ws-config` which has the following sub commands:
 - `bit ws-config clean` - remove all configuration files from the workspace
 - `bit ws-config list` - list all registered configuration writers.
   this is useful for filtering used configuration writers when using the `--writers` flag in the write/clean commands.
+
+### How it works
+
+**Background:**
+
+Bit structures its workspaces in a manner that, while reminiscent of monorepos, introduces additional complexities:
+
+1. **Component Isolation:** Each component behaves as an isolated package with its own `package.json` and configuration files (like `tsconfig`, `eslint`, `prettier`, `jest`, etc.). Some components might share configurations.
+
+2. **Directory Structure Example:**
+
+   ```
+   - Root
+       - node_modules
+           - React-env
+               - config1
+           - Node-env
+               - config2
+           - Lit-env
+               - config3
+       - Users-domain
+           - React-comp1
+           - React-comp2
+           - Node-comp1
+       - Ecommerce-domain
+           - React-comp3
+           - React-comp4
+           - Node-comp1
+           - Node-comp2
+           - Lit-comp1
+           - Lit-comp2
+           - Lit-comp3
+   ```
+
+   - **Observations:**
+     - Sibling directories may require different configs at any hierarchy level.
+     - Components across different domains might share the same config.
+     - Actual config files reside within `node_modules` packages, not directly in the source folders.
+
+**Flow:**
+
+1. **Determining Config Associations:**
+
+   - **Step 1:** Identify the relevant config files for each component (e.g., for ESLint).
+   - **Step 2:** Group components sharing the same config.
+   - **Step 3:** Map the relevant paths for each config.
+
+   _Example Outcome:_
+
+   ```json
+   {
+     "Config1": [
+       "users-domain/react-comp1",
+       "users-domain/react-comp2",
+       "ecommerce-domain/react-comp3",
+       "ecommerce-domain/react-comp4"
+     ],
+     "Config2": ["..."],
+     "Config3": ["..."]
+   }
+   ```
+
+2. **Optimizing Config File Placement:**
+
+   - Develop an algorithm to determine optimal locations for generated config files, minimizing workspace pollution.
+
+   _Example Outcome:_
+
+   ```json
+   {
+     "root": "generated-config1", // Predominantly React components
+     "users-domain": "generated-config2", // Exclusively Node components
+     "ecommerce-domain": "generated-config3",
+     "ecommerce-domain/node-comp1": "generated-config2",
+     "ecommerce-domain/node-comp2": "generated-config2"
+   }
+   ```
+
+3. **Filesystem Structure:**
+
+   ```
+   - Root
+       - node_modules
+           - .config-files-dir
+               - Config1.<hash>.js
+               - Config2.<hash>.js
+               - Config3.<hash>.js
+   - generated-config1
+   - ...
+   ```
+
+   Each `generated-config` extends its respective config file:
+
+   ```json
+   {
+     "extends": ["./node_modules/.config-files-dir/.eslintrc.bit.<hash>.json"]
+   }
+   ```

package/tsconfig.json

@@ -1,39 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": [
-      "esnext",
-      "dom",
-      "dom.Iterable"
-    ],
-    "target": "es2020",
-    "module": "es2020",
-    "jsx": "react-jsx",
-    "declaration": true,
-    "sourceMap": true,
-    "experimentalDecorators": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "allowJs": true,
-    "outDir": "dist",
-    "emitDeclarationOnly": true,
-    "strict": true,
-    "strictPropertyInitialization": false,
-    "noImplicitAny": false
-  },
-  "exclude": [
-    "artifacts",
-    "public",
-    "dist",
-    "node_modules",
-    "package.json",
-    "esm.mjs",
-    "**/*.cjs",
-    "./dist"
-  ],
-  "include": [
-    "**/*",
-    "**/*.json"
-  ]
-}