tilttek/writing-goals

tilttek/writing-goals tient les objectifs d'écriture d'un auteur et en suit l'avancement. Un objectif est une cible en mots ou en pages, d'un premier jour à une échéance, les deux inclus, répartie sur les jours de la semaine où l'auteur choisit d'écrire, moins les dates qu'il met de côté. Son plan suit une courbe : la même part chaque jour, davantage au début, davantage à la fin, ou des poids que l'auteur dessine. Le quota de chaque jour d'écriture est ce qui reste, partagé entre les jours d'écriture restants, en proportion de leur poids dans l'ensemble du plan : un jour sans écriture n'est pas un échec, sa part passe aux jours suivants, qui gardent la forme de la courbe ; un jour d'avance les abaisse. L'auteur consigne ce qu'il écrit chaque jour, retire un compte consigné trop haut, ou corrige un jour. Un plan répond ce qui a été écrit, ce qui reste, le quota du jour et ce qu'il en reste, le quota de chaque jour d'écriture jusqu'à l'échéance, la part de la cible écrite, et si l'objectif est atteint — l'application en est informée une fois — ou dépassé son échéance, que l'auteur repousse sans rien perdre. Aucune série n'est comptée. Effacer un auteur supprime ses objectifs et ses comptes.

Il s'adresse à une plateforme d'écriture ou à une communauté qui veut aider les auteurs à terminer ce qu'ils commencent — un roman en un mois, un livre-jeu en une saison — sans la pression d'une chaîne qui se rompt au premier jour manqué.

C'est une bibliothèque PHP simple dont les dépendances sont phil/resource, la référence opaque d'un auteur, psr/clock, l'horloge où se lit le jour d'aujourd'hui de l'auteur, et psr/event-dispatcher, qui informe l'application d'un objectif atteint. Les auteurs sont des références que donne l'application, member:44 : la bibliothèque ne lit jamais un nom, un courriel ni un texte ; l'application compte les mots et consigne le compte.

La conception est petite : un Goal tient sa cible, ses Day, son Unit, sa Curve et ses WritingDays ; un Planner transforme un objectif et son Progress en un Plan de DailyQuota ; WritingGoals garde les objectifs dans un GoalStore, consigne les comptes dans un LogStore et envoie GoalReached.

État

Documentation

Démarrage rapide

composer require tilttek/writing-goals

use Phil\Resource\ResourceReference;
use Symfony\Component\Clock\Clock;
use Tilttek\WritingGoals\{Curve, Day, Goal, WritingDays, WritingGoals};
use Tilttek\WritingGoals\Store\{InMemoryGoalStore, InMemoryLogStore};

$goals = new WritingGoals(new InMemoryGoalStore(), new InMemoryLogStore(), new Clock(), $dispatcher);

$goals->save(new Goal(
    'novel-2026',
    ResourceReference::of('member', '44'),
    50_000,
    Day::fromString('2026-11-01'),
    Day::fromString('2026-11-30'),
    curve: Curve::frontLoaded(),
    writingDays: WritingDays::on(1, 2, 3, 4, 5, 6),
    timezone: 'America/Montreal',
));

$plan = $goals->log('novel-2026', 1_200);
$plan->todayQuota;   // what today asks for
$plan->leftToday();  // what is left of it
$plan->remaining();  // what is left of the target

Prérequis

PHP 8.5 ou une version plus récente.

Contribuer

Les contributions sont les bienvenues sur le monodépôt de PHIL : lisez le guide de contribution et le code de conduite, en anglais. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Tilttek project. Voir LICENSE.