@we-scrum/cli 6.9.3 → 6.9.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@we-scrum/cli",
-  "version": "6.9.3",
+  "version": "6.9.5",
   "description": "Cli tool for we-scrum application",
   "main": "dist/cli.js",
   "bin": {
@@ -39,9 +39,9 @@
     "typescript": "^6.0.3",
     "@my-devkit/cli": "2.1.0",
     "@we-scrum/enums": "1.0.0",
+    "@my-devkit/core": "1.0.0",
     "@we-scrum/commands": "1.0.0",
     "@we-scrum/models": "1.0.0",
-    "@my-devkit/core": "1.0.0",
     "@we-scrum/utils": "1.0.0"
   },
   "scripts": {

package/src/commands/change-thread.ts

@@ -7,11 +7,11 @@ import { Command, Option } from 'commander';
 export function registerChangeThreadCommands(program: Command): void {
     program
         .command('get-change-threads')
-        .description('Get the open change threads for a change')
+        .description('Get all the change threads (any status) for a change')
         .requiredOption('-c, --changeId <id>', 'Unique identifier of the change')
         .action(
             runProjectCommand<{ changeId: string }>(async (options) => {
-                return WeScrumHelper.getOpenChangeThreads(options.changeId);
+                return WeScrumHelper.getChangeThreads(options.changeId);
             }),
         );
 

package/src/commands/task.ts

@@ -25,6 +25,9 @@ export function registerTaskCommands(program: Command): void {
             runProjectCommand<{ identificationNumber: string; changeId: string }>(async (options) => {
                 await WeScrumHelper.completeTask(options.identificationNumber, options.changeId);
                 Logger.info('Task completed successfully.');
+                Logger.info(
+                    'Reminder: if the result deviates from the task description (including changes requested by the developer), or if the development guidelines were missing or incomplete, post the matching change thread(s) now with "we-scrum create-change-thread".',
+                );
             }),
         );
 }

package/src/helpers/we-scrum.helper.ts

@@ -37,6 +37,8 @@ import { FirebaseHelper } from './firebase-helper';
 import { ProjectHelper } from './project-helper';
 import { renderTemplate } from './template.helper';
 
+const CHANGE_THREAD_STATUS_DISPLAY_ORDER = [ChangeThreadStatus.Open, ChangeThreadStatus.Resolved, ChangeThreadStatus.Archived];
+
 export class WeScrumHelper {
     private static readonly backendUrl = 'https://europe-west1-we-scrum-prod.cloudfunctions.net';
     constructor(private userId: string) {}
@@ -67,7 +69,7 @@ export class WeScrumHelper {
             });
         }
 
-        this.appendOpenThreadsHint(nextChange);
+        this.appendThreadsHint(nextChange);
 
         const analysisChange = StorySectionHelper.mapSingleChange(nextChange);
         const isTodo = nextChange.progress.status === ProgressStatus.ToDo;
@@ -230,26 +232,29 @@ export class WeScrumHelper {
         assert(!!story, `Story "${identificationNumber}" not found in the active project.`);
 
         const sections = await this.getStorySections(story.storyId);
-        this.getAllChanges(sections).forEach((change) => this.appendOpenThreadsHint(change));
+        this.getAllChanges(sections).forEach((change) => this.appendThreadsHint(change));
 
         const ast = StorySectionHelper.mapSectionsToAnalysisAst(sections);
 
         return AnalysisDsl.stringify(ast);
     }
 
-    public static async getOpenChangeThreads(changeId: string): Promise<string> {
+    public static async getChangeThreads(changeId: string): Promise<string> {
         const threads = await FirebaseHelper.getCollection<ProjectChangeThreadModel>(`/projects/${this.projectId}/change-threads`, {
-            where: [
-                ['changeId', '==', changeId],
-                ['status', '==', ChangeThreadStatus.Open],
-            ],
+            where: [['changeId', '==', changeId]],
         });
 
         if (threads.length === 0) {
-            return `No open threads for change "${changeId}".`;
+            return `No threads for change "${changeId}".`;
         }
 
-        return threads.map((thread) => this.formatChangeThread(thread)).join('\n\n---\n\n');
+        return _sortBy(
+            threads,
+            (thread) => CHANGE_THREAD_STATUS_DISPLAY_ORDER.indexOf(thread.status),
+            (thread) => thread.comments[0]?.createdAt,
+        )
+            .map((thread) => this.formatChangeThread(thread))
+            .join('\n\n---\n\n');
     }
 
     public static async createChangeThread(changeId: string, comment: string): Promise<string> {
@@ -302,12 +307,18 @@ export class WeScrumHelper {
         return change.taskId;
     }
 
-    private static appendOpenThreadsHint(change: DevelopmentPolicyHelper.Change): void {
-        const openThreadCount = change.threads.filter((t) => t.status === ChangeThreadStatus.Open).length;
-        if (openThreadCount === 0) return;
+    private static appendThreadsHint(change: DevelopmentPolicyHelper.Change): void {
+        const synthesis = CHANGE_THREAD_STATUS_DISPLAY_ORDER.map((status) => ({
+            status,
+            count: change.threads.filter((t) => t.status === status).length,
+        }))
+            .filter(({ count }) => count > 0)
+            .map(({ status, count }) => `${count} ${status}`)
+            .join(' • ');
+        if (!synthesis) return;
 
         const changeId = this.getChangeIdentifier(change);
-        const hint = `${openThreadCount} open ${openThreadCount === 1 ? 'thread' : 'threads'} on this change — run \`we-scrum get-change-threads --changeId "${changeId}"\` to view them.`;
+        const hint = `Threads: ${synthesis} — run \`we-scrum get-change-threads --changeId "${changeId}"\` to view them.`;
         change.description = change.description ? `${change.description}\n\n${hint}` : hint;
     }
 

package/templates/develop-story-skill.hbs

@@ -56,3 +56,5 @@ Before committing any task, run ESLint on every modified file and fix all report
 ```bash
 npx eslint <file1> <file2> ...
 ```
+
+Every task ends with a mandatory pre-completion check (deviation thread and development guidelines feedback thread, see the task's "Next steps"). Adjustments requested by the developer during or after a task count as deviations. If a thread is needed, post it before running `we-scrum complete-task`; if you realize afterwards that one was missed, post it right away.

package/templates/get-next-task.hbs

@@ -5,7 +5,7 @@
 {{{taskDetails}}}
 
 ## Development guidelines
-{{#if guidelinesPath}}Refer to `{{{guidelinesPath}}}` for coding conventions and project-specific instructions.{{else}}_No development guidelines file configured for this task._{{/if}}
+{{#if guidelinesPath}}Refer to `{{{guidelinesPath}}}` for coding conventions and project-specific instructions.{{else}}_No development guidelines file configured for this task._ **You must therefore open a development guidelines feedback thread before completing the task (see the pre-completion check below).**{{/if}}
 
 ## Unit tests
 {{#if unitTestsPath}}Unit tests are required. Refer to `{{{unitTestsPath}}}` for test writing guidelines.{{else}}No unit tests required.{{/if}}
@@ -14,23 +14,25 @@
 {{#if isTodo}}
 1. Run `we-scrum start-task --identificationNumber "{{identificationNumber}}" --changeId "{{changeId}}"` before making any changes.
 {{/if}}
-1. If the task above mentions open threads, run `we-scrum get-change-threads --changeId "{{changeId}}"` before implementing. If a thread requests an adjustment to this task, make it part of the implementation below, then resolve the thread once done:
+1. If the task above mentions threads, run `we-scrum get-change-threads --changeId "{{changeId}}"` before implementing. It returns **all** threads of the change (Open, Resolved, Archived) so you have the complete history. If an **open** thread requests an adjustment to this task, make it part of the implementation below, then resolve the thread once done:
    ```bash
    we-scrum add-comment-to-change-thread --changeThreadId <changeThreadId> --comment "<markdown explaining what was done>"
    we-scrum update-change-thread-status --changeThreadId <changeThreadId> --status Resolved
    ```
-   Leave a thread open (with a reply explaining why) if it does not call for a change to this task, or if you disagree with the request.
+   Leave a thread open (with a reply explaining why) if it does not call for a change to this task, or if you disagree with the request. Resolved and Archived threads are history only: do not act on them.
 1. Implement the task described above.
-1. If your implementation deviates in any way from what this task describes (different naming, different location, a sub-step skipped or altered, a workaround for a blocker, a mistake you had to correct mid-way, etc.), post a comment explaining the deviation and why, before completing the task:
-   ```bash
-   we-scrum create-change-thread --changeId "{{changeId}}" --comment "<markdown explaining the deviation>"
-   ```
-   Group related deviations into a single thread. If there are several unrelated deviations, a few separate threads is fine, but do not open one thread per minor deviation — use judgment to keep the count reasonable. Skip this step entirely if the task was implemented exactly as described.
-1. If the development guidelines or the unit tests guidelines referenced above were incomplete, outdated, or missing for this kind of task — meaning you had to spend extra effort figuring out conventions they should have covered — open a change thread with a concrete suggested addition or correction:
-   ```bash
-   we-scrum create-change-thread --changeId "{{changeId}}" --comment "<markdown: what was missing/outdated, and a suggested fix>"
-   ```
-   Use at most one thread for all development guidelines feedback, and, separately, at most one thread for all unit tests guidelines feedback — do not mix the two guidelines together, and do not mix guideline feedback into the deviation thread above. Skip whichever guideline was accurate and sufficient.
 1. Commit your changes.
+1. **Pre-completion check — mandatory, answer both questions explicitly before running `complete-task`.** Threads posted after completion are late, so do this now:
+   - **Deviations:** does the final result differ in any way from what this task describes (different naming, different location, a sub-step skipped or altered, a workaround for a blocker, a mistake you had to correct mid-way)? Changes made at the developer's request during the session (after feedback, redesigns, extra options or components added) count as deviations too. If yes, first run `we-scrum get-change-threads` and check the existing threads. If a thread already covers the deviation (whatever its status), reply to it with `we-scrum add-comment-to-change-thread` instead of creating a duplicate; otherwise post **one** thread explaining what differs and why:
+     ```bash
+     we-scrum create-change-thread --changeId "{{changeId}}" --comment "<markdown explaining the deviation>"
+     ```
+     Group related deviations into a single thread; use a few separate threads only for several unrelated deviations, and never one thread per minor deviation. Skip only if the task was implemented exactly as described.
+   - **Guidelines:** was the development guidelines section above "No development guidelines file configured", or were the development / unit tests guidelines incomplete, outdated, or missing for this kind of task (you had to spend extra effort figuring out conventions)? If yes, check the existing threads first (same rule: reply to an existing guidelines thread rather than creating a duplicate), otherwise open a thread with a concrete suggested addition or correction:
+     ```bash
+     we-scrum create-change-thread --changeId "{{changeId}}" --comment "<markdown: what was missing/outdated, and a suggested fix>"
+     ```
+     Use at most one thread for all development guidelines feedback and, separately, at most one for all unit tests guidelines feedback; do not mix them together, and do not mix guideline feedback into the deviation thread. Skip whichever guideline was accurate and sufficient.
+   - If the developer asks for adjustments **after** the task is completed, add them to the deviation thread (reply with `we-scrum add-comment-to-change-thread`, or open one if none exists).
 1. Run `we-scrum complete-task --identificationNumber "{{identificationNumber}}" --changeId "{{changeId}}"` when done.
 1. Call `get_next_task` to continue with the next task.

package/templates/review-analysis-skill.hbs

@@ -36,7 +36,7 @@ we-scrum get-story-analysis --identificationNumber <identificationNumber>
 
 ## Step 2 — Review existing threads
 
-The analysis DSL may annotate a change with a note such as _"N open thread(s) — run `we-scrum get-change-threads --changeId <id>` to view them."_ This means earlier review comments are already open on that change.
+The analysis DSL may annotate a change with a note such as _"Threads: 3 Open • 2 Resolved — run `we-scrum get-change-threads --changeId <id>` to view them."_ This means earlier review comments exist on that change (statuses with no thread are omitted).
 
 For every change annotated this way:
 
@@ -44,7 +44,9 @@ For every change annotated this way:
 we-scrum get-change-threads --changeId <changeId>
 ```
 
-For each thread returned:
+The command returns **all** threads of the change (Open, Resolved, Archived), so you have the complete history. Resolved and Archived threads are history only: read them to avoid repeating a concern that was already handled, but do not act on them.
+
+For each **open** thread returned:
 - If the current state of the analysis addresses the concern raised in the thread, resolve it and explain why:
   ```bash
   we-scrum add-comment-to-change-thread --changeThreadId <changeThreadId> --comment "<markdown explaining why this is resolved>"
@@ -92,6 +94,6 @@ we-scrum create-change-thread --changeId <changeId> --comment "<markdown-formatt
 
 - The comment body supports Markdown (headings, lists, bold, code spans) — it renders as such in the we-scrum UI.
 - Group every finding for a given change into a single thread/comment rather than opening one thread per bullet point.
-- Skip changes that already have an open thread covering the same concern (see Step 2) — reply on the existing thread instead of duplicating it.
+- Skip changes that already have a thread covering the same concern, whatever its status (see Step 2) — reply on the existing thread instead of duplicating it.
 
 Once threads are created or resolved, give the user a short summary in the chat: what was found, what was posted or resolved, and why — do not skip this summary just because the details live in we-scrum.