@teambit/workspace-config-files 1.0.227 → 1.0.229

package/artifacts/__bit_junit.xml

@@ -1,10 +1,10 @@
 <?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.227" tests="6" failures="0" errors="0" skipped="0">
+  <testsuite name="teambit.workspace/workspace-config-files@1.0.229" 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"/>
-    <testcase classname="dist/dedup-paths.spec.js" name="should place files in correct folders" 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"/>
     <testcase classname="dist/dedup-paths.spec.js" name="should place files in correct folders"/>
   </testsuite>

package/artifacts/schema.json

@@ -48,7 +48,11 @@
                     "line": 102,
                     "character": 24
                   },
-                  "name": "Workspace"
+                  "name": "Workspace",
+                  "componentId": {
+                    "scope": "teambit.workspace",
+                    "name": "workspace"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -68,7 +72,11 @@
                     "line": 103,
                     "character": 19
                   },
-                  "name": "EnvsMain"
+                  "name": "EnvsMain",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -88,7 +96,11 @@
                     "line": 104,
                     "character": 21
                   },
-                  "name": "Logger"
+                  "name": "Logger",
+                  "componentId": {
+                    "scope": "teambit.harmony",
+                    "name": "logger"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -108,7 +120,8 @@
                     "line": 105,
                     "character": 21
                   },
-                  "name": "WorkspaceConfigFilesAspectConfig"
+                  "name": "WorkspaceConfigFilesAspectConfig",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -159,7 +172,8 @@
                       "line": 111,
                       "character": 14
                     },
-                    "name": "WriteConfigFilesOptions"
+                    "name": "WriteConfigFilesOptions",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   }
                 },
                 {
@@ -192,7 +206,8 @@
                     "line": 120,
                     "character": 35
                   },
-                  "name": "WriteConfigFilesOptions"
+                  "name": "WriteConfigFilesOptions",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 },
                 "isOptional": true,
                 "defaultValue": "{}",
@@ -258,7 +273,8 @@
                     "line": 171,
                     "character": 44
                   },
-                  "name": "WriteConfigFilesOptions"
+                  "name": "WriteConfigFilesOptions",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 },
                 "isOptional": true,
                 "defaultValue": "{}",
@@ -342,7 +358,8 @@
                       "line": 180,
                       "character": 14
                     },
-                    "name": "CleanConfigFilesOptions"
+                    "name": "CleanConfigFilesOptions",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   }
                 },
                 {
@@ -375,7 +392,8 @@
                     "line": 183,
                     "character": 35
                   },
-                  "name": "CleanConfigFilesOptions"
+                  "name": "CleanConfigFilesOptions",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 },
                 "isOptional": true,
                 "defaultValue": "{}",
@@ -505,7 +523,8 @@
                     "line": 205,
                     "character": 38
                   },
-                  "name": "EnvConfigWritersList"
+                  "name": "EnvConfigWritersList",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 }
               ]
             },
@@ -580,7 +599,8 @@
                     "line": 343,
                     "character": 44
                   },
-                  "name": "WriteConfigFilesOptions"
+                  "name": "WriteConfigFilesOptions",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 },
                 "isOptional": false,
                 "objectBindingNodes": [
@@ -762,7 +782,8 @@
                     "line": 410,
                     "character": 33
                   },
-                  "name": "WorkspaceConfigFilesAspectConfig"
+                  "name": "WorkspaceConfigFilesAspectConfig",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 }
               ]
             },
@@ -802,7 +823,11 @@
                         "line": 415,
                         "character": 44
                       },
-                      "name": "CLIMain"
+                      "name": "CLIMain",
+                      "componentId": {
+                        "scope": "teambit.harmony",
+                        "name": "cli"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -811,7 +836,11 @@
                         "line": 415,
                         "character": 53
                       },
-                      "name": "Workspace"
+                      "name": "Workspace",
+                      "componentId": {
+                        "scope": "teambit.workspace",
+                        "name": "workspace"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -820,7 +849,11 @@
                         "line": 415,
                         "character": 64
                       },
-                      "name": "EnvsMain"
+                      "name": "EnvsMain",
+                      "componentId": {
+                        "scope": "teambit.envs",
+                        "name": "envs"
+                      }
                     },
                     {
                       "__schema": "TypeRefSchema",
@@ -829,7 +862,11 @@
                         "line": 415,
                         "character": 74
                       },
-                      "name": "LoggerMain"
+                      "name": "LoggerMain",
+                      "componentId": {
+                        "scope": "teambit.harmony",
+                        "name": "logger"
+                      }
                     }
                   ]
                 },
@@ -851,7 +888,8 @@
                     "line": 416,
                     "character": 13
                   },
-                  "name": "WorkspaceConfigFilesAspectConfig"
+                  "name": "WorkspaceConfigFilesAspectConfig",
+                  "internalFilePath": "workspace-config-files.main.runtime.ts"
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -1507,7 +1545,11 @@
                     "line": 97,
                     "character": 23
                   },
-                  "name": "ExecutionContext"
+                  "name": "ExecutionContext",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -1527,7 +1569,11 @@
                     "line": 98,
                     "character": 10
                   },
-                  "name": "Environment"
+                  "name": "Environment",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -1659,7 +1705,8 @@
                 "line": 110,
                 "character": 22
               },
-              "name": "MergeConfigFilesFunc"
+              "name": "MergeConfigFilesFunc",
+              "internalFilePath": "config-writer-entry.ts"
             },
             "isOptional": true
           },
@@ -1829,7 +1876,8 @@
                             "line": 134,
                             "character": 29
                           },
-                          "name": "PostProcessExtendingConfigFilesOneFile"
+                          "name": "PostProcessExtendingConfigFilesOneFile",
+                          "internalFilePath": "config-writer-entry.ts"
                         }
                       ]
                     },
@@ -2018,7 +2066,8 @@
                 "line": 34,
                 "character": 48
               },
-              "name": "ExtendingConfigFileAdditionalProp"
+              "name": "ExtendingConfigFileAdditionalProp",
+              "internalFilePath": "config-writer-entry.ts"
             }
           ]
         }
@@ -2381,7 +2430,8 @@
                     "line": 57,
                     "character": 23
                   },
-                  "name": "WrittenConfigFile"
+                  "name": "WrittenConfigFile",
+                  "internalFilePath": "writers/real-config-files.ts"
                 }
               },
               "isOptional": false
@@ -2443,6 +2493,10 @@
                   "character": 12
                 },
                 "name": "EnvHandler",
+                "componentId": {
+                  "scope": "teambit.envs",
+                  "name": "envs"
+                },
                 "typeArgs": [
                   {
                     "__schema": "TypeRefSchema",
@@ -2901,7 +2955,11 @@
                     "line": 76,
                     "character": 20
                   },
-                  "name": "EnvContext"
+                  "name": "EnvContext",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  }
                 },
                 "isOptional": false,
                 "isSpread": false
@@ -3301,7 +3359,8 @@
                   "line": 53,
                   "character": 42
                 },
-                "name": "EnvConfigWriter"
+                "name": "EnvConfigWriter",
+                "internalFilePath": "workspace-config-files.main.runtime.ts"
               }
             ]
           }
@@ -4149,7 +4208,11 @@
                       "line": 102,
                       "character": 24
                     },
-                    "name": "Workspace"
+                    "name": "Workspace",
+                    "componentId": {
+                      "scope": "teambit.workspace",
+                      "name": "workspace"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -4169,7 +4232,11 @@
                       "line": 103,
                       "character": 19
                     },
-                    "name": "EnvsMain"
+                    "name": "EnvsMain",
+                    "componentId": {
+                      "scope": "teambit.envs",
+                      "name": "envs"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -4189,7 +4256,11 @@
                       "line": 104,
                       "character": 21
                     },
-                    "name": "Logger"
+                    "name": "Logger",
+                    "componentId": {
+                      "scope": "teambit.harmony",
+                      "name": "logger"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -4209,7 +4280,8 @@
                       "line": 105,
                       "character": 21
                     },
-                    "name": "WorkspaceConfigFilesAspectConfig"
+                    "name": "WorkspaceConfigFilesAspectConfig",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -4260,7 +4332,8 @@
                         "line": 111,
                         "character": 14
                       },
-                      "name": "WriteConfigFilesOptions"
+                      "name": "WriteConfigFilesOptions",
+                      "internalFilePath": "workspace-config-files.main.runtime.ts"
                     }
                   },
                   {
@@ -4293,7 +4366,8 @@
                       "line": 120,
                       "character": 35
                     },
-                    "name": "WriteConfigFilesOptions"
+                    "name": "WriteConfigFilesOptions",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   },
                   "isOptional": true,
                   "defaultValue": "{}",
@@ -4359,7 +4433,8 @@
                       "line": 171,
                       "character": 44
                     },
-                    "name": "WriteConfigFilesOptions"
+                    "name": "WriteConfigFilesOptions",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   },
                   "isOptional": true,
                   "defaultValue": "{}",
@@ -4443,7 +4518,8 @@
                         "line": 180,
                         "character": 14
                       },
-                      "name": "CleanConfigFilesOptions"
+                      "name": "CleanConfigFilesOptions",
+                      "internalFilePath": "workspace-config-files.main.runtime.ts"
                     }
                   },
                   {
@@ -4476,7 +4552,8 @@
                       "line": 183,
                       "character": 35
                     },
-                    "name": "CleanConfigFilesOptions"
+                    "name": "CleanConfigFilesOptions",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   },
                   "isOptional": true,
                   "defaultValue": "{}",
@@ -4606,7 +4683,8 @@
                       "line": 205,
                       "character": 38
                     },
-                    "name": "EnvConfigWritersList"
+                    "name": "EnvConfigWritersList",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   }
                 ]
               },
@@ -4681,7 +4759,8 @@
                       "line": 343,
                       "character": 44
                     },
-                    "name": "WriteConfigFilesOptions"
+                    "name": "WriteConfigFilesOptions",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   },
                   "isOptional": false,
                   "objectBindingNodes": [
@@ -4863,7 +4942,8 @@
                       "line": 410,
                       "character": 33
                     },
-                    "name": "WorkspaceConfigFilesAspectConfig"
+                    "name": "WorkspaceConfigFilesAspectConfig",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   }
                 ]
               },
@@ -4903,7 +4983,11 @@
                           "line": 415,
                           "character": 44
                         },
-                        "name": "CLIMain"
+                        "name": "CLIMain",
+                        "componentId": {
+                          "scope": "teambit.harmony",
+                          "name": "cli"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -4912,7 +4996,11 @@
                           "line": 415,
                           "character": 53
                         },
-                        "name": "Workspace"
+                        "name": "Workspace",
+                        "componentId": {
+                          "scope": "teambit.workspace",
+                          "name": "workspace"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -4921,7 +5009,11 @@
                           "line": 415,
                           "character": 64
                         },
-                        "name": "EnvsMain"
+                        "name": "EnvsMain",
+                        "componentId": {
+                          "scope": "teambit.envs",
+                          "name": "envs"
+                        }
                       },
                       {
                         "__schema": "TypeRefSchema",
@@ -4930,7 +5022,11 @@
                           "line": 415,
                           "character": 74
                         },
-                        "name": "LoggerMain"
+                        "name": "LoggerMain",
+                        "componentId": {
+                          "scope": "teambit.harmony",
+                          "name": "logger"
+                        }
                       }
                     ]
                   },
@@ -4952,7 +5048,8 @@
                       "line": 416,
                       "character": 13
                     },
-                    "name": "WorkspaceConfigFilesAspectConfig"
+                    "name": "WorkspaceConfigFilesAspectConfig",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -5046,7 +5143,8 @@
                       "line": 50,
                       "character": 23
                     },
-                    "name": "EnvConfigWriterEntry"
+                    "name": "EnvConfigWriterEntry",
+                    "internalFilePath": "workspace-config-files.main.runtime.ts"
                   }
                 }
               }
@@ -5297,7 +5395,8 @@
                   "line": 34,
                   "character": 48
                 },
-                "name": "ExtendingConfigFileAdditionalProp"
+                "name": "ExtendingConfigFileAdditionalProp",
+                "internalFilePath": "config-writer-entry.ts"
               }
             ]
           }
@@ -5550,7 +5649,8 @@
                       "line": 57,
                       "character": 23
                     },
-                    "name": "WrittenConfigFile"
+                    "name": "WrittenConfigFile",
+                    "internalFilePath": "writers/real-config-files.ts"
                   }
                 },
                 "isOptional": false
@@ -5827,7 +5927,11 @@
                       "line": 97,
                       "character": 23
                     },
-                    "name": "ExecutionContext"
+                    "name": "ExecutionContext",
+                    "componentId": {
+                      "scope": "teambit.envs",
+                      "name": "envs"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -5847,7 +5951,11 @@
                       "line": 98,
                       "character": 10
                     },
-                    "name": "Environment"
+                    "name": "Environment",
+                    "componentId": {
+                      "scope": "teambit.envs",
+                      "name": "envs"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -5979,7 +6087,8 @@
                   "line": 110,
                   "character": 22
                 },
-                "name": "MergeConfigFilesFunc"
+                "name": "MergeConfigFilesFunc",
+                "internalFilePath": "config-writer-entry.ts"
               },
               "isOptional": true
             },
@@ -6149,7 +6258,8 @@
                               "line": 134,
                               "character": 29
                             },
-                            "name": "PostProcessExtendingConfigFilesOneFile"
+                            "name": "PostProcessExtendingConfigFilesOneFile",
+                            "internalFilePath": "config-writer-entry.ts"
                           }
                         ]
                       },
@@ -6350,6 +6460,10 @@
                     "character": 12
                   },
                   "name": "EnvHandler",
+                  "componentId": {
+                    "scope": "teambit.envs",
+                    "name": "envs"
+                  },
                   "typeArgs": [
                     {
                       "__schema": "TypeRefSchema",
@@ -6764,7 +6878,11 @@
                       "line": 76,
                       "character": 20
                     },
-                    "name": "EnvContext"
+                    "name": "EnvContext",
+                    "componentId": {
+                      "scope": "teambit.envs",
+                      "name": "envs"
+                    }
                   },
                   "isOptional": false,
                   "isSpread": false
@@ -6889,7 +7007,7 @@
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.227"
+    "version": "1.0.229"
   },
   "taggedModuleExports": []
 }

package/dist/config-writer-entry.d.ts

@@ -0,0 +1,129 @@
+import { Environment, ExecutionContext } from '@teambit/envs';
+import { EnvMapValue } from './workspace-config-files.main.runtime';
+import { WrittenConfigFile } from './writers';
+export type ConfigFile = {
+    /**
+     * Name of the config file.
+     * supports also using `{hash}` in the name, which will be replaced by the hash of the config file.
+     */
+    name: string;
+    /**
+     * Content of the config file.
+     * I.E the content of the tsconfig.json file.
+     */
+    content: string;
+    /**
+     * Hash of the config file.
+     */
+    hash?: string;
+};
+export type ExtendingConfigFileAdditionalProp = {
+    /**
+     * the config file that this config file extends.
+     */
+    extendingTarget: WrittenConfigFile;
+    /**
+     * When replacing the config file name with the actual path of the config file, use absolute paths.
+     */
+    useAbsPaths?: boolean;
+};
+export type ExtendingConfigFile = ConfigFile & ExtendingConfigFileAdditionalProp;
+export type PostProcessExtendingConfigFilesArgs = {
+    workspaceDir: string;
+    configsRootDir: string;
+    extendingConfigFile: ExtendingConfigFile;
+    /**
+     * Paths that the file will be written to.
+     */
+    paths: string[];
+    envMapValue: EnvMapValue;
+    /**
+     * This is a flag for backward compatibility
+     * We used to return string from the post process, so old versions of bit only knows to handle string results
+     * while in new version we support getting array of objects
+     * we need to know if bit the user is using support the new format or not
+     */
+    supportSpecificPathChange?: boolean;
+};
+export type GenerateExtendingConfigFilesArgs = {
+    workspaceDir: string;
+    configsRootDir: string;
+    writtenConfigFiles: WrittenConfigFile[];
+    envMapValue: EnvMapValue;
+};
+export type PostProcessExtendingConfigFilesOneFile = {
+    path: string;
+    content: string;
+};
+export type MergeConfigFilesFunc = (configFile: ConfigFile, configFile2: ConfigFile) => string;
+export interface ConfigWriterEntry {
+    /**
+     * Id is used for few things:
+     * 1. merge/post process different configs files (from different envs) together.
+     * 2. filter the config writer by the cli when using --writers flag.
+     */
+    id: string;
+    /**
+     * Name of the config writer.
+     * used for outputs and logging.
+     */
+    name: string;
+    /**
+     * Get's the component env and return the config file content
+     * for example the eslint config to tsconfig.
+     * This also enable to return a hash of the config file, which will be used to determine if
+     * 2 config files are the same.
+     * If the hash is not provided, the content will be used as the hash.
+     * This enables the specific config type to ignore specific fields when calculating the
+     * hash in order to ignore theses fields when determining if 2 config files are the same.
+     * The calc function also get the target directory of the config file (calculated by this aspect) as sometime there
+     * is a need to change the config file content based on the target directory.
+     * for example, change the includes/excludes paths to be relative to the target directory.
+     * The calc can return undefined if the config file is not relevant for the component. or not supported by the subscriber.
+     * for example if the component uses babel to compile, then tsconfig is not relevant.
+     * @param env
+     */
+    calcConfigFiles(executionContext: ExecutionContext, env: Environment, dir: string, workspaceDir?: string): ConfigFile[] | undefined;
+    /**
+     * Provide a function that knows how to merge 2 config files together.
+     * This is used when 2 different envs generate the same config file hash.
+     * sometime we want to merge the 2 config files together.
+     * @param configFile
+     * @param configFile2
+     */
+    mergeConfigFiles?: MergeConfigFilesFunc;
+    /**
+     * This will be used to generate an extending file content.
+     * For example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).
+     * That way we can avoid writing the same config file multiple times.
+     * It also reduces the risk of the user manually change the config file and then the changes will be lost.
+     * This function support returning a file with content with a dsl using `{}` to replace the config file name.
+     * for example:
+     * content = `{
+     *   "extends": {configFile.name},
+     * }`
+     */
+    generateExtendingFile(args: GenerateExtendingConfigFilesArgs): ExtendingConfigFile | undefined;
+    /**
+     * This enables the writer to do some post processing after the extending config files were calculated and deduped.
+     * this is important in case when we need to change a config file / extending config file after it was calculated
+     * based on all the environments in the ws
+     * or based on other config files that were written.
+     * @param args
+     */
+    postProcessExtendingConfigFiles?(args: PostProcessExtendingConfigFilesArgs): Promise<string | Array<PostProcessExtendingConfigFilesOneFile> | undefined>;
+    /**
+     * Find all the files that are relevant for the config type.
+     * This is used to clean / delete these files
+     * This should return an array of glob patterns (that will passed to the globby/minimatch library)
+     * @param dir
+     */
+    patterns: string[];
+    /**
+     * A function to determine if a file was generated by bit.
+     * This is useful to check if the config file was generated by bit to prevent delete user's file.
+     * @param filePath
+     * @returns
+     */
+    isBitGenerated?: (filePath: string) => boolean;
+}

package/dist/config-writer-list.d.ts

@@ -0,0 +1,41 @@
+import { EnvContext, EnvHandler } from '@teambit/envs';
+import { ConfigWriterEntry } from './config-writer-entry';
+export type ConfigWriterHandler = {
+    handler: EnvHandler<ConfigWriterEntry>;
+    name: string;
+};
+/**
+ * create and maintain config writer list for component dev environments.
+ */
+export declare class ConfigWriterList {
+    private _writers;
+    constructor(_writers: ConfigWriterHandler[]);
+    /**
+     * list all congig writer handlers in the list.
+     */
+    get writers(): ConfigWriterHandler[];
+    private initiateWriters;
+    /**
+     * add writers to the list.
+     */
+    add(writers: ConfigWriterHandler[]): this;
+    /**
+     * remove writers from the list.
+     */
+    remove(writerNames: string[]): this;
+    /**
+     * replace writers in the list.
+     */
+    replace(writers: ConfigWriterHandler[]): this;
+    /**
+     * return a new list with the writers from the args added.
+     * @param pipeline
+     * @returns
+     */
+    concat(writerList: ConfigWriterList): ConfigWriterList;
+    /**
+     * compute the list.
+     */
+    compute(context: EnvContext): ConfigWriterEntry[];
+    static from(writersHandlers: ConfigWriterHandler[]): ConfigWriterList;
+}

package/dist/dedup-paths.d.ts

@@ -0,0 +1,29 @@
+import { CompPathExtendingHashMap, EnvCompsDirsMap } from './workspace-config-files.main.runtime';
+import { ExtendingConfigFilesMap } from './writers';
+export type DedupedPaths = Array<{
+    fileHash: string;
+    paths: string[];
+}>;
+export declare function buildCompPathExtendingHashMap(extendingConfigFilesMap: ExtendingConfigFilesMap, envCompsDirsMap: EnvCompsDirsMap): CompPathExtendingHashMap;
+/**
+ * easier to understand by an example:
+ * input:
+ * [
+ *   { fileHash: hash1, paths: [ui/button, ui/form] },
+ *   { fileHash: hash2, paths: [p/a1, p/a2] },
+ *   { fileHash: hash3, paths: [p/n1] },
+ * ]
+ *
+ * output:
+ * [
+ *   { fileHash: hash1, paths: [ui] },
+ *   { fileHash: hash2, paths: [p] },
+ *   { fileHash: hash3, paths: [p/n1] },
+ * ]
+ *
+ * the goal is to minimize the amount of files to write per env if possible.
+ * when multiple components of the same env share a root-dir, then, it's enough to write a file in that shared dir.
+ * if in a shared-dir, some components using env1 and some env2, it finds the env that has the max number of
+ * components, this env will be optimized. other components, will have the files written inside their dirs.
+ */
+export declare function dedupePaths(extendingConfigFilesMap: ExtendingConfigFilesMap, envCompsDirsMap: EnvCompsDirsMap): DedupedPaths;

package/dist/dedup-paths.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/exceptions/write-failed.d.ts

@@ -0,0 +1,4 @@
+import { BitError } from '@teambit/bit-error';
+export default class WriteConfigFilesFailed extends BitError {
+    constructor();
+}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { WorkspaceConfigFilesAspect } from './workspace-config-files.aspect';
+export type { WorkspaceConfigFilesMain, WriteConfigFilesResult, EnvCompsDirsMap, EnvMapValue, OneConfigWriterIdResult, WriteResults, } from './workspace-config-files.main.runtime';
+export type { ConfigWriterEntry, ExtendingConfigFile, ConfigFile, PostProcessExtendingConfigFilesArgs, GenerateExtendingConfigFilesArgs, } from './config-writer-entry';
+export type { ConfigWriterHandler } from './config-writer-list';
+export type { WorkspaceConfigEnv } from './workspace-config-env-type';
+export { ConfigWriterList } from './config-writer-list';
+export default WorkspaceConfigFilesAspect;
+export { WorkspaceConfigFilesAspect };

package/dist/outputs/format-clean-output.d.ts

@@ -0,0 +1,2 @@
+import type { CleanConfigCmdFlags } from '../ws-config.cmd';
+export declare function formatCleanOutput(cleanResults: string[] | undefined, flags: CleanConfigCmdFlags): string;

package/dist/outputs/format-list-output.d.ts

@@ -0,0 +1,2 @@
+import { EnvConfigWritersList } from '../workspace-config-files.main.runtime';
+export declare function formatListOutput(result: EnvConfigWritersList): string;

package/dist/outputs/format-write-output.d.ts

@@ -0,0 +1,3 @@
+import { WriteConfigFilesResult } from '../workspace-config-files.main.runtime';
+import type { WriteConfigCmdFlags } from '../ws-config.cmd';
+export declare function formatWriteOutput(writeConfigFilesResult: WriteConfigFilesResult, flags: WriteConfigCmdFlags): string;

package/dist/outputs/index.d.ts

@@ -0,0 +1,4 @@
+export { formatCleanOutput } from './format-clean-output';
+export { formatListOutput } from './format-list-output';
+export { formatWriteOutput } from './format-write-output';
+export { verboseFormatWriteOutput } from './verbose-format-write-output';

package/dist/outputs/verbose-format-write-output.d.ts

@@ -0,0 +1,3 @@
+import { WriteConfigFilesResult } from '../workspace-config-files.main.runtime';
+import type { WriteConfigCmdFlags } from '../ws-config.cmd';
+export declare function verboseFormatWriteOutput(writeConfigFilesResult: WriteConfigFilesResult, flags: WriteConfigCmdFlags): string;

package/dist/outputs/write-outputs-texts.d.ts

@@ -0,0 +1,2 @@
+export declare const WRITE_TITLE: (total: number) => string;
+export declare const SUMMARY = "bit writes configuration files in different nested locations in your workspace to meet the configuration needs of different components.\nIDE is now in-sync with component configuration";

package/dist/{preview-1712719054377.js → preview-1712822929999.js}

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

package/dist/workspace-config-env-type.d.ts

@@ -0,0 +1,7 @@
+import { ConfigWriterList } from './config-writer-list';
+export interface WorkspaceConfigEnv {
+    /**
+     * return a ConfigWriterList instance.
+     */
+    workspaceConfig?(): ConfigWriterList;
+}

package/dist/workspace-config-files.aspect.d.ts

@@ -0,0 +1,2 @@
+import { Aspect } from '@teambit/harmony';
+export declare const WorkspaceConfigFilesAspect: Aspect;

package/dist/workspace-config-files.main.runtime.d.ts

@@ -0,0 +1,140 @@
+import { CLIMain } from '@teambit/cli';
+import type { Workspace } from '@teambit/workspace';
+import { Environment, ExecutionContext } from '@teambit/envs';
+import type { EnvsMain } from '@teambit/envs';
+import { Logger } from '@teambit/logger';
+import type { LoggerMain } from '@teambit/logger';
+import { ConfigWriterEntry } from './config-writer-entry';
+import { EnvsWrittenExtendingConfigFiles, EnvsWrittenRealConfigFiles } from './writers';
+/**
+ * Configs that can be configured in the workspace.jsonc file
+ */
+export type WorkspaceConfigFilesAspectConfig = {
+    configsRootDir?: string;
+    enableWorkspaceConfigWrite?: boolean;
+};
+export type EnvConfigWriter = {
+    envId: string;
+    executionContext: ExecutionContext;
+    configWriters: ConfigWriterEntry[];
+};
+export type EnvConfigWriterEntry = {
+    envId: string;
+    configWriter: ConfigWriterEntry;
+    executionContext: ExecutionContext;
+};
+export type EnvConfigWritersList = Array<EnvConfigWriter>;
+export type CleanConfigFilesOptions = {
+    silent?: boolean;
+    dryRun?: boolean;
+    writers?: string[];
+};
+export type WriteConfigFilesOptions = {
+    clean?: boolean;
+    silent?: boolean;
+    dedupe?: boolean;
+    dryRun?: boolean;
+    throw?: boolean;
+    writers?: string[];
+};
+export type CompPathExtendingHashMap = {
+    [compPath: string]: string;
+};
+export type EnvMapValue = {
+    env: Environment;
+    id: string[];
+    paths: string[];
+};
+export type EnvCompsDirsMap = {
+    [envId: string]: EnvMapValue;
+};
+export type OneConfigWriterIdResult = {
+    writerId: string;
+    totalWrittenFiles: number;
+    realConfigFiles: EnvsWrittenRealConfigFiles;
+    totalRealConfigFiles: number;
+    extendingConfigFiles: EnvsWrittenExtendingConfigFiles;
+    totalExtendingConfigFiles: number;
+};
+export type WriteResults = {
+    writersResult: OneConfigWriterIdResult[];
+    totalWrittenFiles: number;
+    totalRealConfigFiles: number;
+    totalExtendingConfigFiles: number;
+};
+export type WriteConfigFilesResult = {
+    cleanResults?: string[];
+    writeResults: WriteResults;
+    wsDir: string;
+    err?: Error;
+};
+export declare class WorkspaceConfigFilesMain {
+    private workspace;
+    private envs;
+    private logger;
+    private config;
+    private envsNotImplementing;
+    constructor(workspace: Workspace, envs: EnvsMain, logger: Logger, config: WorkspaceConfigFilesAspectConfig);
+    /**
+     * It writes the configuration files for the workspace
+     * for example: tsconfig, eslint config and prettier config files.
+     * @param {WriteConfigFilesOptions} options - WriteConfigFilesOptions = {}
+     * @returns An object with the following properties:
+     * - writeResults: An object with the following properties:
+     *   - aspectsWritersResults: An array of objects with the following properties:
+     *     - aspect: The aspect that was written
+     *     - totalWrittenFiles: The number of files that were written
+     *   - totalWrittenFiles: The total number of files that were written
+     * - cleanResults: array of deleted paths
+     */
+    writeConfigFiles(options?: WriteConfigFilesOptions): Promise<WriteConfigFilesResult>;
+    /**
+     * This will check the config.enableWorkspaceConfigWrite before writing the config files.
+     */
+    writeConfigFilesIfEnabled(options?: WriteConfigFilesOptions): Promise<WriteConfigFilesResult | undefined>;
+    /**
+     * It cleans (delete) the config files from the workspace.
+     * This will check each file and will only delete it in case it was generated by bit
+     * @param {CleanConfigFilesOptions} options - CleanConfigFilesOptions = {}
+     * @returns An array of strings.
+     */
+    cleanConfigFiles(options?: CleanConfigFilesOptions): Promise<string[]>;
+    /**
+     * The function checks if the auto writing of workspace configuration is enabled.
+     * if it's enabled we will re-generate the configuration files upon bit create
+     * @returns the boolean value of `!!this.config.enableWorkspaceConfigWrite`.
+     */
+    isWorkspaceConfigWriteEnabled(): boolean;
+    /**
+     * It returns a list of all the config writers that have been registered with the config writer slot
+     * @returns An array of objects with aspectId and configWriter properties.
+     */
+    listConfigWriters(): Promise<EnvConfigWritersList>;
+    private groupByWriterId;
+    private write;
+    private handleOneIdWriter;
+    private getConfigsRootDir;
+    private getCacheDir;
+    private getExecContext;
+    private getEnvComponentsDirsMap;
+    private getConfigWriters;
+    private getFlatConfigWriters;
+    /**
+     * Clean config files written by the config-writers
+     * @param envsExecutionContext
+     * @param param1
+     * @returns Array of paths of deleted config files
+     */
+    clean({ dryRun, silent, writers }: WriteConfigFilesOptions): Promise<string[]>;
+    private calcPathsToClean;
+    private addToEnvsNotImplementing;
+    getEnvsNotImplementing(): string[];
+    private promptForCleaning;
+    private deleteFiles;
+    static slots: never[];
+    static dependencies: import("@teambit/harmony").Aspect[];
+    static runtime: import("@teambit/harmony").RuntimeDefinition;
+    static defaultConfig: Partial<WorkspaceConfigFilesAspectConfig>;
+    static provider([cli, workspace, envs, loggerAspect]: [CLIMain, Workspace, EnvsMain, LoggerMain], config: WorkspaceConfigFilesAspectConfig): Promise<WorkspaceConfigFilesMain>;
+}
+export default WorkspaceConfigFilesMain;

package/dist/workspace-config-files.service.d.ts

@@ -0,0 +1,18 @@
+import { Logger } from '@teambit/logger';
+import { EnvService, Env, EnvContext, ServiceTransformationMap } from '@teambit/envs';
+import { ConfigWriterEntry } from './config-writer-entry';
+export type PkgDescriptor = {
+    id: string;
+    displayName: string;
+    config?: string;
+};
+type PkgTransformationMap = ServiceTransformationMap & {
+    workspaceConfig: () => ConfigWriterEntry[];
+};
+export declare class WorkspaceConfigFilesService implements EnvService<any> {
+    private logger;
+    name: string;
+    constructor(logger: Logger);
+    transform(env: Env, envContext: EnvContext): PkgTransformationMap | undefined;
+}
+export {};

package/dist/writers/extending-config-files.d.ts

@@ -0,0 +1,18 @@
+import { ExtendingConfigFile } from '../config-writer-entry';
+import { EnvCompsDirsMap, EnvConfigWriterEntry, WriteConfigFilesOptions } from '../workspace-config-files.main.runtime';
+import { WrittenRealConfigFilesByHash } from './real-config-files';
+export type WrittenExtendingConfigFile = ExtendingConfigFile & {
+    filePaths: string[];
+};
+export type EnvsWrittenExtendingConfigFile = {
+    envIds: string[];
+    extendingConfigFile: WrittenExtendingConfigFile;
+};
+export type EnvsWrittenExtendingConfigFiles = Array<EnvsWrittenExtendingConfigFile>;
+export type ExtendingConfigFilesMap = {
+    [configFileHash: string]: {
+        envIds: string[];
+        extendingConfigFile: Required<ExtendingConfigFile>;
+    };
+};
+export declare function handleExtendingConfigFiles(envEntries: EnvConfigWriterEntry[], envCompsDirsMap: EnvCompsDirsMap, writtenRealConfigFiles: WrittenRealConfigFilesByHash, configsRootDir: string, workspaceDir: string, opts: WriteConfigFilesOptions): Promise<EnvsWrittenExtendingConfigFiles>;

package/dist/writers/index.d.ts

@@ -0,0 +1,4 @@
+export { handleExtendingConfigFiles } from './extending-config-files';
+export { handleRealConfigFiles } from './real-config-files';
+export type { EnvsWrittenRealConfigFiles, EnvsWrittenRealConfigFile, WrittenConfigFile } from './real-config-files';
+export type { EnvsWrittenExtendingConfigFiles, EnvsWrittenExtendingConfigFile, ExtendingConfigFilesMap, } from './extending-config-files';

package/dist/writers/real-config-files.d.ts

@@ -0,0 +1,14 @@
+import { ConfigFile } from '../config-writer-entry';
+import { EnvCompsDirsMap, EnvConfigWriterEntry, WriteConfigFilesOptions } from '../workspace-config-files.main.runtime';
+export type EnvsWrittenRealConfigFiles = Array<EnvsWrittenRealConfigFile>;
+export type EnvsWrittenRealConfigFile = {
+    envIds: string[];
+    writtenRealConfigFile: WrittenConfigFile;
+};
+export type WrittenRealConfigFilesByHash = {
+    [hash: string]: EnvsWrittenRealConfigFile;
+};
+export type WrittenConfigFile = Required<ConfigFile> & {
+    filePath: string;
+};
+export declare function handleRealConfigFiles(envEntries: EnvConfigWriterEntry[], envCompsDirsMap: EnvCompsDirsMap, configsRootDir: string, workspaceDir: string, opts: WriteConfigFilesOptions): Promise<WrittenRealConfigFilesByHash>;

package/dist/ws-config.cmd.d.ts

@@ -0,0 +1,61 @@
+import { Command, CommandOptions } from '@teambit/cli';
+import { WorkspaceConfigFilesMain } from './workspace-config-files.main.runtime';
+export type CleanConfigCmdFlags = {
+    dryRun?: boolean;
+    silent?: boolean;
+};
+export type WriteConfigCmdFlags = {
+    dryRun?: boolean;
+    writers?: string;
+    noDedupe?: boolean;
+    dryRunWithContent?: boolean;
+    clean?: boolean;
+    silent?: boolean;
+    verbose?: boolean;
+};
+export declare class WsConfigCmd implements Command {
+    name: string;
+    alias: string;
+    description: string;
+    options: never[];
+    group: string;
+    commands: Command[];
+    report([unrecognizedSubcommand]: [string]): Promise<string>;
+}
+export declare class WsConfigWriteCmd implements Command {
+    private workspaceConfigFilesMain;
+    name: string;
+    description: string;
+    alias: string;
+    group: string;
+    options: CommandOptions;
+    constructor(workspaceConfigFilesMain: WorkspaceConfigFilesMain);
+    report(_args: any, flags: WriteConfigCmdFlags): Promise<string>;
+    json(_args: any, flags: WriteConfigCmdFlags): Promise<{
+        wsDir: string;
+        cleanResults: string[] | undefined;
+        writeResults: import("./workspace-config-files.main.runtime").WriteResults;
+    }>;
+}
+export declare class WsConfigCleanCmd implements Command {
+    private workspaceConfigFilesMain;
+    name: string;
+    description: string;
+    alias: string;
+    group: string;
+    options: CommandOptions;
+    constructor(workspaceConfigFilesMain: WorkspaceConfigFilesMain);
+    report(_args: any, flags: CleanConfigCmdFlags): Promise<string>;
+    json(_args: any, flags: WriteConfigCmdFlags): Promise<string[]>;
+}
+export declare class WsConfigListCmd implements Command {
+    private workspaceConfigFilesMain;
+    name: string;
+    description: string;
+    alias: string;
+    group: string;
+    options: CommandOptions;
+    constructor(workspaceConfigFilesMain: WorkspaceConfigFilesMain);
+    report(): Promise<string>;
+    json(): Promise<import("./workspace-config-files.main.runtime").EnvConfigWritersList>;
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace-config-files",
-  "version": "1.0.227",
+  "version": "1.0.229",
   "homepage": "https://bit.cloud/teambit/workspace/workspace-config-files",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.227"
+    "version": "1.0.229"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -19,10 +19,10 @@
     "string-format": "0.5.0",
     "@teambit/harmony": "0.4.6",
     "@teambit/bit-error": "0.0.404",
-    "@teambit/envs": "1.0.227",
-    "@teambit/cli": "0.0.860",
-    "@teambit/logger": "0.0.953",
-    "@teambit/workspace": "1.0.227"
+    "@teambit/envs": "1.0.229",
+    "@teambit/cli": "0.0.862",
+    "@teambit/logger": "0.0.955",
+    "@teambit/workspace": "1.0.229"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",
@@ -31,7 +31,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.30"
+    "@teambit/harmony.envs.core-aspect-env": "0.0.33"
   },
   "peerDependencies": {
     "@teambit/legacy": "1.0.624"

package/tsconfig.json

@@ -20,8 +20,7 @@
     "emitDeclarationOnly": true,
     "strict": true,
     "strictPropertyInitialization": false,
-    "noImplicitAny": false,
-    "composite": true
+    "noImplicitAny": false
   },
   "exclude": [
     "artifacts",
@@ -36,19 +35,5 @@
   "include": [
     "**/*",
     "**/*.json"
-  ],
-  "references": [
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.envs_envs@1.0.227"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cli@0.0.860"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_logger@0.0.953"
-    },
-    {
-      "path": "/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.workspace_workspace@1.0.227"
-    }
   ]
 }