@teambit/workspace-config-files 1.0.1159 → 1.0.1161

package/dist/ws-config.cmd.js.map

@@ -1 +1 @@
-{"version":3,"names":["_chalk","data","_interopRequireDefault","require","_outputs","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","COMMAND_NAME","WsConfigCmd","constructor","report","unrecognizedSubcommand","chalk","red","exports","WsConfigWriteCmd","workspaceConfigFilesMain","_args","flags","results","json","dryRunWithContent","Error","envsNotImplementing","getEnvsNotImplementing","warning","getWarningForNonImplementingEnvs","output","verbose","verboseFormatWriteOutput","formatWriteOutput","clean","silent","noDedupe","writers","dryRun","cleanResults","writeResults","wsDir","writeConfigFiles","dedupe","split","updatedWriteResults","writersResult","map","oneWriterResult","realConfigFiles","forEach","realConfigFile","writtenRealConfigFile","content","extendingConfigFiles","extendingConfigFile","WsConfigCleanCmd","formatCleanOutput","cleanConfigFiles","WsConfigListCmd","formatListOutput","listConfigWriters","length","message","yellow","cyan","join"],"sources":["ws-config.cmd.ts"],"sourcesContent":["/* eslint-disable max-classes-per-file */\n\nimport type { Command, CommandOptions } from '@teambit/cli';\nimport chalk from 'chalk';\nimport type { WorkspaceConfigFilesMain, WriteConfigFilesResult } from './workspace-config-files.main.runtime';\nimport { formatCleanOutput, formatListOutput, formatWriteOutput, verboseFormatWriteOutput } from './outputs';\n\nexport type CleanConfigCmdFlags = {\n  dryRun?: boolean;\n  silent?: boolean;\n};\n\nexport type WriteConfigCmdFlags = {\n  dryRun?: boolean;\n  writers?: string;\n  noDedupe?: boolean;\n  dryRunWithContent?: boolean;\n  clean?: boolean;\n  silent?: boolean;\n  verbose?: boolean;\n};\n\nconst COMMAND_NAME = 'ws-config';\n\nexport class WsConfigCmd implements Command {\n  name = `${COMMAND_NAME} <sub-command>`;\n  alias = 'workspace-config';\n  description = 'generate IDE configuration files';\n  extendedDescription = `writes configuration files (tsconfig.json, eslintrc.js, etc.) to your workspace for better IDE support.\nautomatically generates configs based on your components' environments and settings.\nuseful for enabling proper IntelliSense, linting, and type-checking in your IDE.`;\n  options = [];\n  group = 'workspace-tools';\n  commands: Command[] = [];\n  // helpUrl = '';\n\n  async report([unrecognizedSubcommand]: [string]) {\n    return chalk.red(\n      `\"${unrecognizedSubcommand}\" is not a subcommand of \"ws-config\", please run \"bit ws-config --help\" to list the subcommands`\n    );\n  }\n}\n\nexport class WsConfigWriteCmd implements Command {\n  name = 'write';\n  description = 'write config files in the workspace. useful for IDEs';\n  alias = '';\n  group = 'workspace-tools';\n  options = [\n    [\n      'c',\n      'clean',\n      'delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first',\n    ],\n    [\n      'w',\n      'writers <writers>',\n      `only write config files for the given writers. use comma to separate multiple writers. use ${COMMAND_NAME} list to see all writers`,\n    ],\n    ['s', 'silent', 'do not prompt for confirmation'],\n    ['', 'no-dedupe', \"write configs inside each one of the component's dir, avoid deduping\"],\n    ['', 'dry-run', 'show the paths that configs will be written per env'],\n    [\n      '',\n      'dry-run-with-content',\n      'use with --json flag. show the config content and the paths that will be written per env',\n    ],\n    ['v', 'verbose', 'showing verbose output for writing'],\n    ['j', 'json', 'json format'],\n  ] as CommandOptions;\n\n  constructor(private workspaceConfigFilesMain: WorkspaceConfigFilesMain) {}\n\n  async report(_args, flags: WriteConfigCmdFlags) {\n    const results = (await this.json(_args, flags)) as WriteConfigFilesResult;\n    if (flags.dryRunWithContent) {\n      throw new Error(`use --json flag along with --dry-run-with-content`);\n    }\n    const envsNotImplementing = this.workspaceConfigFilesMain.getEnvsNotImplementing();\n    const warning = getWarningForNonImplementingEnvs(envsNotImplementing);\n    const output = flags.verbose ? verboseFormatWriteOutput(results, flags) : formatWriteOutput(results, flags);\n    return warning + output;\n  }\n\n  async json(_args, flags: WriteConfigCmdFlags) {\n    const { clean, silent, noDedupe, dryRunWithContent, writers } = flags;\n    const dryRun = dryRunWithContent ? true : !!flags.dryRun;\n    const { cleanResults, writeResults, wsDir } = await this.workspaceConfigFilesMain.writeConfigFiles({\n      clean,\n      dedupe: !noDedupe,\n      dryRun,\n      silent,\n      writers: writers?.split(','),\n    });\n\n    if (dryRun) {\n      const updatedWriteResults = writeResults;\n      if (!dryRunWithContent) {\n        updatedWriteResults.writersResult = updatedWriteResults.writersResult.map((oneWriterResult) => {\n          oneWriterResult.realConfigFiles.forEach((realConfigFile) => {\n            realConfigFile.writtenRealConfigFile.content = '';\n          });\n          oneWriterResult.extendingConfigFiles.forEach((extendingConfigFile) => {\n            extendingConfigFile.extendingConfigFile.content = '';\n          });\n          return oneWriterResult;\n        });\n      }\n\n      return {\n        wsDir,\n        cleanResults,\n        writeResults: updatedWriteResults,\n      };\n    }\n    return { wsDir, cleanResults, writeResults };\n  }\n}\n\nexport class WsConfigCleanCmd implements Command {\n  name = 'clean';\n  description = 'clean (delete) written config files in the workspace. useful for IDEs';\n  alias = '';\n  group = 'workspace-tools';\n  options = [\n    ['s', 'silent', 'do not prompt for confirmation'],\n    [\n      'w',\n      'writers <writers>',\n      `only clean config files for the given writers. use comma to separate multiple writers. use ${COMMAND_NAME} list to see all writers`,\n    ],\n    ['', 'dry-run', 'show the paths of configs that will be cleaned'],\n    ['j', 'json', 'json format'],\n  ] as CommandOptions;\n\n  constructor(private workspaceConfigFilesMain: WorkspaceConfigFilesMain) {}\n\n  async report(_args, flags: CleanConfigCmdFlags) {\n    const results = await this.json(_args, flags);\n    const envsNotImplementing = this.workspaceConfigFilesMain.getEnvsNotImplementing();\n    const warning = getWarningForNonImplementingEnvs(envsNotImplementing);\n    const output = formatCleanOutput(results, flags);\n    return warning + output;\n  }\n\n  async json(_args, flags: WriteConfigCmdFlags) {\n    const { silent, dryRun } = flags;\n    const cleanResults = await this.workspaceConfigFilesMain.cleanConfigFiles({\n      dryRun,\n      silent,\n      writers: flags.writers?.split(','),\n    });\n    return cleanResults;\n  }\n}\n\nexport class WsConfigListCmd implements Command {\n  name = 'list';\n  description = 'list config writers';\n  alias = '';\n  group = 'workspace-tools';\n  options = [['j', 'json', 'json format']] as CommandOptions;\n\n  constructor(private workspaceConfigFilesMain: WorkspaceConfigFilesMain) {}\n\n  async report() {\n    const results = await this.json();\n    const envsNotImplementing = this.workspaceConfigFilesMain.getEnvsNotImplementing();\n    const warning = getWarningForNonImplementingEnvs(envsNotImplementing);\n    const output = formatListOutput(results);\n    return warning + output;\n  }\n\n  async json() {\n    const cleanResults = await this.workspaceConfigFilesMain.listConfigWriters();\n    return cleanResults;\n  }\n}\n\nfunction getWarningForNonImplementingEnvs(envsNotImplementing: string[]) {\n  if (!envsNotImplementing.length) return '';\n  const message =\n    chalk.yellow(`Bit cannot determine the correct contents for the config files to write. this may result in incorrect content.\nThe following environments need to add support for config files: ${chalk.cyan(envsNotImplementing.join(', '))}.\nconsider updating these envs to implement config file writing to improve the dev experience.\n\n`);\n  return message;\n}\n"],"mappings":";;;;;;AAGA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAG,SAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA6G,SAAAC,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,gBAAAH,CAAA,EAAAI,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAJ,CAAA,GAAAO,MAAA,CAAAC,cAAA,CAAAR,CAAA,EAAAI,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAZ,CAAA,CAAAI,CAAA,IAAAC,CAAA,EAAAL,CAAA;AAAA,SAAAM,eAAAD,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,uCAAAQ,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAL,CAAA,GAAAK,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAhB,CAAA,QAAAa,CAAA,GAAAb,CAAA,CAAAiB,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA,KAL7G;AAsBA,MAAMgB,YAAY,GAAG,WAAW;AAEzB,MAAMC,WAAW,CAAoB;EAAAC,YAAA;IAAApB,eAAA,eACnC,GAAGkB,YAAY,gBAAgB;IAAAlB,eAAA,gBAC9B,kBAAkB;IAAAA,eAAA,sBACZ,kCAAkC;IAAAA,eAAA,8BAC1B;AACxB;AACA,iFAAiF;IAAAA,eAAA,kBACrE,EAAE;IAAAA,eAAA,gBACJ,iBAAiB;IAAAA,eAAA,mBACH,EAAE;EAAA;EACxB;;EAEA,MAAMqB,MAAMA,CAAC,CAACC,sBAAsB,CAAW,EAAE;IAC/C,OAAOC,gBAAK,CAACC,GAAG,CACd,IAAIF,sBAAsB,iGAC5B,CAAC;EACH;AACF;AAACG,OAAA,CAAAN,WAAA,GAAAA,WAAA;AAEM,MAAMO,gBAAgB,CAAoB;EA4B/CN,WAAWA,CAASO,wBAAkD,EAAE;IAAA,KAApDA,wBAAkD,GAAlDA,wBAAkD;IAAA3B,eAAA,eA3B/D,OAAO;IAAAA,eAAA,sBACA,sDAAsD;IAAAA,eAAA,gBAC5D,EAAE;IAAAA,eAAA,gBACF,iBAAiB;IAAAA,eAAA,kBACf,CACR,CACE,GAAG,EACH,OAAO,EACP,sGAAsG,CACvG,EACD,CACE,GAAG,EACH,mBAAmB,EACnB,8FAA8FkB,YAAY,0BAA0B,CACrI,EACD,CAAC,GAAG,EAAE,QAAQ,EAAE,gCAAgC,CAAC,EACjD,CAAC,EAAE,EAAE,WAAW,EAAE,sEAAsE,CAAC,EACzF,CAAC,EAAE,EAAE,SAAS,EAAE,qDAAqD,CAAC,EACtE,CACE,EAAE,EACF,sBAAsB,EACtB,0FAA0F,CAC3F,EACD,CAAC,GAAG,EAAE,SAAS,EAAE,oCAAoC,CAAC,EACtD,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAC7B;EAEwE;EAEzE,MAAMG,MAAMA,CAACO,KAAK,EAAEC,KAA0B,EAAE;IAC9C,MAAMC,OAAO,GAAI,MAAM,IAAI,CAACC,IAAI,CAACH,KAAK,EAAEC,KAAK,CAA4B;IACzE,IAAIA,KAAK,CAACG,iBAAiB,EAAE;MAC3B,MAAM,IAAIC,KAAK,CAAC,mDAAmD,CAAC;IACtE;IACA,MAAMC,mBAAmB,GAAG,IAAI,CAACP,wBAAwB,CAACQ,sBAAsB,CAAC,CAAC;IAClF,MAAMC,OAAO,GAAGC,gCAAgC,CAACH,mBAAmB,CAAC;IACrE,MAAMI,MAAM,GAAGT,KAAK,CAACU,OAAO,GAAG,IAAAC,mCAAwB,EAACV,OAAO,EAAED,KAAK,CAAC,GAAG,IAAAY,4BAAiB,EAACX,OAAO,EAAED,KAAK,CAAC;IAC3G,OAAOO,OAAO,GAAGE,MAAM;EACzB;EAEA,MAAMP,IAAIA,CAACH,KAAK,EAAEC,KAA0B,EAAE;IAC5C,MAAM;MAAEa,KAAK;MAAEC,MAAM;MAAEC,QAAQ;MAAEZ,iBAAiB;MAAEa;IAAQ,CAAC,GAAGhB,KAAK;IACrE,MAAMiB,MAAM,GAAGd,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAACH,KAAK,CAACiB,MAAM;IACxD,MAAM;MAAEC,YAAY;MAAEC,YAAY;MAAEC;IAAM,CAAC,GAAG,MAAM,IAAI,CAACtB,wBAAwB,CAACuB,gBAAgB,CAAC;MACjGR,KAAK;MACLS,MAAM,EAAE,CAACP,QAAQ;MACjBE,MAAM;MACNH,MAAM;MACNE,OAAO,EAAEA,OAAO,EAAEO,KAAK,CAAC,GAAG;IAC7B,CAAC,CAAC;IAEF,IAAIN,MAAM,EAAE;MACV,MAAMO,mBAAmB,GAAGL,YAAY;MACxC,IAAI,CAAChB,iBAAiB,EAAE;QACtBqB,mBAAmB,CAACC,aAAa,GAAGD,mBAAmB,CAACC,aAAa,CAACC,GAAG,CAAEC,eAAe,IAAK;UAC7FA,eAAe,CAACC,eAAe,CAACC,OAAO,CAAEC,cAAc,IAAK;YAC1DA,cAAc,CAACC,qBAAqB,CAACC,OAAO,GAAG,EAAE;UACnD,CAAC,CAAC;UACFL,eAAe,CAACM,oBAAoB,CAACJ,OAAO,CAAEK,mBAAmB,IAAK;YACpEA,mBAAmB,CAACA,mBAAmB,CAACF,OAAO,GAAG,EAAE;UACtD,CAAC,CAAC;UACF,OAAOL,eAAe;QACxB,CAAC,CAAC;MACJ;MAEA,OAAO;QACLP,KAAK;QACLF,YAAY;QACZC,YAAY,EAAEK;MAChB,CAAC;IACH;IACA,OAAO;MAAEJ,KAAK;MAAEF,YAAY;MAAEC;IAAa,CAAC;EAC9C;AACF;AAACvB,OAAA,CAAAC,gBAAA,GAAAA,gBAAA;AAEM,MAAMsC,gBAAgB,CAAoB;EAgB/C5C,WAAWA,CAASO,wBAAkD,EAAE;IAAA,KAApDA,wBAAkD,GAAlDA,wBAAkD;IAAA3B,eAAA,eAf/D,OAAO;IAAAA,eAAA,sBACA,uEAAuE;IAAAA,eAAA,gBAC7E,EAAE;IAAAA,eAAA,gBACF,iBAAiB;IAAAA,eAAA,kBACf,CACR,CAAC,GAAG,EAAE,QAAQ,EAAE,gCAAgC,CAAC,EACjD,CACE,GAAG,EACH,mBAAmB,EACnB,8FAA8FkB,YAAY,0BAA0B,CACrI,EACD,CAAC,EAAE,EAAE,SAAS,EAAE,gDAAgD,CAAC,EACjE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAC7B;EAEwE;EAEzE,MAAMG,MAAMA,CAACO,KAAK,EAAEC,KAA0B,EAAE;IAC9C,MAAMC,OAAO,GAAG,MAAM,IAAI,CAACC,IAAI,CAACH,KAAK,EAAEC,KAAK,CAAC;IAC7C,MAAMK,mBAAmB,GAAG,IAAI,CAACP,wBAAwB,CAACQ,sBAAsB,CAAC,CAAC;IAClF,MAAMC,OAAO,GAAGC,gCAAgC,CAACH,mBAAmB,CAAC;IACrE,MAAMI,MAAM,GAAG,IAAA2B,4BAAiB,EAACnC,OAAO,EAAED,KAAK,CAAC;IAChD,OAAOO,OAAO,GAAGE,MAAM;EACzB;EAEA,MAAMP,IAAIA,CAACH,KAAK,EAAEC,KAA0B,EAAE;IAC5C,MAAM;MAAEc,MAAM;MAAEG;IAAO,CAAC,GAAGjB,KAAK;IAChC,MAAMkB,YAAY,GAAG,MAAM,IAAI,CAACpB,wBAAwB,CAACuC,gBAAgB,CAAC;MACxEpB,MAAM;MACNH,MAAM;MACNE,OAAO,EAAEhB,KAAK,CAACgB,OAAO,EAAEO,KAAK,CAAC,GAAG;IACnC,CAAC,CAAC;IACF,OAAOL,YAAY;EACrB;AACF;AAACtB,OAAA,CAAAuC,gBAAA,GAAAA,gBAAA;AAEM,MAAMG,eAAe,CAAoB;EAO9C/C,WAAWA,CAASO,wBAAkD,EAAE;IAAA,KAApDA,wBAAkD,GAAlDA,wBAAkD;IAAA3B,eAAA,eAN/D,MAAM;IAAAA,eAAA,sBACC,qBAAqB;IAAAA,eAAA,gBAC3B,EAAE;IAAAA,eAAA,gBACF,iBAAiB;IAAAA,eAAA,kBACf,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;EAEiC;EAEzE,MAAMqB,MAAMA,CAAA,EAAG;IACb,MAAMS,OAAO,GAAG,MAAM,IAAI,CAACC,IAAI,CAAC,CAAC;IACjC,MAAMG,mBAAmB,GAAG,IAAI,CAACP,wBAAwB,CAACQ,sBAAsB,CAAC,CAAC;IAClF,MAAMC,OAAO,GAAGC,gCAAgC,CAACH,mBAAmB,CAAC;IACrE,MAAMI,MAAM,GAAG,IAAA8B,2BAAgB,EAACtC,OAAO,CAAC;IACxC,OAAOM,OAAO,GAAGE,MAAM;EACzB;EAEA,MAAMP,IAAIA,CAAA,EAAG;IACX,MAAMgB,YAAY,GAAG,MAAM,IAAI,CAACpB,wBAAwB,CAAC0C,iBAAiB,CAAC,CAAC;IAC5E,OAAOtB,YAAY;EACrB;AACF;AAACtB,OAAA,CAAA0C,eAAA,GAAAA,eAAA;AAED,SAAS9B,gCAAgCA,CAACH,mBAA6B,EAAE;EACvE,IAAI,CAACA,mBAAmB,CAACoC,MAAM,EAAE,OAAO,EAAE;EAC1C,MAAMC,OAAO,GACXhD,gBAAK,CAACiD,MAAM,CAAC;AACjB,mEAAmEjD,gBAAK,CAACkD,IAAI,CAACvC,mBAAmB,CAACwC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7G;AACA;AACA,CAAC,CAAC;EACA,OAAOH,OAAO;AAChB","ignoreList":[]}
+{"version":3,"names":["_chalk","data","_interopRequireDefault","require","_outputs","e","__esModule","default","_defineProperty","r","t","_toPropertyKey","Object","defineProperty","value","enumerable","configurable","writable","i","_toPrimitive","Symbol","toPrimitive","call","TypeError","String","Number","COMMAND_NAME","WsConfigCmd","constructor","report","unrecognizedSubcommand","chalk","red","exports","WsConfigWriteCmd","workspaceConfigFilesMain","_args","flags","results","json","dryRunWithContent","Error","envsNotImplementing","getEnvsNotImplementing","warning","getWarningForNonImplementingEnvs","output","verbose","verboseFormatWriteOutput","formatWriteOutput","clean","silent","noDedupe","writers","force","dryRun","cleanResults","writeResults","wsDir","writeConfigFiles","dedupe","split","updatedWriteResults","writersResult","map","oneWriterResult","realConfigFiles","forEach","realConfigFile","writtenRealConfigFile","content","extendingConfigFiles","extendingConfigFile","WsConfigCleanCmd","formatCleanOutput","cleanConfigFiles","WsConfigListCmd","formatListOutput","listConfigWriters","length","message","yellow","cyan","join"],"sources":["ws-config.cmd.ts"],"sourcesContent":["/* eslint-disable max-classes-per-file */\n\nimport type { Command, CommandOptions } from '@teambit/cli';\nimport chalk from 'chalk';\nimport type { WorkspaceConfigFilesMain, WriteConfigFilesResult } from './workspace-config-files.main.runtime';\nimport { formatCleanOutput, formatListOutput, formatWriteOutput, verboseFormatWriteOutput } from './outputs';\n\nexport type CleanConfigCmdFlags = {\n  dryRun?: boolean;\n  silent?: boolean;\n};\n\nexport type WriteConfigCmdFlags = {\n  dryRun?: boolean;\n  writers?: string;\n  noDedupe?: boolean;\n  dryRunWithContent?: boolean;\n  clean?: boolean;\n  silent?: boolean;\n  verbose?: boolean;\n  force?: boolean;\n};\n\nconst COMMAND_NAME = 'ws-config';\n\nexport class WsConfigCmd implements Command {\n  name = `${COMMAND_NAME} <sub-command>`;\n  alias = 'workspace-config';\n  description = 'generate IDE configuration files';\n  extendedDescription = `writes configuration files (tsconfig.json, eslintrc.js, etc.) to your workspace for better IDE support.\nautomatically generates configs based on your components' environments and settings.\nuseful for enabling proper IntelliSense, linting, and type-checking in your IDE.`;\n  options = [];\n  group = 'workspace-tools';\n  commands: Command[] = [];\n  // helpUrl = '';\n\n  async report([unrecognizedSubcommand]: [string]) {\n    return chalk.red(\n      `\"${unrecognizedSubcommand}\" is not a subcommand of \"ws-config\", please run \"bit ws-config --help\" to list the subcommands`\n    );\n  }\n}\n\nexport class WsConfigWriteCmd implements Command {\n  name = 'write';\n  description = 'write config files in the workspace. useful for IDEs';\n  alias = '';\n  group = 'workspace-tools';\n  options = [\n    [\n      'c',\n      'clean',\n      'delete existing config files from the workspace. highly recommended to run it with \"--dry-run\" first',\n    ],\n    [\n      'w',\n      'writers <writers>',\n      `only write config files for the given writers. use comma to separate multiple writers. use ${COMMAND_NAME} list to see all writers`,\n    ],\n    ['s', 'silent', 'do not prompt for confirmation'],\n    [\n      'f',\n      'force',\n      'override config files that already exist in the workspace and were not generated by bit. by default they are left untouched',\n    ],\n    ['', 'no-dedupe', \"write configs inside each one of the component's dir, avoid deduping\"],\n    ['', 'dry-run', 'show the paths that configs will be written per env'],\n    [\n      '',\n      'dry-run-with-content',\n      'use with --json flag. show the config content and the paths that will be written per env',\n    ],\n    ['v', 'verbose', 'showing verbose output for writing'],\n    ['j', 'json', 'json format'],\n  ] as CommandOptions;\n\n  constructor(private workspaceConfigFilesMain: WorkspaceConfigFilesMain) {}\n\n  async report(_args, flags: WriteConfigCmdFlags) {\n    const results = (await this.json(_args, flags)) as WriteConfigFilesResult;\n    if (flags.dryRunWithContent) {\n      throw new Error(`use --json flag along with --dry-run-with-content`);\n    }\n    const envsNotImplementing = this.workspaceConfigFilesMain.getEnvsNotImplementing();\n    const warning = getWarningForNonImplementingEnvs(envsNotImplementing);\n    const output = flags.verbose ? verboseFormatWriteOutput(results, flags) : formatWriteOutput(results, flags);\n    return warning + output;\n  }\n\n  async json(_args, flags: WriteConfigCmdFlags) {\n    const { clean, silent, noDedupe, dryRunWithContent, writers, force } = flags;\n    const dryRun = dryRunWithContent ? true : !!flags.dryRun;\n    const { cleanResults, writeResults, wsDir } = await this.workspaceConfigFilesMain.writeConfigFiles({\n      clean,\n      dedupe: !noDedupe,\n      dryRun,\n      silent,\n      writers: writers?.split(','),\n      force,\n    });\n\n    if (dryRun) {\n      const updatedWriteResults = writeResults;\n      if (!dryRunWithContent) {\n        updatedWriteResults.writersResult = updatedWriteResults.writersResult.map((oneWriterResult) => {\n          oneWriterResult.realConfigFiles.forEach((realConfigFile) => {\n            realConfigFile.writtenRealConfigFile.content = '';\n          });\n          oneWriterResult.extendingConfigFiles.forEach((extendingConfigFile) => {\n            extendingConfigFile.extendingConfigFile.content = '';\n          });\n          return oneWriterResult;\n        });\n      }\n\n      return {\n        wsDir,\n        cleanResults,\n        writeResults: updatedWriteResults,\n      };\n    }\n    return { wsDir, cleanResults, writeResults };\n  }\n}\n\nexport class WsConfigCleanCmd implements Command {\n  name = 'clean';\n  description = 'clean (delete) written config files in the workspace. useful for IDEs';\n  alias = '';\n  group = 'workspace-tools';\n  options = [\n    ['s', 'silent', 'do not prompt for confirmation'],\n    [\n      'w',\n      'writers <writers>',\n      `only clean config files for the given writers. use comma to separate multiple writers. use ${COMMAND_NAME} list to see all writers`,\n    ],\n    ['', 'dry-run', 'show the paths of configs that will be cleaned'],\n    ['j', 'json', 'json format'],\n  ] as CommandOptions;\n\n  constructor(private workspaceConfigFilesMain: WorkspaceConfigFilesMain) {}\n\n  async report(_args, flags: CleanConfigCmdFlags) {\n    const results = await this.json(_args, flags);\n    const envsNotImplementing = this.workspaceConfigFilesMain.getEnvsNotImplementing();\n    const warning = getWarningForNonImplementingEnvs(envsNotImplementing);\n    const output = formatCleanOutput(results, flags);\n    return warning + output;\n  }\n\n  async json(_args, flags: WriteConfigCmdFlags) {\n    const { silent, dryRun } = flags;\n    const cleanResults = await this.workspaceConfigFilesMain.cleanConfigFiles({\n      dryRun,\n      silent,\n      writers: flags.writers?.split(','),\n    });\n    return cleanResults;\n  }\n}\n\nexport class WsConfigListCmd implements Command {\n  name = 'list';\n  description = 'list config writers';\n  alias = '';\n  group = 'workspace-tools';\n  options = [['j', 'json', 'json format']] as CommandOptions;\n\n  constructor(private workspaceConfigFilesMain: WorkspaceConfigFilesMain) {}\n\n  async report() {\n    const results = await this.json();\n    const envsNotImplementing = this.workspaceConfigFilesMain.getEnvsNotImplementing();\n    const warning = getWarningForNonImplementingEnvs(envsNotImplementing);\n    const output = formatListOutput(results);\n    return warning + output;\n  }\n\n  async json() {\n    const cleanResults = await this.workspaceConfigFilesMain.listConfigWriters();\n    return cleanResults;\n  }\n}\n\nfunction getWarningForNonImplementingEnvs(envsNotImplementing: string[]) {\n  if (!envsNotImplementing.length) return '';\n  const message =\n    chalk.yellow(`Bit cannot determine the correct contents for the config files to write. this may result in incorrect content.\nThe following environments need to add support for config files: ${chalk.cyan(envsNotImplementing.join(', '))}.\nconsider updating these envs to implement config file writing to improve the dev experience.\n\n`);\n  return message;\n}\n"],"mappings":";;;;;;AAGA,SAAAA,OAAA;EAAA,MAAAC,IAAA,GAAAC,sBAAA,CAAAC,OAAA;EAAAH,MAAA,YAAAA,CAAA;IAAA,OAAAC,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAEA,SAAAG,SAAA;EAAA,MAAAH,IAAA,GAAAE,OAAA;EAAAC,QAAA,YAAAA,CAAA;IAAA,OAAAH,IAAA;EAAA;EAAA,OAAAA,IAAA;AAAA;AAA6G,SAAAC,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,SAAAG,gBAAAH,CAAA,EAAAI,CAAA,EAAAC,CAAA,YAAAD,CAAA,GAAAE,cAAA,CAAAF,CAAA,MAAAJ,CAAA,GAAAO,MAAA,CAAAC,cAAA,CAAAR,CAAA,EAAAI,CAAA,IAAAK,KAAA,EAAAJ,CAAA,EAAAK,UAAA,MAAAC,YAAA,MAAAC,QAAA,UAAAZ,CAAA,CAAAI,CAAA,IAAAC,CAAA,EAAAL,CAAA;AAAA,SAAAM,eAAAD,CAAA,QAAAQ,CAAA,GAAAC,YAAA,CAAAT,CAAA,uCAAAQ,CAAA,GAAAA,CAAA,GAAAA,CAAA;AAAA,SAAAC,aAAAT,CAAA,EAAAD,CAAA,2BAAAC,CAAA,KAAAA,CAAA,SAAAA,CAAA,MAAAL,CAAA,GAAAK,CAAA,CAAAU,MAAA,CAAAC,WAAA,kBAAAhB,CAAA,QAAAa,CAAA,GAAAb,CAAA,CAAAiB,IAAA,CAAAZ,CAAA,EAAAD,CAAA,uCAAAS,CAAA,SAAAA,CAAA,YAAAK,SAAA,yEAAAd,CAAA,GAAAe,MAAA,GAAAC,MAAA,EAAAf,CAAA,KAL7G;AAuBA,MAAMgB,YAAY,GAAG,WAAW;AAEzB,MAAMC,WAAW,CAAoB;EAAAC,YAAA;IAAApB,eAAA,eACnC,GAAGkB,YAAY,gBAAgB;IAAAlB,eAAA,gBAC9B,kBAAkB;IAAAA,eAAA,sBACZ,kCAAkC;IAAAA,eAAA,8BAC1B;AACxB;AACA,iFAAiF;IAAAA,eAAA,kBACrE,EAAE;IAAAA,eAAA,gBACJ,iBAAiB;IAAAA,eAAA,mBACH,EAAE;EAAA;EACxB;;EAEA,MAAMqB,MAAMA,CAAC,CAACC,sBAAsB,CAAW,EAAE;IAC/C,OAAOC,gBAAK,CAACC,GAAG,CACd,IAAIF,sBAAsB,iGAC5B,CAAC;EACH;AACF;AAACG,OAAA,CAAAN,WAAA,GAAAA,WAAA;AAEM,MAAMO,gBAAgB,CAAoB;EAiC/CN,WAAWA,CAASO,wBAAkD,EAAE;IAAA,KAApDA,wBAAkD,GAAlDA,wBAAkD;IAAA3B,eAAA,eAhC/D,OAAO;IAAAA,eAAA,sBACA,sDAAsD;IAAAA,eAAA,gBAC5D,EAAE;IAAAA,eAAA,gBACF,iBAAiB;IAAAA,eAAA,kBACf,CACR,CACE,GAAG,EACH,OAAO,EACP,sGAAsG,CACvG,EACD,CACE,GAAG,EACH,mBAAmB,EACnB,8FAA8FkB,YAAY,0BAA0B,CACrI,EACD,CAAC,GAAG,EAAE,QAAQ,EAAE,gCAAgC,CAAC,EACjD,CACE,GAAG,EACH,OAAO,EACP,6HAA6H,CAC9H,EACD,CAAC,EAAE,EAAE,WAAW,EAAE,sEAAsE,CAAC,EACzF,CAAC,EAAE,EAAE,SAAS,EAAE,qDAAqD,CAAC,EACtE,CACE,EAAE,EACF,sBAAsB,EACtB,0FAA0F,CAC3F,EACD,CAAC,GAAG,EAAE,SAAS,EAAE,oCAAoC,CAAC,EACtD,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAC7B;EAEwE;EAEzE,MAAMG,MAAMA,CAACO,KAAK,EAAEC,KAA0B,EAAE;IAC9C,MAAMC,OAAO,GAAI,MAAM,IAAI,CAACC,IAAI,CAACH,KAAK,EAAEC,KAAK,CAA4B;IACzE,IAAIA,KAAK,CAACG,iBAAiB,EAAE;MAC3B,MAAM,IAAIC,KAAK,CAAC,mDAAmD,CAAC;IACtE;IACA,MAAMC,mBAAmB,GAAG,IAAI,CAACP,wBAAwB,CAACQ,sBAAsB,CAAC,CAAC;IAClF,MAAMC,OAAO,GAAGC,gCAAgC,CAACH,mBAAmB,CAAC;IACrE,MAAMI,MAAM,GAAGT,KAAK,CAACU,OAAO,GAAG,IAAAC,mCAAwB,EAACV,OAAO,EAAED,KAAK,CAAC,GAAG,IAAAY,4BAAiB,EAACX,OAAO,EAAED,KAAK,CAAC;IAC3G,OAAOO,OAAO,GAAGE,MAAM;EACzB;EAEA,MAAMP,IAAIA,CAACH,KAAK,EAAEC,KAA0B,EAAE;IAC5C,MAAM;MAAEa,KAAK;MAAEC,MAAM;MAAEC,QAAQ;MAAEZ,iBAAiB;MAAEa,OAAO;MAAEC;IAAM,CAAC,GAAGjB,KAAK;IAC5E,MAAMkB,MAAM,GAAGf,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAACH,KAAK,CAACkB,MAAM;IACxD,MAAM;MAAEC,YAAY;MAAEC,YAAY;MAAEC;IAAM,CAAC,GAAG,MAAM,IAAI,CAACvB,wBAAwB,CAACwB,gBAAgB,CAAC;MACjGT,KAAK;MACLU,MAAM,EAAE,CAACR,QAAQ;MACjBG,MAAM;MACNJ,MAAM;MACNE,OAAO,EAAEA,OAAO,EAAEQ,KAAK,CAAC,GAAG,CAAC;MAC5BP;IACF,CAAC,CAAC;IAEF,IAAIC,MAAM,EAAE;MACV,MAAMO,mBAAmB,GAAGL,YAAY;MACxC,IAAI,CAACjB,iBAAiB,EAAE;QACtBsB,mBAAmB,CAACC,aAAa,GAAGD,mBAAmB,CAACC,aAAa,CAACC,GAAG,CAAEC,eAAe,IAAK;UAC7FA,eAAe,CAACC,eAAe,CAACC,OAAO,CAAEC,cAAc,IAAK;YAC1DA,cAAc,CAACC,qBAAqB,CAACC,OAAO,GAAG,EAAE;UACnD,CAAC,CAAC;UACFL,eAAe,CAACM,oBAAoB,CAACJ,OAAO,CAAEK,mBAAmB,IAAK;YACpEA,mBAAmB,CAACA,mBAAmB,CAACF,OAAO,GAAG,EAAE;UACtD,CAAC,CAAC;UACF,OAAOL,eAAe;QACxB,CAAC,CAAC;MACJ;MAEA,OAAO;QACLP,KAAK;QACLF,YAAY;QACZC,YAAY,EAAEK;MAChB,CAAC;IACH;IACA,OAAO;MAAEJ,KAAK;MAAEF,YAAY;MAAEC;IAAa,CAAC;EAC9C;AACF;AAACxB,OAAA,CAAAC,gBAAA,GAAAA,gBAAA;AAEM,MAAMuC,gBAAgB,CAAoB;EAgB/C7C,WAAWA,CAASO,wBAAkD,EAAE;IAAA,KAApDA,wBAAkD,GAAlDA,wBAAkD;IAAA3B,eAAA,eAf/D,OAAO;IAAAA,eAAA,sBACA,uEAAuE;IAAAA,eAAA,gBAC7E,EAAE;IAAAA,eAAA,gBACF,iBAAiB;IAAAA,eAAA,kBACf,CACR,CAAC,GAAG,EAAE,QAAQ,EAAE,gCAAgC,CAAC,EACjD,CACE,GAAG,EACH,mBAAmB,EACnB,8FAA8FkB,YAAY,0BAA0B,CACrI,EACD,CAAC,EAAE,EAAE,SAAS,EAAE,gDAAgD,CAAC,EACjE,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAC7B;EAEwE;EAEzE,MAAMG,MAAMA,CAACO,KAAK,EAAEC,KAA0B,EAAE;IAC9C,MAAMC,OAAO,GAAG,MAAM,IAAI,CAACC,IAAI,CAACH,KAAK,EAAEC,KAAK,CAAC;IAC7C,MAAMK,mBAAmB,GAAG,IAAI,CAACP,wBAAwB,CAACQ,sBAAsB,CAAC,CAAC;IAClF,MAAMC,OAAO,GAAGC,gCAAgC,CAACH,mBAAmB,CAAC;IACrE,MAAMI,MAAM,GAAG,IAAA4B,4BAAiB,EAACpC,OAAO,EAAED,KAAK,CAAC;IAChD,OAAOO,OAAO,GAAGE,MAAM;EACzB;EAEA,MAAMP,IAAIA,CAACH,KAAK,EAAEC,KAA0B,EAAE;IAC5C,MAAM;MAAEc,MAAM;MAAEI;IAAO,CAAC,GAAGlB,KAAK;IAChC,MAAMmB,YAAY,GAAG,MAAM,IAAI,CAACrB,wBAAwB,CAACwC,gBAAgB,CAAC;MACxEpB,MAAM;MACNJ,MAAM;MACNE,OAAO,EAAEhB,KAAK,CAACgB,OAAO,EAAEQ,KAAK,CAAC,GAAG;IACnC,CAAC,CAAC;IACF,OAAOL,YAAY;EACrB;AACF;AAACvB,OAAA,CAAAwC,gBAAA,GAAAA,gBAAA;AAEM,MAAMG,eAAe,CAAoB;EAO9ChD,WAAWA,CAASO,wBAAkD,EAAE;IAAA,KAApDA,wBAAkD,GAAlDA,wBAAkD;IAAA3B,eAAA,eAN/D,MAAM;IAAAA,eAAA,sBACC,qBAAqB;IAAAA,eAAA,gBAC3B,EAAE;IAAAA,eAAA,gBACF,iBAAiB;IAAAA,eAAA,kBACf,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;EAEiC;EAEzE,MAAMqB,MAAMA,CAAA,EAAG;IACb,MAAMS,OAAO,GAAG,MAAM,IAAI,CAACC,IAAI,CAAC,CAAC;IACjC,MAAMG,mBAAmB,GAAG,IAAI,CAACP,wBAAwB,CAACQ,sBAAsB,CAAC,CAAC;IAClF,MAAMC,OAAO,GAAGC,gCAAgC,CAACH,mBAAmB,CAAC;IACrE,MAAMI,MAAM,GAAG,IAAA+B,2BAAgB,EAACvC,OAAO,CAAC;IACxC,OAAOM,OAAO,GAAGE,MAAM;EACzB;EAEA,MAAMP,IAAIA,CAAA,EAAG;IACX,MAAMiB,YAAY,GAAG,MAAM,IAAI,CAACrB,wBAAwB,CAAC2C,iBAAiB,CAAC,CAAC;IAC5E,OAAOtB,YAAY;EACrB;AACF;AAACvB,OAAA,CAAA2C,eAAA,GAAAA,eAAA;AAED,SAAS/B,gCAAgCA,CAACH,mBAA6B,EAAE;EACvE,IAAI,CAACA,mBAAmB,CAACqC,MAAM,EAAE,OAAO,EAAE;EAC1C,MAAMC,OAAO,GACXjD,gBAAK,CAACkD,MAAM,CAAC;AACjB,mEAAmElD,gBAAK,CAACmD,IAAI,CAACxC,mBAAmB,CAACyC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC7G;AACA;AACA,CAAC,CAAC;EACA,OAAOH,OAAO;AAChB","ignoreList":[]}

package/outputs/format-skipped-output.spec.ts

@@ -0,0 +1,51 @@
+import { expect } from 'chai';
+import { join } from 'path';
+import type { WriteConfigFilesResult } from '../workspace-config-files.main.runtime';
+import { formatSkippedOutput } from './format-skipped-output';
+import { formatWriteOutput } from './format-write-output';
+import { verboseFormatWriteOutput } from './verbose-format-write-output';
+
+const wsDir = join('/', 'my-workspace');
+const skippedPath = join(wsDir, 'tsconfig.json');
+
+function mockWriteConfigFilesResult(skippedPaths: string[]): WriteConfigFilesResult {
+  return {
+    wsDir,
+    writeResults: {
+      writersResult: [],
+      totalWrittenFiles: 0,
+      totalRealConfigFiles: 0,
+      totalExtendingConfigFiles: 0,
+      skippedPaths,
+    },
+  };
+}
+
+describe('formatSkippedOutput()', () => {
+  it('should return an empty string when no file was skipped', () => {
+    expect(formatSkippedOutput([], wsDir)).to.equal('');
+  });
+  it('should show the path relative to the workspace and how to override it', () => {
+    const output = formatSkippedOutput([skippedPath], wsDir);
+    expect(output).to.have.string('tsconfig.json');
+    expect(output).to.not.have.string(wsDir);
+    expect(output).to.have.string('--force');
+  });
+});
+
+describe('write output with skipped files', () => {
+  it('should show the skipped files', () => {
+    const output = formatWriteOutput(mockWriteConfigFilesResult([skippedPath]), {});
+    expect(output).to.have.string('not overridden');
+    expect(output).to.have.string('tsconfig.json');
+  });
+  it('should show the skipped files in verbose mode as well', () => {
+    const output = verboseFormatWriteOutput(mockWriteConfigFilesResult([skippedPath]), {});
+    expect(output).to.have.string('not overridden');
+    expect(output).to.have.string('tsconfig.json');
+  });
+  it('should not mention skipped files when there are none', () => {
+    expect(formatWriteOutput(mockWriteConfigFilesResult([]), {})).to.not.have.string('not overridden');
+    expect(verboseFormatWriteOutput(mockWriteConfigFilesResult([]), {})).to.not.have.string('not overridden');
+  });
+});

package/outputs/format-skipped-output.ts

@@ -0,0 +1,14 @@
+import { relative } from 'path';
+import { formatItem, formatSection, warnSymbol } from '@teambit/cli';
+
+const SKIPPED_DESCRIPTION = `these files already exist and were not generated by bit, so they were left untouched.
+to have bit write them, delete them first or run "bit ws-config write --force".`;
+
+/**
+ * config files that bit wanted to write but are authored by the user.
+ * returns an empty string when nothing was skipped.
+ */
+export function formatSkippedOutput(skippedPaths: string[], wsDir: string): string {
+  const items = skippedPaths.map((path) => formatItem(relative(wsDir, path)));
+  return formatSection(`${warnSymbol} config files not overridden`, SKIPPED_DESCRIPTION, items);
+}

package/outputs/format-write-output.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import { relative } from 'path';
+import { joinSections } from '@teambit/cli';
 import type {
   OneConfigWriterIdResult,
   WriteConfigFilesResult,
@@ -7,6 +8,7 @@ import type {
 } from '../workspace-config-files.main.runtime';
 import type { WriteConfigCmdFlags } from '../ws-config.cmd';
 import { formatCleanOutput } from './format-clean-output';
+import { formatSkippedOutput } from './format-skipped-output';
 import { SUMMARY, WRITE_TITLE } from './write-outputs-texts';
 import type { EnvsWrittenExtendingConfigFile, EnvsWrittenExtendingConfigFiles } from '../writers';
 
@@ -17,8 +19,9 @@ export function formatWriteOutput(writeConfigFilesResult: WriteConfigFilesResult
   const writeResultsOutput = getWriteResultsOutput(writeResults, wsDir, isDryRun);
 
   const cleanWriteOutput = cleanResultsOutput ? `${cleanResultsOutput}\n${writeResultsOutput}` : writeResultsOutput;
+  const skippedOutput = formatSkippedOutput(writeResults.skippedPaths, wsDir);
 
-  return `${cleanWriteOutput}\n\n${SUMMARY}`;
+  return joinSections([cleanWriteOutput, skippedOutput, SUMMARY]);
 }
 
 function getWriteResultsOutput(writeResults: WriteResults, wsDir: string, isDryRun: boolean) {

package/outputs/index.ts

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

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

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import { relative } from 'path';
+import { joinSections } from '@teambit/cli';
 import type {
   OneConfigWriterIdResult,
   WriteConfigFilesResult,
@@ -7,6 +8,7 @@ import type {
 } from '../workspace-config-files.main.runtime';
 import type { WriteConfigCmdFlags } from '../ws-config.cmd';
 import { formatCleanOutput } from './format-clean-output';
+import { formatSkippedOutput } from './format-skipped-output';
 import { SUMMARY, WRITE_TITLE } from './write-outputs-texts';
 import type {
   EnvsWrittenExtendingConfigFile,
@@ -23,8 +25,9 @@ export function verboseFormatWriteOutput(
   const isDryRun = !!(flags.dryRun || flags.dryRunWithContent);
   const cleanResultsOutput = formatCleanOutput(cleanResults, { dryRun: isDryRun });
   const writeResultsOutput = getWriteResultsOutput(writeResults, wsDir, isDryRun);
+  const skippedOutput = formatSkippedOutput(writeResults.skippedPaths, wsDir);
 
-  return `${cleanResultsOutput}\n${writeResultsOutput}\n\n${SUMMARY}`;
+  return joinSections([`${cleanResultsOutput}\n${writeResultsOutput}`, skippedOutput, SUMMARY]);
 }
 
 function getWriteResultsOutput(writeResults: WriteResults, wsDir: string, isDryRun: boolean) {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@teambit/workspace-config-files",
-  "version": "1.0.1159",
+  "version": "1.0.1161",
   "homepage": "https://bit.cloud/teambit/workspace/workspace-config-files",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.workspace",
     "name": "workspace-config-files",
-    "version": "1.0.1159"
+    "version": "1.0.1161"
   },
   "dependencies": {
     "lodash": "4.17.21",
@@ -24,8 +24,8 @@
     "@teambit/legacy.consumer": "0.0.160",
     "@teambit/logger": "0.0.1482",
     "@teambit/toolbox.crypto.sha1": "0.0.21",
-    "@teambit/envs": "1.0.1159",
-    "@teambit/workspace": "1.0.1159"
+    "@teambit/envs": "1.0.1161",
+    "@teambit/workspace": "1.0.1161"
   },
   "devDependencies": {
     "@types/lodash": "4.14.165",

package/writers/extending-config-files.spec.ts

@@ -0,0 +1,67 @@
+import { expect } from 'chai';
+import fs from 'fs-extra';
+import { tmpdir } from 'os';
+import { join } from 'path';
+import type { ConfigWriterEntry } from '../config-writer-entry';
+import { isUserAuthoredConfigFile } from './extending-config-files';
+
+const BIT_GENERATED_COMMENT = '// bit-generated-typescript-config';
+
+function mockConfigWriter(withIsBitGenerated = true): ConfigWriterEntry {
+  const configWriter = {
+    id: 'typescript',
+    name: 'TypescriptConfigWriter',
+    patterns: ['**/tsconfig.json'],
+    calcConfigFiles: () => undefined,
+    generateExtendingFile: () => undefined,
+  } as unknown as ConfigWriterEntry;
+  if (withIsBitGenerated) {
+    configWriter.isBitGenerated = (filePath: string) =>
+      fs.readFileSync(filePath).toString().includes(BIT_GENERATED_COMMENT);
+  }
+  return configWriter;
+}
+
+describe('isUserAuthoredConfigFile()', () => {
+  let dir: string;
+  before(async () => {
+    dir = join(tmpdir(), `bit-ws-config-files-${Date.now()}`);
+    await fs.ensureDir(dir);
+    await fs.outputFile(join(dir, 'bit-generated.json'), `${BIT_GENERATED_COMMENT}\n{ "extends": "./whatever.json" }`);
+    await fs.outputFile(join(dir, 'user-authored.json'), '{ "compilerOptions": { "strict": true } }');
+    await fs.ensureDir(join(dir, 'a-directory.json'));
+  });
+  after(async () => {
+    await fs.remove(dir);
+  });
+
+  it('should return false when the file does not exist', async () => {
+    const result = await isUserAuthoredConfigFile(join(dir, 'does-not-exist.json'), mockConfigWriter());
+    expect(result).to.be.false;
+  });
+
+  it('should return false when the existing file was generated by bit', async () => {
+    const result = await isUserAuthoredConfigFile(join(dir, 'bit-generated.json'), mockConfigWriter());
+    expect(result).to.be.false;
+  });
+
+  it('should return true when the existing file was not generated by bit', async () => {
+    const result = await isUserAuthoredConfigFile(join(dir, 'user-authored.json'), mockConfigWriter());
+    expect(result).to.be.true;
+  });
+
+  it('should return false when the writer is unable to tell whether the file was generated by bit', async () => {
+    const result = await isUserAuthoredConfigFile(join(dir, 'user-authored.json'), mockConfigWriter(false));
+    expect(result).to.be.false;
+  });
+
+  it('should return false when no config writer was given', async () => {
+    const result = await isUserAuthoredConfigFile(join(dir, 'user-authored.json'));
+    expect(result).to.be.false;
+  });
+
+  it('should return true when the existing file cannot be read', async () => {
+    const result = await isUserAuthoredConfigFile(join(dir, 'a-directory.json'), mockConfigWriter());
+    expect(result).to.be.true;
+  });
+});

package/writers/extending-config-files.ts

@@ -5,7 +5,7 @@ import fs from 'fs-extra';
 import { dirname, join, relative } from 'path';
 import pMapSeries from 'p-map-series';
 import { compact } from 'lodash';
-import type { ExtendingConfigFile } from '../config-writer-entry';
+import type { ConfigWriterEntry, ExtendingConfigFile } from '../config-writer-entry';
 import type { DedupedPaths } from '../dedup-paths';
 import { dedupePaths } from '../dedup-paths';
 import type {
@@ -31,6 +31,14 @@ export type ExtendingConfigFilesMap = {
     extendingConfigFile: Required<ExtendingConfigFile>;
   };
 };
+export type HandleExtendingConfigFilesResult = {
+  extendingConfigFiles: EnvsWrittenExtendingConfigFiles;
+  /**
+   * paths of config files that already exist in the workspace and were not generated by bit.
+   * they are left untouched, otherwise the user's own configuration would be lost.
+   */
+  skippedPaths: string[];
+};
 
 export async function handleExtendingConfigFiles(
   envEntries: EnvConfigWriterEntry[],
@@ -40,7 +48,7 @@ export async function handleExtendingConfigFiles(
   componentsRootDir: string | undefined,
   workspaceDir: string,
   opts: WriteConfigFilesOptions
-): Promise<EnvsWrittenExtendingConfigFiles> {
+): Promise<HandleExtendingConfigFilesResult> {
   const extendingConfigFilesMap = await buildExtendingConfigFilesMap(
     envEntries,
     writtenRealConfigFiles,
@@ -57,13 +65,10 @@ export async function handleExtendingConfigFiles(
     configsRootDir,
     workspaceDir
   );
-  const envsWrittenExtendingConfigFiles = await writeExtendingConfigFiles(
-    extendingConfigFilesMap,
-    fileHashPerDedupedPaths,
-    workspaceDir,
-    opts
-  );
-  return envsWrittenExtendingConfigFiles;
+  // all the entries here share the same writer-id (they're grouped by it before getting here), so any of them
+  // knows how to tell whether an existing config file was generated by bit.
+  const configWriter = envEntries[0]?.configWriter;
+  return writeExtendingConfigFiles(extendingConfigFilesMap, fileHashPerDedupedPaths, workspaceDir, configWriter, opts);
 }
 
 async function buildExtendingConfigFilesMap(
@@ -217,30 +222,55 @@ async function postProcessExtendingConfigFiles(
   });
 }
 
+/**
+ * a config file that already exists in the workspace and wasn't generated by bit is a file the user wrote.
+ * overriding it silently loses their configuration, so it's skipped unless the caller explicitly asked to force it.
+ */
+export async function isUserAuthoredConfigFile(filePath: string, configWriter?: ConfigWriterEntry): Promise<boolean> {
+  // without isBitGenerated we have no way to tell the files apart, keep the original behavior of overriding.
+  if (!configWriter?.isBitGenerated) return false;
+  if (!(await fs.pathExists(filePath))) return false;
+  try {
+    return !configWriter.isBitGenerated(filePath);
+  } catch {
+    // the file exists but can't be read. better to leave a file we know nothing about as is.
+    return true;
+  }
+}
+
 async function writeExtendingConfigFiles(
   extendingConfigFilesMap: ExtendingConfigFilesMap,
   fileHashPerDedupedPaths: DedupedPaths,
   workspaceDir: string,
+  configWriter: ConfigWriterEntry | undefined,
   opts: WriteConfigFilesOptions
-): Promise<EnvsWrittenExtendingConfigFiles> {
-  const finalResult: EnvsWrittenExtendingConfigFiles = await Promise.all(
+): Promise<HandleExtendingConfigFilesResult> {
+  const skippedPaths: string[] = [];
+  const extendingConfigFiles: EnvsWrittenExtendingConfigFiles = await Promise.all(
     fileHashPerDedupedPaths.map(async ({ fileHash, paths }) => {
       const envsConfigFile = extendingConfigFilesMap[fileHash];
       const configFile = envsConfigFile.extendingConfigFile;
       const hash = configFile.hash || sha1(configFile.content);
       const name = format(configFile.name, { hash });
-      const writtenPaths = await Promise.all(
-        paths.map(async (path) => {
-          const filePath = join(workspaceDir, path, name);
-          const targetPath = configFile.useAbsPaths
-            ? configFile.extendingTarget.filePath
-            : normalize(`./${relative(dirname(filePath), configFile.extendingTarget.filePath)}`);
-          const content = configFile.content.replace(`{${configFile.extendingTarget.name}}`, targetPath);
-          if (!opts.dryRun) {
-            await fs.outputFile(filePath, content);
-          }
-          return filePath;
-        })
+      const writtenPaths = compact(
+        await Promise.all(
+          paths.map(async (path) => {
+            const filePath = join(workspaceDir, path, name);
+            const targetPath = configFile.useAbsPaths
+              ? configFile.extendingTarget.filePath
+              : normalize(`./${relative(dirname(filePath), configFile.extendingTarget.filePath)}`);
+            const content = configFile.content.replace(`{${configFile.extendingTarget.name}}`, targetPath);
+            // the check runs for dry-run as well, so it reports what will actually happen.
+            if (!opts.force && (await isUserAuthoredConfigFile(filePath, configWriter))) {
+              skippedPaths.push(filePath);
+              return undefined;
+            }
+            if (!opts.dryRun) {
+              await fs.outputFile(filePath, content);
+            }
+            return filePath;
+          })
+        )
       );
       const res: EnvsWrittenExtendingConfigFile = {
         envIds: envsConfigFile.envIds,
@@ -255,5 +285,5 @@ async function writeExtendingConfigFiles(
       return res;
     })
   );
-  return finalResult;
+  return { extendingConfigFiles, skippedPaths };
 }

package/writers/index.ts

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