@teambit/workspace-config-files 1.0.310 → 1.0.311

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.310" tests="6" failures="0" errors="0" skipped="0">
+  <testsuite name="teambit.workspace/workspace-config-files@1.0.311" tests="6" failures="0" errors="0" skipped="0">
     <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 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

@@ -261,7 +261,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * This will check the config.enableWorkspaceConfigWrite before writing the config files.\n   */",
-                "comment": "This will check the config.enableWorkspaceConfigWrite before writing the config files."
+                "comment": "This will check the config.enableWorkspaceConfigWrite before writing the config files.",
+                "tags": []
               },
               "signature": "(method) WorkspaceConfigFilesMain.writeConfigFilesIfEnabled(options?: WriteConfigFilesOptions): Promise<WriteConfigFilesResult | undefined>",
               "name": "writeConfigFilesIfEnabled",
@@ -1515,7 +1516,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Id is used for few things:\n   * 1. merge/post process different configs files (from different envs) together.\n   * 2. filter the config writer by the cli when using --writers flag.\n   */",
-                "comment": "Id is used for few things:\n1. merge/post process different configs files (from different envs) together.\n2. filter the config writer by the cli when using --writers flag."
+                "comment": "Id is used for few things:\n1. merge/post process different configs files (from different envs) together.\n2. filter the config writer by the cli when using --writers flag.",
+                "tags": []
               },
               "signature": "(property) ConfigWriterEntry.id: string",
               "name": "id",
@@ -1545,7 +1547,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Name of the config writer.\n   * used for outputs and logging.\n   */",
-                "comment": "Name of the config writer.\nused for outputs and logging."
+                "comment": "Name of the config writer.\nused for outputs and logging.",
+                "tags": []
               },
               "signature": "(property) ConfigWriterEntry.name: string",
               "name": "name",
@@ -1787,7 +1790,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * This will be used to generate an extending file content.\n   * For example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).\n   * That way we can avoid writing the same config file multiple times.\n   * It also reduces the risk of the user manually change the config file and then the changes will be lost.\n   * This function support returning a file with content with a dsl using `{}` to replace the config file name.\n   * for example:\n   * content = `{\n   *   \"extends\": {configFile.name},\n   * }`\n   */",
-                "comment": "This will be used to generate an extending file content.\nFor example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).\nThat way we can avoid writing the same config file multiple times.\nIt also reduces the risk of the user manually change the config file and then the changes will be lost.\nThis function support returning a file with content with a dsl using `{}` to replace the config file name.\nfor example:\ncontent = `{\n  \"extends\": {configFile.name},\n}`"
+                "comment": "This will be used to generate an extending file content.\nFor example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).\nThat way we can avoid writing the same config file multiple times.\nIt also reduces the risk of the user manually change the config file and then the changes will be lost.\nThis function support returning a file with content with a dsl using `{}` to replace the config file name.\nfor example:\ncontent = `{\n  \"extends\": {configFile.name},\n}`",
+                "tags": []
               },
               "signature": "(method) ConfigWriterEntry.generateExtendingFile(args: GenerateExtendingConfigFilesArgs): ExtendingConfigFile | undefined",
               "name": "generateExtendingFile",
@@ -2184,7 +2188,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Name of the config file.\n   * supports also using `{hash}` in the name, which will be replaced by the hash of the config file.\n   */",
-                  "comment": "Name of the config file.\nsupports also using `{hash}` in the name, which will be replaced by the hash of the config file."
+                  "comment": "Name of the config file.\nsupports also using `{hash}` in the name, which will be replaced by the hash of the config file.",
+                  "tags": []
                 },
                 "signature": "(property) name: string",
                 "name": "name",
@@ -2214,7 +2219,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Content of the config file.\n   * I.E the content of the tsconfig.json file.\n   */",
-                  "comment": "Content of the config file.\nI.E the content of the tsconfig.json file."
+                  "comment": "Content of the config file.\nI.E the content of the tsconfig.json file.",
+                  "tags": []
                 },
                 "signature": "(property) content: string",
                 "name": "content",
@@ -2244,7 +2250,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Hash of the config file.\n   */",
-                  "comment": "Hash of the config file."
+                  "comment": "Hash of the config file.",
+                  "tags": []
                 },
                 "signature": "(property) hash?: string | undefined",
                 "name": "hash",
@@ -2363,7 +2370,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Paths that the file will be written to.\n   */",
-                  "comment": "Paths that the file will be written to."
+                  "comment": "Paths that the file will be written to.",
+                  "tags": []
                 },
                 "signature": "(property) paths: string[]",
                 "name": "paths",
@@ -2421,7 +2429,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * This is a flag for backward compatibility\n   * We used to return string from the post process, so old versions of bit only knows to handle string results\n   * while in new version we support getting array of objects\n   * we need to know if bit the user is using support the new format or not\n   */",
-                  "comment": "This is a flag for backward compatibility\nWe used to return string from the post process, so old versions of bit only knows to handle string results\nwhile in new version we support getting array of objects\nwe need to know if bit the user is using support the new format or not"
+                  "comment": "This is a flag for backward compatibility\nWe used to return string from the post process, so old versions of bit only knows to handle string results\nwhile in new version we support getting array of objects\nwe need to know if bit the user is using support the new format or not",
+                  "tags": []
                 },
                 "signature": "(property) supportSpecificPathChange?: boolean | undefined",
                 "name": "supportSpecificPathChange",
@@ -2675,7 +2684,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * return a ConfigWriterList instance.\n   */",
-                "comment": "return a ConfigWriterList instance."
+                "comment": "return a ConfigWriterList instance.",
+                "tags": []
               },
               "signature": "(method) WorkspaceConfigEnv.workspaceConfig?(): ConfigWriterList",
               "name": "workspaceConfig",
@@ -2718,7 +2728,8 @@
               "character": 1
             },
             "raw": "/**\n * create and maintain config writer list for component dev environments.\n */",
-            "comment": "create and maintain config writer list for component dev environments."
+            "comment": "create and maintain config writer list for component dev environments.",
+            "tags": []
           },
           "signature": "class ConfigWriterList",
           "name": "ConfigWriterList",
@@ -2807,7 +2818,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * add writers to the list.\n   */",
-                "comment": "add writers to the list."
+                "comment": "add writers to the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.add(writers: ConfigWriterHandler[]): this",
               "name": "add",
@@ -2867,7 +2879,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * remove writers from the list.\n   */",
-                "comment": "remove writers from the list."
+                "comment": "remove writers from the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.remove(writerNames: string[]): this",
               "name": "remove",
@@ -2927,7 +2940,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * replace writers in the list.\n   */",
-                "comment": "replace writers in the list."
+                "comment": "replace writers in the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.replace(writers: ConfigWriterHandler[]): this",
               "name": "replace",
@@ -3060,7 +3074,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compute the list.\n   */",
-                "comment": "compute the list."
+                "comment": "compute the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.compute(context: EnvContext): ConfigWriterEntry[]",
               "name": "compute",
@@ -3238,7 +3253,8 @@
               "character": 1
             },
             "raw": "/**\n * Configs that can be configured in the workspace.jsonc file\n */",
-            "comment": "Configs that can be configured in the workspace.jsonc file"
+            "comment": "Configs that can be configured in the workspace.jsonc file",
+            "tags": []
           },
           "signature": "type WorkspaceConfigFilesAspectConfig = {\n    configsRootDir?: string | undefined;\n    enableWorkspaceConfigWrite?: boolean | undefined;\n}",
           "name": "WorkspaceConfigFilesAspectConfig",
@@ -4548,7 +4564,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * This will check the config.enableWorkspaceConfigWrite before writing the config files.\n   */",
-                "comment": "This will check the config.enableWorkspaceConfigWrite before writing the config files."
+                "comment": "This will check the config.enableWorkspaceConfigWrite before writing the config files.",
+                "tags": []
               },
               "signature": "(method) WorkspaceConfigFilesMain.writeConfigFilesIfEnabled(options?: WriteConfigFilesOptions): Promise<WriteConfigFilesResult | undefined>",
               "name": "writeConfigFilesIfEnabled",
@@ -5338,7 +5355,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Name of the config file.\n   * supports also using `{hash}` in the name, which will be replaced by the hash of the config file.\n   */",
-                  "comment": "Name of the config file.\nsupports also using `{hash}` in the name, which will be replaced by the hash of the config file."
+                  "comment": "Name of the config file.\nsupports also using `{hash}` in the name, which will be replaced by the hash of the config file.",
+                  "tags": []
                 },
                 "signature": "(property) name: string",
                 "name": "name",
@@ -5368,7 +5386,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Content of the config file.\n   * I.E the content of the tsconfig.json file.\n   */",
-                  "comment": "Content of the config file.\nI.E the content of the tsconfig.json file."
+                  "comment": "Content of the config file.\nI.E the content of the tsconfig.json file.",
+                  "tags": []
                 },
                 "signature": "(property) content: string",
                 "name": "content",
@@ -5398,7 +5417,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Hash of the config file.\n   */",
-                  "comment": "Hash of the config file."
+                  "comment": "Hash of the config file.",
+                  "tags": []
                 },
                 "signature": "(property) hash?: string | undefined",
                 "name": "hash",
@@ -5448,7 +5468,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * the config file that this config file extends.\n   */",
-                  "comment": "the config file that this config file extends."
+                  "comment": "the config file that this config file extends.",
+                  "tags": []
                 },
                 "signature": "(property) extendingTarget: WrittenConfigFile",
                 "name": "extendingTarget",
@@ -5479,7 +5500,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * When replacing the config file name with the actual path of the config file, use absolute paths.\n   */",
-                  "comment": "When replacing the config file name with the actual path of the config file, use absolute paths."
+                  "comment": "When replacing the config file name with the actual path of the config file, use absolute paths.",
+                  "tags": []
                 },
                 "signature": "(property) useAbsPaths?: boolean | undefined",
                 "name": "useAbsPaths",
@@ -5628,7 +5650,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * Paths that the file will be written to.\n   */",
-                  "comment": "Paths that the file will be written to."
+                  "comment": "Paths that the file will be written to.",
+                  "tags": []
                 },
                 "signature": "(property) paths: string[]",
                 "name": "paths",
@@ -5686,7 +5709,8 @@
                     "character": 3
                   },
                   "raw": "/**\n   * This is a flag for backward compatibility\n   * We used to return string from the post process, so old versions of bit only knows to handle string results\n   * while in new version we support getting array of objects\n   * we need to know if bit the user is using support the new format or not\n   */",
-                  "comment": "This is a flag for backward compatibility\nWe used to return string from the post process, so old versions of bit only knows to handle string results\nwhile in new version we support getting array of objects\nwe need to know if bit the user is using support the new format or not"
+                  "comment": "This is a flag for backward compatibility\nWe used to return string from the post process, so old versions of bit only knows to handle string results\nwhile in new version we support getting array of objects\nwe need to know if bit the user is using support the new format or not",
+                  "tags": []
                 },
                 "signature": "(property) supportSpecificPathChange?: boolean | undefined",
                 "name": "supportSpecificPathChange",
@@ -5970,7 +5994,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Id is used for few things:\n   * 1. merge/post process different configs files (from different envs) together.\n   * 2. filter the config writer by the cli when using --writers flag.\n   */",
-                "comment": "Id is used for few things:\n1. merge/post process different configs files (from different envs) together.\n2. filter the config writer by the cli when using --writers flag."
+                "comment": "Id is used for few things:\n1. merge/post process different configs files (from different envs) together.\n2. filter the config writer by the cli when using --writers flag.",
+                "tags": []
               },
               "signature": "(property) ConfigWriterEntry.id: string",
               "name": "id",
@@ -6000,7 +6025,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * Name of the config writer.\n   * used for outputs and logging.\n   */",
-                "comment": "Name of the config writer.\nused for outputs and logging."
+                "comment": "Name of the config writer.\nused for outputs and logging.",
+                "tags": []
               },
               "signature": "(property) ConfigWriterEntry.name: string",
               "name": "name",
@@ -6242,7 +6268,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * This will be used to generate an extending file content.\n   * For example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).\n   * That way we can avoid writing the same config file multiple times.\n   * It also reduces the risk of the user manually change the config file and then the changes will be lost.\n   * This function support returning a file with content with a dsl using `{}` to replace the config file name.\n   * for example:\n   * content = `{\n   *   \"extends\": {configFile.name},\n   * }`\n   */",
-                "comment": "This will be used to generate an extending file content.\nFor example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).\nThat way we can avoid writing the same config file multiple times.\nIt also reduces the risk of the user manually change the config file and then the changes will be lost.\nThis function support returning a file with content with a dsl using `{}` to replace the config file name.\nfor example:\ncontent = `{\n  \"extends\": {configFile.name},\n}`"
+                "comment": "This will be used to generate an extending file content.\nFor example, the tsconfig.json file will extend the real tsconfig.{hash}.json file (that were coming from the env).\nThat way we can avoid writing the same config file multiple times.\nIt also reduces the risk of the user manually change the config file and then the changes will be lost.\nThis function support returning a file with content with a dsl using `{}` to replace the config file name.\nfor example:\ncontent = `{\n  \"extends\": {configFile.name},\n}`",
+                "tags": []
               },
               "signature": "(method) ConfigWriterEntry.generateExtendingFile(args: GenerateExtendingConfigFilesArgs): ExtendingConfigFile | undefined",
               "name": "generateExtendingFile",
@@ -6651,7 +6678,8 @@
               "character": 1
             },
             "raw": "/**\n * create and maintain config writer list for component dev environments.\n */",
-            "comment": "create and maintain config writer list for component dev environments."
+            "comment": "create and maintain config writer list for component dev environments.",
+            "tags": []
           },
           "signature": "class ConfigWriterList",
           "name": "ConfigWriterList",
@@ -6740,7 +6768,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * add writers to the list.\n   */",
-                "comment": "add writers to the list."
+                "comment": "add writers to the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.add(writers: ConfigWriterHandler[]): this",
               "name": "add",
@@ -6800,7 +6829,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * remove writers from the list.\n   */",
-                "comment": "remove writers from the list."
+                "comment": "remove writers from the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.remove(writerNames: string[]): this",
               "name": "remove",
@@ -6860,7 +6890,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * replace writers in the list.\n   */",
-                "comment": "replace writers in the list."
+                "comment": "replace writers in the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.replace(writers: ConfigWriterHandler[]): this",
               "name": "replace",
@@ -6993,7 +7024,8 @@
                   "character": 3
                 },
                 "raw": "/**\n   * compute the list.\n   */",
-                "comment": "compute the list."
+                "comment": "compute the list.",
+                "tags": []
               },
               "signature": "(method) ConfigWriterList.compute(context: EnvContext): ConfigWriterEntry[]",
               "name": "compute",
@@ -7142,7 +7174,7 @@
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.310"
+    "version": "1.0.311"
   },
   "taggedModuleExports": []
 }

package/dist/{preview-1718853656395.js → preview-1719137078208.js}

@@ -1,5 +1,5 @@
 ;
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad/teambit.workspace_workspace-config-files@1.0.310/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.311/dist/workspace-config-files.docs.mdx';
 
 export const compositions = [];
 export const overview = [overview_0];

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace-config-files",
-  "version": "1.0.310",
+  "version": "1.0.311",
   "homepage": "https://bit.cloud/teambit/workspace/workspace-config-files",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.310"
+    "version": "1.0.311"
   },
   "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.310",
-    "@teambit/cli": "0.0.887",
-    "@teambit/logger": "0.0.980",
-    "@teambit/workspace": "1.0.310"
+    "@teambit/envs": "1.0.311",
+    "@teambit/cli": "0.0.888",
+    "@teambit/logger": "0.0.981",
+    "@teambit/workspace": "1.0.311"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",