lib/src/experiment_options.dart

// Copyright (c) 2018, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

///
/// Implementation of Dart language experiment option handling for dartdoc.
/// See https://github.com/dart-lang/sdk/blob/main/docs/process/experimental-flags.md.
///
library dartdoc.experiment_options;

import 'package:analyzer/file_system/file_system.dart';
// ignore: implementation_imports
import 'package:analyzer/src/dart/analysis/experiments.dart';
import 'package:dartdoc/src/dartdoc_options.dart';

mixin DartdocExperimentOptionContext implements DartdocOptionContextBase {
  List<String> get enableExperiment =>
      optionSet['enable-experiment'].valueAt(context);
}

// TODO(jcollins-g): Implement YAML parsing for these flags and generation
// of [DartdocExperimentOptionContext], once a YAML file is available.
List<DartdocOption<Object>> createExperimentOptions(
    ResourceProvider resourceProvider) {
  var knownFeatures = ExperimentStatus.knownFeatures.values;
  var featureHelpTexts =
      knownFeatures.map((e) => '    [no-]${e.enableString}: ${e.documentation} '
          '(default: ${e.isEnabledByDefault})');
  return [
    // TODO(jcollins-g): Consider loading experiment values from
    // dartdoc_options.yaml?
    DartdocOptionArgOnly<List<String>>(
        'enable-experiment', ['non-nullable'], resourceProvider,
        help: 'Enable or disable listed experiments.\n'
            '${featureHelpTexts.join('\n')}'),
  ];
}