swift selection search

Recherche de sélection rapide

---

Remarque: le développement est sur une pause indéfinie (désolé!)

• Veuillez utiliser la page des problèmes uniquement pour signaler les bogues très problématiques que vous pouvez trouver.
• Ce projet n'accepte pas les demandes de traction.
• Je vous encourage à travailler sur votre propre version de SSS et à le publier comme un addon amélioré. Même pour les autres navigateurs!

Vous pouvez en savoir plus ici.

---

Description

Swift Selection Search (SSS) est un module complémentaire Firefox pour rechercher rapidement du texte dans une page en utilisant vos moteurs de recherche préférés.

Sélectionnez du texte sur une page et une petite boîte contextuelle avec des moteurs de recherche apparaîtra au-dessus de votre curseur. Appuyez sur un et vous rechercherez automatiquement le texte sélectionné à l'aide de ce moteur!

SSS est configurable. Vous pouvez définir quels moteurs de recherche apparaissent sur la fenêtre contextuelle, l'apparence des icônes, ce qui se passe lorsque vous cliquez sur eux, où la fenêtre contextuelle apparaît, que ce soit ou non lorsque la page défile, si vous souhaitez copier automatiquement le texte sur la sélection et bien d'autres options.

Vous obtenez également un menu contextuel facultatif pour la recherche avec l'un de vos moteurs. Vous pouvez désactiver ce menu supplémentaire dans les options si vous le souhaitez. Vous avez également la possibilité de désactiver la popup elle-même et de ne laisser que ce menu contextuel. Votre choix. :)

SSS est disponible sur le site Web de Mozilla Add-ons, ici:

https://addons.mozilla.org/firefox/addon/swift-selection-search

Comment construire

Premièrement, comme WeBExtensions est fabriquée en JavaScript, nous devons être en mesure de convertir TypeScript en JavaScript, de préférence d'une manière aussi automatique que possible.

1. Installez NPM . Téléchargez Node.js à partir de https://nodejs.org et vous obtiendrez NPM à côté.

2. Dans le dossier du projet, exécutez ceci dans la ligne de commande:

   Installation de NPM

   Cela installera localement les dépendances dactylographiées du projet dans le dossier Node_Modules .

3. Pour transpiler tous les scripts .ts sur .js (sur Windows):

   "node_modules / .bin / tsc.cmd" - watch -p tsconfig.json

   La commande restera en vie et révèlera automatiquement le code après toute modification des fichiers .ts, ce qui est utile pendant le développement.

Vous avez maintenant des fichiers .js, vous pouvez donc utiliser SSS comme weBExtension. Ouais!

• Pour un court développement ou tout simplement la curiosité, la façon plus simple d'essayer SSS est la page à propos: débogage # addons dans Firefox. Appuyez sur le bouton "Chargez Temporary Add-on", sélectionnez un fichier dans le répertoire Swift Selection Search "SRC" (par exemple Manifest.json ), et il chargera le module complémentaire jusqu'à ce que le navigateur soit fermé. Les modifications de la plupart des code nécessitent à nouveau le rechargement du module complémentaire.

• Pour un développement et / ou des emballages plus prolongés, tels que le rechargement automatique après chaque modification, veuillez suivre les instructions de Mozilla ici pour installer et utiliser l'outil Web-EXT .

Comment contribuer du code à SSS

Préparation

1. Fourk le référentiel sur GitHub et le cloner sur votre ordinateur.

2. Suivez les instructions ci-dessus pour comment construire .

   En fin de compte, vous devriez avoir un script qui transpire automatiquement le code de TypeScript à JavaScript, et devrait savoir comment exécuter votre version de SSS sur Firefox.

3. Apprenez que SSS a 3 branches principales:

   • Master - Versions finales publiées dans les modules complémentaires de Mozilla. "Master" indiquera généralement un engagement où la version SSS change, car ce sont celles publiées (généralement, il y a un engagement juste à mettre à jour la version).
   • Développer - où le développement se produit et où de nouvelles fonctionnalités seront fusionnées. Moins stable, mais ne devrait pas avoir de fonctionnalités incomplètes.
   • Addon-sdk - peut être ignoré, car c'est le code de SSS avant qu'il ne soit un weBextension. Essentiellement une archive.

4. Lisez les directives du code ci-dessous.

Directives de code

• Onglets pour l'indentation, s'il vous plaît! ;) (Les espaces peuvent être utilisés pour aligner les choses.)
• Pas d'espace blanc à la fin des lignes. Des paramètres comme "Files.trimtrailingwhitespace" de VScode aident à cela.
• Essayez de suivre le style que vous voyez dans le code existant. Si vous pensez que c'est incohérent à certains endroits, n'hésitez pas à faire votre propre truc. Il sera de toute façon examiné. ;)
• SSS prend actuellement en charge Firefox 63, ce qui signifie que vous devez prendre des soins supplémentaires lorsque vous utilisez une API WeBextensions. Assurez-vous qu'il existe dans Firefox 63, ou du moins que le code ne s'exécute pas et ne s'écrase pas sur des versions plus anciennes. Idéalement, installez Firefox 63 séparément sur votre ordinateur (avoir un profil Firefox différent pour cela aide considérablement) et désactiver ses mises à jour automatique.

Collaboration

1. Trouvez un problème que vous souhaitez résoudre dans la liste des problèmes.

2. Demandez si quelqu'un y travaille déjà. De plus, s'il manque des détails sur la façon de mettre en œuvre ou si vous voulez connaître les approches possibles, n'hésitez pas à demander!

3. Créez une nouvelle branche GIT pour la nouvelle fonctionnalité ou correction de bogue que vous essayez d'implémenter. Créez cette branche à partir de "développer", pour simplifier la fusion plus tard (car "maître" peut ne pas avoir toutes les modifications actuelles).

4. Implémentez et engagez / poussez les modifications à la branche, peut-être dans plusieurs engins.

5. Créez enfin une demande de traction pour fusionner vos modifications au référentiel d'origine. Il sera soumis à l'examen du code, à la discussion et éventuellement des modifications si nécessaire.

   Merci!

Considérations et avertissements dactylographiés

SSS a été porté à un moment donné de JavaScript à TypeScript pour obtenir les avantages des annotations de type, car de nombreuses erreurs peuvent être capturées par le vérificateur de type. Cependant, il convient de noter que l'interaction de WeBExtensions avec TypeScript est au mieux capricieuse, car TypeScript suppose que les scripts peuvent importer du code / des données à partir d'autres scripts, alors qu'en réalité l'environnement WeBextensions a du sable et le permet rarement.

Les scripts de contenu ne voient pas le code à partir du script d'arrière-plan, ou vice-versa, et la seule façon dont plusieurs scripts de contenu peuvent même voir le code de l'autre est si tous sont injectés sur la même page par le script d'arrière-plan, similaire à la façon dont ils le feraient s'ils étaient inclus dans une page HTML en tant que scripts. TypeScript n'a aucune idée que c'est ainsi que WEBExtensions fonctionne, donc ce n'est pas parce que quelque chose se transpire correctement en JavaScript, cela ne signifie pas que la weBextension fonctionnera.

Un exemple qui fonctionne est que nous pouvons déclarer les types / classes dans le script d'arrière-plan et les référencer dans d'autres scripts, car seul le type Checker se soucie d'eux. Nous obtenons la vérification du type et c'est bien.

Cependant, si nous essayons d'ajouter à ces classes, certaines méthodes, affectations variables, etc., les scripts de contenu ou les scripts de page d'options ne les verront pas. Lors du passage à JavaScript, ils seront laissés comme référence au code dans un autre script, qui ne peut pas être référencé lors de l'exécution en raison du sable de sable WeBExtensions. Cela est également vrai pour les énumérations (qui ont des valeurs concrètes, donc "données") à moins que nous ne les déclarons en tant const enum , auquel cas TypeScript copie leurs valeurs à leur utilisation au lieu de créer des objets JavaScript.

Donc, si vous voyez une classe entièrement ou partiellement déclarée dans plus d'un script dans ce projet (par exemple dans le script d'arrière-plan et le script de page), ce qui précède est pourquoi.

Une autre chose qui peut échouer est d'utiliser instanceof pour vérifier si un objet est d'une certaine classe. Ne faites pas cela pour les classes créées sur mesure car elle peut échouer en raison du sable.