تنزيل hound - تنزيل رمز المصدر hound

hound

شفرة المصدر الأخرى

2023-05 Patch

تنزيل

كلب

Hound هو محرك البحث عن رمز المصدر السريع للغاية. يعتمد النواة على هذه المقالة (والرمز) من Russ Cox: تعبير منتظم مطابقة مع فهرس Trigram. Hound نفسها هي واجهة رد فعل ثابتة تتحدث إلى العودة. تحتفظ الواجهة الخلفية بفهرس محدث لكل مستودع ويجيب يبحث عن الحد الأدنى من واجهة برمجة التطبيقات. هنا في العمل:

التقاط شاشة الصيد

دليل البدء السريع

بناء كلب الصيد

تثبيت GO (الحد الأدنى للنسخة المطلوبة: 1.16) و NPM
استنساخ المستودع وتشغيل.

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

يمكن العثور على الثنائيات الناتجة ( hound ، houndd ) في. -build/ bin/ directory.

قم بإنشاء ملف config.json واستخدمه لسرد المستودعات الخاصة بك. تحقق من مثالنا- config.json لمعرفة كيفية إعداد أنواع مختلفة من المستودعات. على سبيل المثال ، يمكننا تكوين Hound للبحث عن رمز المصدر الخاص به باستخدام التكوين الموجود في default-config.json:

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

يمكن العثور على قائمة كاملة بخيارات التكوين المتاحة هنا.

قم بتشغيل خادم Hound مع houndd في نفس الدليل مثل config.json . يجب أن ترى الإخراج مماثل لـ:

 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

بشكل افتراضي ، يستضيف Hound واجهة مستخدم الويب على http: // localhost: 6080. افتحه في متصفحك ، وابدأ في البحث.

باستخدام Docker (1.14+)

قم بتثبيت Docker إذا لم يكن لديك ذلك. نحتاج على الأقل Docker >= 1.14 .
قم بإنشاء ملف config.json واستخدمه لسرد المستودعات الخاصة بك. تحقق من مثالنا- config.json لمعرفة كيفية إعداد أنواع مختلفة من المستودعات. على سبيل المثال ، يمكننا تكوين Hound للبحث في رمز المصدر الخاص به باستخدام التكوين الموجود في Default-Config.json.

قم بالتشغيل مع الصورة من Github

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

يجب أن تكون قادرًا على الانتقال إلى http: // localhost: 6080/كالمعتاد.

بناء الصورة والحاوية بنفسك

مستودع استنساخ

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

بناء الصورة

 docker build . --tag=hound

إنشاء الحاوية

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

البدء وإيقاف الحاوية

 docker start hound
docker stop hound

تشغيل في الإنتاج

لا توجد أعلام خاصة لتشغيل Hound في الإنتاج. يمكنك استخدام علامة --addr=:6880 للتحكم في المنفذ الذي يرتبط به الخادم. حاليًا ، لا يدعم Hound TLS حيث أن معظم المستخدمين يقومون ببساطة بتشغيل Hound خلف Apache أو Nginx. ومع ذلك ، نحن منفتحون على المساهمات لإضافة دعم TLS.

لماذا أداة بحث رمز أخرى؟

لقد استخدمنا العديد من الأدوات المماثلة في الماضي ، ومعظمها إما بطيء للغاية ، يصعب تكوينه ، أو يحتاجون إلى تثبيت الكثير من البرامج. الذي يقودنا إلى ...

متطلبات

اذهب 1.16+

نعم ، هذا كل شيء. يمكنك وكيل الطلبات إلى خدمة GO من خلال Apache/Nginx/etc. ، لكن هذا غير مطلوب.

يدعم

يتم اختبار Hound حاليًا فقط على MacOS و CentOs ، ولكن يجب أن تعمل على أي نظام *NIX. لا يتم دعم Hound On Windows ، لكننا سمعنا أنه يجمع ويعمل بشكل جيد (على الرغم من أنه يساعد على استبعاد مجلد البيانات الخاص بك من Windows Search Indexer).

يدعم Hound أنظمة التحكم في الإصدار التالية:

git - هذا هو الافتراضي
Mercurial - استخدم "vcs" : "hg" في التكوين
SVN - استخدم "vcs" : "svn" في التكوين
Bazaar - استخدم "vcs" : "bzr" في التكوين
محلي - استخدم "vcs" : "local" في التكوين

راجع config-example.json للحصول على أمثلة حول كيفية استخدام كل VCs.

المستودعات الخاصة

هناك عدة طرق للحصول على Hound لفهرسة المستودعات الخاصة:

استخدم برنامج تشغيل Pseudo-VCS local . هذا يسمح لك بفهرسة دليل محلي. يمكنك تعيين "watch-changes" : true لحساب تجزئة متكررة لجميع الملفات في الدليل وإعادة الفهرس تلقائيًا.
استخدم file:// بروتوكول. هذا يتيح لك فهرسة استنساخ محلي لمستودع. الجانب السلبي هنا هو أن الاقتراع للحفاظ على repo حتى الآن لن يعمل. (هذا لا يعمل أيضًا على المجلدات المحلية التي لا تحتوي على نوع مستودع مدعوم.) إذا كنت تستخدم Docker ، فيجب عليك تركيب وحدة تخزين على مستودعك (على سبيل المثال ، -v $(pwd)/src:/src ) واستخدام المسار النسبي إلى الريبو في التكوين الخاص بك.
استخدم عناوين URL SSH نمط في التكوين: "url" : "[email protected]:foo/bar.git" . طالما أن لديك مفاتيح SSH الخاصة بك تم إعدادها على المربع حيث يعمل Hound هذا سيعمل.

الحفاظ على repos تحديث

بشكل افتراضي ، استطلاعات الصيد عنوان URL في التكوين للحصول على التحديثات كل 30 ثانية. يمكنك تجاوز هذه القيمة عن طريق تعيين مفتاح ms-between-poll على أساس كل ريبو في التكوين. إذا كنت تقوم بفهرسة عدد كبير من المستودعات ، فقد تكون مهتمًا أيضًا بالتبديل في خاصية max-concurrent-indexers . يمكنك أن ترى كيف تعمل هذه في مثال التكوين.

تكامل المحرر

حاليا المحررين التاليين لديهم ملحقات إضافية تدعم Hound:

نص سامي
همة
emacs
رمز الاستوديو البصري

القرصنة على كلب الصيد

التحرير والبناء

متطلبات:

يصنع
NPM (يأتي USUALL NPM مع Node.js. إذا لم يكن هذا هو الحال على النظام الذي تستخدمه ، يمكنك الحصول عليه هنا)

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

ستكون Hound Executables متوفرة في .build/bin .

الاختبار

هناك عدد متزايد من الاختبارات في كل من الحزم في كلب الصيد. يرجى التأكد من هذه المرور قبل تحميل طلب السحب الخاص بك. يمكنك إجراء الاختبارات مع الأمر التالي. لتشغيل جناح الاختبار بأكمله ، استخدم:

 make test

إذا كنت ترغب فقط في تشغيل جناح اختبار JavaScript ، فاستخدم:

 npm test

من المفترض أن تكون أي ملفات GO التي تنتهي في _test.go هي ملفات اختبار. وبالمثل ، يتم تلقائيا أي ملفات javaScript التي تنتهي في .test.js بواسطة Jest ، Runner لدينا. يجب أن تعيش الاختبارات بجوار الملفات التي تغطيها. تحقق من مستندات Jest للحصول على مزيد من التفاصيل حول كتابة اختبارات Jest ، وتحقق من مستندات اختبار Go لمزيد من التفاصيل حول رمز Go Test.

تحتاج إلى تثبيت Node.js >= 12 وتثبيت jest بواسطة npm install jest لتشغيل اختبارات JS.