Téléchargement hound - Téléchargement du code source hound

hound

Autre code source

2023-05 Patch

Télécharger

Chien

Hound est un moteur de recherche de code source extrêmement rapide. Le noyau est basé sur cet article (et code) de Russ Cox: Expression régulière correspondant à un index du trigramme. Hound lui-même est un frontage de réaction statique qui parle à un backend Go. Le backend conserve un index à jour pour chaque référentiel et répond aux recherches via une API minimale. Ici, c'est en action:

Capture d'écran de chasse

Guide de démarrage rapide

Édifice

Installer Go (version minimale requise: 1.16) et NPM
Clone le référentiel et la marque Run.

 git clone https://github.com/hound-search/hound.git
cd hound
make

Les binaires résultants ( hound , houndd ) peuvent être trouvés dans le .build / bin / répertoire.

Créez un fichier config.json et utilisez-le pour répertorier vos référentiels. Consultez notre exemple-Config.json pour voir comment configurer différents types de référentiels. Par exemple, nous pouvons configurer Hound pour rechercher son propre code source en utilisant la configuration trouvée dans default-config.json:

{
  "dbpath" : " db " ,
  "repos" : {
    "Hound" : {
      "url" : " https://github.com/hound-search/hound.git " ,
      "vcs-config" : {
        "ref" : " main "
      }
    }
  }
}

Une liste complète des options de configuration disponibles peut être trouvée ici.

Exécutez le serveur Hound avec houndd dans le même répertoire que votre config.json . Vous devriez voir une sortie similaire à:

 2015/03/13 09:07:42 Searcher started for statsd
2015/03/13 09:07:42 Searcher started for Hound
2015/03/13 09:07:42 All indexes built!
2015/03/13 09:07:42 running server at http://localhost:6080

Par défaut, Hound héberge une interface utilisateur Web sur http: // localhost: 6080. Ouvrez-le dans votre navigateur et commencez à chercher.

Utilisation de Docker (1.14+)

Installez Docker si vous ne l'avez pas. Nous avons besoin d'au moins Docker >= 1.14 .
Créez un fichier config.json et utilisez-le pour répertorier vos référentiels. Consultez notre exemple-Config.json pour voir comment configurer différents types de référentiels. Par exemple, nous pouvons configurer Hound pour rechercher son propre code source à l'aide de la configuration trouvée dans default-config.json.

Exécutez avec l'image de GitHub

 docker run -d -p 6080:6080 --name hound -v $(pwd):/data ghcr.io/hound-search/hound:latest

Vous devriez être en mesure de naviguer vers http: // localhost: 6080 / comme d'habitude.

Créez l'image et le conteneur vous-même

Référentiel de clones

 git clone https://github.com/hound-search/hound.git
cd hound

Construisez l'image

 docker build . --tag=hound

Créer le conteneur

 docker create -p 6080:6080 --name hound -v $(pwd):/data hound

Démarrer et arrêter le conteneur

 docker start hound
docker stop hound

Running in Production

Il n'y a pas de drapeaux spéciaux pour gérer le chien en production. Vous pouvez utiliser l'indicateur --addr=:6880 pour contrôler le port auquel le serveur se lie. Actuellement, Hound ne prend pas en charge TLS car la plupart des utilisateurs exécutent simplement Hound derrière Apache ou Nginx. Cependant, nous sommes ouverts aux contributions pour ajouter le support TLS.

Pourquoi un autre outil de recherche de code?

Nous avons utilisé de nombreux outils similaires dans le passé, et la plupart d'entre eux sont soit trop lents, trop difficiles à configurer ou nécessitent trop de logiciels. Ce qui nous amène à ...

Exigences

Aller 1.16+

Ouais, c'est tout. Vous pouvez procurer les demandes au service GO via Apache / Nginx / etc., Mais ce n'est pas requis.

Soutien

Actuellement, Hound n'est testé que sur macOS et CentOS, mais il devrait fonctionner sur n'importe quel système * Nix. Hound on Windows n'est pas pris en charge, mais nous l'avons entendu compiler et s'exécute très bien (bien qu'il aide à exclure votre dossier de données de Windows Search Indexer).

Hound prend en charge les systèmes de contrôle de version suivants:

Git - c'est la valeur par défaut
Mercurial - Utilisez "vcs" : "hg" dans la configuration
SVN - Utilisez "vcs" : "svn" dans la configuration
Bazar - Utilisez "vcs" : "bzr" dans la configuration
Local - Utilisez "vcs" : "local" dans la configuration

Voir config-example.json pour des exemples d'utilisation de chaque VCS.

Référentiels privés

Il existe quelques façons d'obtenir Hound pour indexer les référentiels privés:

Utilisez le pilote pseudo-VCS local . Cela vous permet d'indexer un répertoire local. Vous pouvez définir "watch-changes" : true pour calculer un hachage récursif de tous les fichiers du répertoire et réindexer automatiquement.
Utilisez le file:// protocole. Cela vous permet d'indexer un clone local d'un référentiel. L'inconvénient ici est que le sondage pour maintenir le repo à jour ne fonctionnera pas. (Cela ne fonctionne pas non plus sur des dossiers locaux qui ne sont pas d'un type de référentiel pris en charge.) Si vous utilisez Docker, vous devez monter un volume dans votre référentiel (par exemple, -v $(pwd)/src:/src ) et utiliser le chemin relatif vers le repo dans votre configuration.
Utilisez des URL de style SSH dans la configuration: "url" : "[email protected]:foo/bar.git" . Tant que vos clés SSH sont configurées sur la boîte où Hound fonctionne, cela fonctionnera.

Garder les reposs à jour

Par défaut, Hound interroge l'URL dans la configuration pour les mises à jour toutes les 30 secondes. Vous pouvez remplacer cette valeur en définissant la touche ms-between-poll sur une base par référentiel dans la configuration. Si vous indexez un grand nombre de référentiels, vous pouvez également être intéressé à peaufiner la propriété max-concurrent-indexers . Vous pouvez voir comment ceux-ci fonctionnent dans l'exemple de configuration.

Intégration de l'éditeur

Actuellement, les éditeurs suivants ont des plugins qui prennent en charge le chien:

Texte sublime
Vim
Emacs
Code Visual Studio

Piratage sur le chien

Édition et construction

Exigences:

faire
NPM (USUALL NPM est livré avec Node.js. Si ce n'est pas le cas sur le système que vous utilisez, vous pouvez l'obtenir ici)

 git clone https://github.com/hound-search/hound.git
cd hound
make

Les exécutables Hound seront disponibles dans .build/bin .

Essai

Il y a un nombre croissant de tests dans chacun des packages de Hound. Veuillez vous assurer que ceux-ci passent avant de télécharger votre demande de traction. Vous pouvez exécuter les tests avec la commande suivante. Pour exécuter toute la suite de tests, utilisez:

 make test

Si vous souhaitez simplement exécuter la suite de tests JavaScript, utilisez:

 npm test

Tous les fichiers GO qui se terminent dans _test.go sont supposés être des fichiers de test. De même, tous les fichiers JavaScript qui se terminent par .test.js sont automatiquement exécutés par Jest, notre Runner de test. Les tests doivent vivre à côté des fichiers qu'ils couvrent. Consultez les documents de Jest pour plus de détails sur la rédaction de tests JEST et consultez les documents de test de Go pour plus de détails sur le test du code GO.

Vous devez installer Node.js >= 12 et installer jest par npm install jest pour exécuter les tests JS.

Travailler sur l'interface utilisateur Web

Hound comprend une interface utilisateur Web composée de plusieurs fichiers (HTML, CSS, JavaScript, etc.). Pour compiler l'utilisation des modifications de l'interface utilisateur:

 make ui

Pour faciliter le développement, il existe un drapeau qui lira les fichiers du système de fichiers (permettant le cycle d'édition / actualisation très apprécié).

Vous devez d'abord vous assurer que toutes les dépendances sont installées dont vous avez besoin en fonctionnant: