Grammalecte  readme.md at [c5b6c3d6cb]

File gc_lang/fr/nodejs/cli/readme.md artifact d51a9c9fff part of check-in c5b6c3d6cb


Client/Serveur de Grammalecte pour NodeJS

Informations

Il y a trois modes de fonctionnement: client / client interactif / serveur.

  • Client interactif: gramma-cli -i.
  • Client: gramma-cli --command \"mot/texte\".
  • Serveur: lancé avec la commande gramma-cli --server --port NumPort.

Installation

npm install grammalecte-cli -g

Commandes

  • help : Affiche les informations que vous lisez ;)
  • perf : Permet d'afficher le temps d'exécution des commandes.
  • json : Réponse en format format json.
  • exit : Client interactif: Permet de le quitter.
  • format : Permet de mettre en forme le texte.
  • check : Vérifie la grammaire et l'orthographe d'un texte.
  • lexique : Affiche le lexique du texte.
  • spell : Vérifie l'existence d'un mot.
  • suggest : Suggestion des orthographes possible d'un mot.
  • morph : Affiche les informations pour un mot.
  • lemma : Donne le lemme d'un mot.
  • text : Client / Server: Définir un texte pour plusieurs actions.
  • gceoption : Défini une option a utilisé par le correcteur de grammaire.

Client interactif

Le mode interactif est un mode question/réponse. Pour le lancer vous devez saisir gramma-cli -i.

Exemple pour les vérifications portant sur un mot:

CMD> gramma-cli -i
Bienvenu sur Grammalecte pour NodeJS!!!
GrammaJS> suggest salit
Suggestion possible de: salit
 ├ salit
 ├ salît
 ├ salie
 ├ salis
 ├ salir
 ├ salin
 ├ sali
 ├ salait
 ├ salut
 └ salât
GrammaJS> exit

Exemple pour les vérifications portant sur un texte:

CMD> gramma-cli -i
Bienvenu sur Grammalecte pour NodeJS!!!
GrammaJS> format
> salut,les copains!!!
> vous allez bien ?
> /format
Mise en forme:
salut, les copains!!!
vous allez bien ?
GrammaJS> exit

Client

Exemple simple:

CMD> gramma-cli --spell saluti
Le mot saluti innexistant

CMD>

Exemple faisant plusieurs actions:

CMD> gramma-cli --lemma --morph --suggest --text salut
Morph possible de: salut
 └ >salut/:N:m:s/*
Lemma possible de: salut
 └ salut
Suggestion possible de: salut
 ├ salut
 ├ salit
 ├ salue
 ├ salua
 ├ saluai
 ├ saluts
 ├ salué
 ├ saluât
 ├ salât
 └ salît

CMD>

Serveur

Le serveur supporte les requêtes POST et GET...

Par défaut le port d'écoute est le 2212, pour le changer il suffit d'ajouter l'argument --port lors du lancement.

Les fichiers

  • bin/gramma-cli.bat : Fait juste un appel node gramma-cli.js argument(s)
  • bin/gramma-cli.js : Le code principale pour la console
  • data/script.gramma : Exemple de script pour faire des vérifications automatiques
    • (sous widows) type script.gramma | gramma-cli -i
    • (sous linux) cat script.gramma | gramma-cli -i
  • lib/minimist.js : Une librairie pour simplifier la gestion des arguments
  • package.json : Fichier d'information pour npm
  • readme.md : Le fichier que vous lisez (ou pas) actuellement ;)

Utilisation d'une librairie (incluse)