logifix

Logifix

Logifix est un outil basé sur des dats pour corriger automatiquement les violations d'analyse statique dans le code source Java. Logifix peut être utilisé pour corriger les violations d'analyse statique pour les analyseurs statiques tels que Sonarqube, PMD ou SpotBugs, mais aussi pour moderniser le code hérité ou même pour appliquer automatiquement des règles personnalisées spécifiques à votre base de code.

Démo

démo.mp4

Commencer

1. Installer

Des binaires prédéfinis et sans dépendance sont fournis pour les systèmes Linux à base de macOS et GNU.

Ubuntu / Debian

curl -L https://github.com/lyxell/logifix/releases/latest/download/logifix-x86_64-linux-gnu.gz | gunzip -c - > /tmp/logifix
chmod +x /tmp/logifix
sudo mv /tmp/logifix /usr/local/bin

macos

curl -L https://github.com/lyxell/logifix/releases/latest/download/logifix-x86_64-macos.gz | gunzip -c - > /tmp/logifix
chmod +x /tmp/logifix
sudo mv /tmp/logifix /usr/local/bin

2. Run

• Exécutez logifix path/to/your/project dans votre terminal, exécutez logifix --help pour obtenir de l'aide

Qu'est-ce que Logifix?

Logifix est un système de réécriture guidé par l'analyse pour le code source Java. Cela signifie que vous définissez (ou utilisez des analyses et des transformations prédéfinies) qui fonctionnent tous ensemble pour améliorer votre code. Les analyses et les transformations sont écrites dans le désir de langue basé sur la logique hautement déclarative et sont combinées et enchaînées automatiquement par le moteur de réécriture.

Caractéristiques

Raisonnement équinal intelligent

Logifix est plus qu'un système de recherche et de repensation. Il effectue des réécritures en plusieurs étapes et peut réaliser un raisonnement équilibré intelligent en construisant des points d'articulation dans le graphique de réécriture.

Vitesse

Logifix est implémenté dans un dialecte de datalog haute performance qui est synthétisé en code C ++ multithread. Il est fortement parallélisé même lorsqu'il travaille sur un seul fichier et analyse généralement de grands projets de milliers de fichiers en quelques secondes sur le matériel moderne. Si votre projet est lent à analyser, il est considéré comme un bogue et vous devez déposer un rapport de bogue.

Fusion

Logifix est conçu pour produire des correctifs de type humain qui sont prêts à l'emploi par conception sans nécessiter de modifications manuelles.

Exemples

Voici quelques exemples de correctifs générés par Logifix.

Correction d'une itération inefficace sur la carte # keysset

  public static void sign(String token, Map<String, String> params) {
      List<String> list = new ArrayList();
      String tokenClientSlat = "";
-     for (String key : params.keySet()) {
+     for (Map.Entry<String, String> entry : params.entrySet()) {
+         String key = entry.getKey();
          if (key.equals("token_client_salt")) {
-             tokenClientSlat = params.get(key);
+             tokenClientSlat = entry.getValue();
          }
-         String paramString = key + "=" + params.get(key);
+         String paramString = key + "=" + entry.getValue();
          list.add(paramString);
      }
      Collections.sort(list);

Simplifiez le code à l'aide de TRY-with-Resources

          continue;
      } 
-     try {
-         JarFile nextJarFile = new JarFile(absNextFile);
-         try {
-             Attributes attrs = getMainAttrs(nextJarFile);
-             Set<Extension> newExtensions = getReferencedExtensions(attrs);
-             result.addAll(newExtensions);
-             filesToProcess.addAll(extensionsToFiles(newExtensions));
-         } finally {
-             nextJarFile.close();
-         }
+     try (JarFile nextJarFile = new JarFile(absNextFile)) {
+         Attributes attrs = getMainAttrs(nextJarFile);
+         Set<Extension> newExtensions = getReferencedExtensions(attrs);
+         result.addAll(newExtensions);
+         filesToProcess.addAll(extensionsToFiles(newExtensions));
      } catch (Exception e) {
          invalidLibPaths.append(nextFile.getPath()).append(" ");
      }

Simplifier le code à l'aide de la carte :: ComputeIfabsensente

  private final Map<Class<?>, String> requestQueueNameCache = new ConcurrentHashMap<>();
     
  public String getRequestQueueName(Class<?> remoteInterface) {
-     String str = requestQueueNameCache.get(remoteInterface);
-     if (str == null) {
-         str = "{" + name + ":" + remoteInterface.getName() + "}";
-         requestQueueNameCache.put(remoteInterface, str);
-     }
-     return str;
+     return requestQueueNameCache.computeIfAbsent(remoteInterface, k -> "{" + name + ":" + k.getName() + "}");
  }

Simplifier le code à l'aide de flux

  @Override
  public List<SpoonFile> getAllJavaFiles() {
-     List<SpoonFile> result = new ArrayList<>();
-
-     for (SpoonFile f : getAllFiles()) {
-         if (f.isJava()) {
-             result.add(f);
-         }
-     }
-
-     return result;
+     return getAllFiles().stream().filter(SpoonFile::isJava).collect(Collectors.toList());
  } 

FAQ

Où puis-je trouver les transformations prédéfinies?

Voir docs / prédéfini-transformations.md ou le code source src / règles.

Puis-je créer mes propres transformations?

Oui! Voir Docs / Création de votre propre transformation.md.

Comment construire à partir de la source?

Voir Docs / Building.Md.

Projets connexes

Si vous trouvez ce projet intéressant, assurez-vous de les consulter également:

• Souffle-Lang / Souffle - Le compilateur de données utilisé par Logifix
• Egraphs-Good / Egg - Une belle bibliothèque pour une saturation efficace pour l'égalité des systèmes de réécriture
• Comby-Tools / Comby - Un outil de recherche et de repensage basé sur AST léger