Package Exports

tln-pm
tln-pm/cli.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tln-pm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Project Management as Code

The utility aims to make the git repository the single source of truth for project planning, minimize the day-to-day routine and divide PM activities between team members. It will scan your repository for specific files and marked comment sections to get task hierarchy and other information. Typically .todo files are used to define PM artifacts, but tasks' description can be placed in any file in the repository.

DSL

Comments section can have three top level elements in Yaml format: team, timeline & tasks. Here is example for .todo file at repository root

/* TPM

team:
  "vlad.k":
    email: "vk@moonnoon.net"
  "artem.y":
    email: "ay@moonnoon.net"

timeline:
  "v24.9.0":
    date: "2024-09-30"
  "v24.10.0":
    date: "2024-10-31"

tasks: |
  [!:004:v24.9.0] Deploy UAT environment @vlad.k
  [>:003:v24.9.0] Configure SES @vlad.k
  [>:002:v24.9.0] Test payment processor: embedded & external checkout form @artem.y
  [+:001:v24.9.0] Restore CI/CD @vlad.k
    [+] Attach tln-cicd-git subtree
    [+] Configure envariment variables, tweak root .tln.conf

*/

Statuses & attributes

First symbol in square brackets describes status of the task

Symbol Meaning

todo

> in progress

+ done

- dropped

? to be discussed

! blocked
Optionally, after colon, task can have identifier (may be used to reference this task from other components)
Plus, optionally, deadline can be specified after second colon

Symbol	Meaning
	todo
>	in progress
+	done
-	dropped
?	to be discussed
!	blocked

Mentionings, Tags, Links

@alex.m - will bind Alex with specfic task
#backend - will add backend tag to the task
<docs/srs/multi-tenancy.md> - will create link with some other task, internal document or external resource

Command line options

General format

tpm [ls] [parameters] [optios]

Command (parameters & options)	Description
tpm ls	Display list of tasks for current git user
tpm ls tasks	The same as previous command
tpm ls team	Display team structure
tpm ls timeline	Display project timeline
tpm ls -g vlad.k	Display tasks assigned to specific user
tpm ls -a	Display all tasks