Function write_file

tools/maint/update_settings_docs.py:117–160

(f)

def write_file(f):
  f.write(header)

  current_comment = []
  current_tags = []
  for line in read_file(path_from_root('src/settings.js')).splitlines():
    if not line:
      current_comment = []
      current_tags = []
    if line.startswith('//'):
      line = line[2:]
      # Strip at most one leading space
      if line and line[0] == ' ':
        line = line[1:]
      if line.startswith('[') and line.endswith(']'):
        tag = line.strip('[')
        tag = tag.rstrip(']')
        if tag in all_tags:
          current_tags.append(tag)
          continue
      current_comment.append(line)
    elif line.startswith('var'):
      # Format:
      #   var NAME = DEFAULT;
      # Split it and strip the final ';'.
      _, setting_name, _, setting_default = line.strip(';').split(None, 3)
      comment = '\n'.join(current_comment).strip()
      check_tags(setting_name, current_tags)
      write_setting(f, setting_name, setting_default, comment, current_tags)
      current_comment = []
      current_tags = []

  f.write(deprecated_header)

  for name, desc in DEPRECATED_SETTINGS.items():
    f.write(f' - ``{name}``: {desc}\n')

  f.write(legacy_header)

  for name, values, *extra_fields in LEGACY_SETTINGS:
    desc = f'Valid values: {values}'
    if extra_fields:
      desc = f'{extra_fields[0]} ({desc})'
    f.write(f' - ``{name}``: {desc}\n')


def main(args):