org.sonar.plugins.javascript.eslint.tsconfig.TsConfigProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-javascript-plugin Show documentation
Code Analyzer for JavaScript/TypeScript/CSS
There is a newer version: 10.17.0.28100
Show newest version
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2022 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.plugins.javascript.eslint.tsconfig;

import java.io.IOException;
import java.util.List;
import javax.annotation.Nullable;
import org.sonar.api.SonarProduct;
import org.sonar.api.batch.sensor.SensorContext;
import org.sonar.plugins.javascript.eslint.ProjectChecker;

import static java.util.Collections.emptyList;

public class TsConfigProvider {

  public static List generateDefaultTsConfigFile(SensorContext context, @Nullable ProjectChecker projectChecker,
    TsConfigFileCreator tsConfigFileCreator) throws IOException {
    return getTsConfigFiles(context, projectChecker, tsConfigFileCreator);
  }

  public static List searchForTsConfigFiles(SensorContext context) throws IOException {
    // When searching for tsconfig.json files we don't generate default files therefore we don't need either
    // TSConfigFileCreator or ProjectChecker. The later aims at verifying there are not too many files for
    // TypeScript when using the default tsconfig.json file.
    return getTsConfigFiles(context, null, null);
  }

  /**
   * Relying on (in order of priority)
   * 1. Property sonar.typescript.tsconfigPath(s) if no tsconfig.json file creator
   * 2. Looking up file system if no tsconfig.json file creator
   * 3. Creating a tmp tsconfig.json if SonarQube or SonarLint below limit (see SonarLintProjectChecker)
   */
  private static List getTsConfigFiles(SensorContext context, @Nullable ProjectChecker projectChecker,
    @Nullable TsConfigFileCreator tsConfigFileCreator) throws IOException {
    List providers;
    if (tsConfigFileCreator == null) {
      providers = List.of(new PropertyTsConfigProvider(), new LookupTsConfigProvider());
    } else if (!isBeyondLimit(context, projectChecker)) {
      providers = List.of(new DefaultTsConfigProvider(tsConfigFileCreator));
    } else {
      providers = emptyList();
    }
    var tsConfigProvider = new TsConfigProvider(context, providers);
    return tsConfigProvider.tsconfigs();
  }

  private static boolean isBeyondLimit(SensorContext context, @Nullable ProjectChecker projectChecker) {
    if (context.runtime().getProduct() == SonarProduct.SONARQUBE) {
      return false;
    } else if (projectChecker == null) {
      return true;
    } else {
      projectChecker.checkOnce(context);
      return projectChecker.isBeyondLimit();
    }
  }

  private final SensorContext context;
  private final List providers;

  public TsConfigProvider(SensorContext context, List providers) {
    this.context = context;
    this.providers = List.copyOf(providers);
  }

  public List tsconfigs() throws IOException {
    for (Provider provider : providers) {
      List tsconfigs = provider.tsconfigs(context);
      if (!tsconfigs.isEmpty()) {
        return tsconfigs;
      }
    }
    return emptyList();
  }

}