string is

سلسلة

string.is هي مجموعة أدوات مفتوحة المصدر وصديقة للخصوصية للمطورين. يمكنك رؤيته في العمل هنا.

String.is هي أداة تحويل رأي ، مع الأهداف التالية:

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

دعم المتصفح

تم تأكيد String.is للعمل على Chrome و Safari و Firefox و Edge. لا يتم دعم Internet Explorer.

الجري محليا

تثبيت التبعيات:

yarn install

قم بإعداد السنانير git:

yarn husky install

قم بتشغيل خادم التطوير:

yarn dev

... ثم افتح http: // localhost: 3000 في متصفحك.

لتشغيل جميع اختبارات الطبقة ، والتحقق من الاختبارات ، والاختبارات ، والبناء للإنتاج:

yarn all

الجري مع Docker

بناء صورة Docker:

yarn docker-build

أو

docker build -t string-is .

... ثم قم بتشغيله:

yarn docker-run

أو

docker run -p 3000:3000 string-is

بدلاً من ذلك ، يمكنك بناء وتشغيله باستخدام docker-compose :

docker-compose up

... أو حتى تشغيله مباشرة من Docker Hub:

docker run -p 3000:3000 daveperrett/string-is:latest

حاليًا يتم دعم منصات linux/arm64 و linux/amd64 .

إضافة محول جديد

يحتوي مجلد src/lib على معظم منطق التحويل ، وهو نوع من النقيات ، مع عدم وجود معرفة رد فعل مطلوبة.

• يحتوي src/lib/identities على معرفات تأخذ سلسلة إدخال وتُرجع مستوى الثقة الذي يكون فيه الإدخال بتنسيق معين. على سبيل المثال ، تُرجع JwtIdentifier رقمًا يشير إلى مستوى الثقة (بين 0 و 100) بأن سلسلة إدخال معينة هي رمز JWT.
• يحتوي src/lib/inputs على محلات تحميل سلاسل من تنسيقات مختلفة. على سبيل المثال ، تقوم JsonInput بتوزيع سلسلة JSON وتُرجع كائنًا.
• يأخذ src/lib/outputs البيانات المحلية وتنسيقها في تنسيق إخراج محدد. على سبيل المثال ، يأخذ JavaScriptOutput سلسلة JavaScript ، وتنسيقها وفقًا لخيارات التنسيق المقدمة ، وتُرجع النتيجة.
• src/lib/converters هي إدخال → أزواج الإخراج - الغراء الذي يؤدي التحويل بين التنسيقات. على سبيل المثال ، يأخذ CsvToJsonConverter سلسلة CSV كمدخلات ، وتغذيها في CsvInput لتحليلها ، والأنابيب النتيجة في JsonOutput للتنسيق.

لإضافة محول جديد:

1. حدد الأشكال التي تقوم بتحويلها من وإلى . على سبيل المثال ، دعنا نتظاهر بأنك تكتب محولًا من نص عادي إلى نص عكس.
2. تحقق من وجود identity (تحت SRC/LIB/الهويات) للتنسيق من . في هذه الحالة ، نقوم بتحويل من نص عادي ، ولدينا بالفعل أمر واضح ، لذلك لا نحتاج إلى إضافة هوية جديدة. يجب أن تصدر identity (أ) دالة confidence التي ، بالنظر إلى سلسلة إدخال ، تُرجع رقمًا من 100 يصف الثقة بأن المدخلات المعطاة تتوافق مع الهوية ، و (ب) مجموعة من converters التي يمكن استخدام الهوية معها.
3. إذا قمت بإضافة identity جديدة في الخطوة (2) ، فتأكد من تصديرها في SRC/LIB/الهويات/الفهرس.
4. تحقق من وجود output (تحت SRC/LIB/المخرجات) للتنسيق إلى . يجب أن يقوم الإخراج بتصدير وظيفة output والتي ، بالنظر إلى سلسلة إدخال (أو ربما كائن ، اعتمادًا على التحويل الذي يحدث) وكائن options ، سيقوم بتحويل الإدخال إلى سلسلة الإخراج المطلوبة.
5. إذا أضفت output جديدًا في الخطوة (4) ، فتأكد من تصديره في SRC/LIB/Outss/INDEX.TS.
6. أضف converter جديدًا (تحت SRC/LIB/Converters) لزوج input + output . يجب على المحول تصدير (أ) وظيفة operation التي تمرر سلسلة الإدخال وكائن options إلى output المناسب ، و (ب) outputId ، والذي يحدد الإخراج المستخدم.
7. إذا قمت بإضافة converter جديد في الخطوة (6) ، فتأكد من تصديره في SRC/LIB/Converters/Index.ts. تأكد أيضًا من إضافة إدخالات إلى الأماكن/en/pages-converter.json] بحيث يكون للصفحة المقصودة التي تم إنشاؤها تلقائيًا العنوان الصحيح والنص المقدمة والمثال.
8. إذا قمت بتعريف outputId جديد في الخطوة (6) ، فأضف مكون الإخراج React (تحت SRC/المكونات/المجال/التحويل/المخرجات) لتقديم النوع الجديد من الإخراج. إذا كنت تقوم بإعادة استخدام نوع إخراج موجود (على سبيل المثال ، التحويل إلى JSON أو YAML) ، فيمكنك إعادة استخدام مكون الإخراج الموجود هنا.
9. إذا قمت بإضافة مكون React جديد في الخطوة (8) ، فتأكد من تصديره في المكونات/المكونات/المجال/التحويل/المخرجات.

إذا كانت inputs outputs converters ومكونات التفاعل المناسبة في مكانها وتصديرها بشكل صحيح ، فيجب أن تكون قادرًا على استخدام المحول الجديد الخاص بك ، بالنظر إلى سلسلة الإدخال المناسبة التي تؤدي إلى confidence غير صفرية.

النشر

إذا كنت تريد أن تكون واثقًا بنسبة 100 ٪ من أن خصوصيتك محمية ، فيمكنك بسهولة إعداد سلسلة. مثيل لاستخدامك الشخصي أو التنظيمي.

أسرع طريقة لنشر String.is هي استخدام منصة Vercel (إنها مجانية للاستخدام غير التجاري). تحقق من وثائق نشر NEXT.JS لمزيد من التفاصيل. انقر فوق الزر Deploy أدناه لنشر هذا التطبيق باستخدام Vercel:

يعد NetLify و Heroku أيضًا خيارات جيدة للاستضافة المجانية. انقر فوق الزر Deploy أدناه لنشر هذا التطبيق باستخدام Heroku:

لسوء الحظ ، لا يدعم string.is حاليًا عمليات البناء الثابت عبر next export (والتي ستسمح بالاستضافة على مثل S3) ، لأن ميزة i18n التي يستخدمها غير مدعومة حاليًا للبناء الثابتة.

نشر string.is تحت المسار الفرعي للمجال

قم بتعيين متغير بيئة NEXT_PUBLIC_BASE_PATH على المسار الفرعي ، ثم قم بإنشاء المشروع قبل النشر. يجب تعيين هذه القيمة في وقت الإنشاء ولا يمكن تغييرها دون إعادة بناء لأن القيمة مضمّنة في حزم من جانب العميل.

على سبيل المثال ، إذا كنت تنشر على https://tools.example.com/string-is ، فستحتاج إلى تعيين NEXT_PUBLIC_BASE_PATH إلى /string-is . لا تحتاج إلى تعيين هذا المتغير إذا كنت تنشر في جذر المجال.

بناء وتشغيل مع Docker:

docker build -t string-is --build-arg NEXT_PUBLIC_BASE_PATH= " /string-is " .
docker run -p 3000:3000 string-is

أو بناء وتشغيل مع docker-compose :

 export NEXT_PUBLIC_BASE_PATH= " /string-is "
docker-compose up --build

التوطين

String.is يدعم التوطين الكامل. يجب إضافة لغات جديدة تحت locales/ المجلد بتنسيق JSON (انظر locales/en/ على سبيل المثال). تعد اللغة الإنجليزية هي المكان الوحيد المقدم ، لكن دعم اللغات الجديدة مرحب به.

التحليلات

يتضمن String.is دعمًا للتحليلات المعقولة ، وهي خدمة تحليلات ملائمة للخصوصية ، وأقل ملفات تعريف الارتباط. لتمكينه ، قم بتعيين متغير بيئي يحدد المجال:

 NEXT_PUBLIC_ANALYTICS_DOMAIN=string.is

يتم تعطيل Analytics افتراضيًا ما لم يتم تعيين process.env.NODE_ENV === 'production' ومجال NEXT_PUBLIC_ANALYTICS_DOMAIN .

المساهمة

بمجرد إجراء تغييراتك:

1. سلسلة شوكة
2. قم بإنشاء فرع موضوع- git checkout -b feature/add-my-new-converter
3. ادفع إلى فرعك- git push origin feature/add-my-new-converter
4. إنشاء طلب سحب من فرعك
5. هذا كل شيء!

مؤلف

davemetrics

الترخيص

انظر الترخيص للحصول على التفاصيل.