@beauraines/sprint-tracker 0.6.6 → 0.6.7

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.6.7](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.6...v0.6.7) (2023-12-13)
+
+
+### Features
+
+* adds readme command ([#48](https://bitbucket.org/beauraines/sprint-tracker/issues/48)) ([7992851](https://bitbucket.org/beauraines/sprint-tracker/commit/7992851afc6aa446aa1d04b7366fb1b264eca0e8))
+
 ### [0.6.6](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.5...v0.6.6) (2023-12-13)
 
 

package/README.md

@@ -81,14 +81,6 @@ A configuration file `~/sprintTracker.json` is required  with the full path to y
 }
 ```
 
-## Installation and Setup for Development
-
-1. Clone the repository
-2. Ensure you have sqlite3 and docker installed. See [Dependencies](#dependencies).
-3. Install npm dependencies `npm i`
-4. Globally install the sprint tracker `npm -g i`
-5. Follow the [General Usage](#general-usage) instructions.
-
 ## Tracking Outcomes
 
 ### Project
@@ -113,59 +105,21 @@ Non-working days and PTO will be recorded to be able to normalize Sprints with d
 1. Carryover - External: Work that was carried over due to blockers external to the scrum team. Use of this is optional, as an agile team should be fully self-sufficient.
 
 
-### ERD
+## Installation and Setup for Development
 
-```mermaid
-erDiagram
-    PROJECTS {
-        int id 
-        string name
-        string pm_name
-        string pm_email
-        string client
-        string project_number
-        date start_date
-        date end_date
-
-    }
-    SPRINTS {
-        int id
-        int project_id
-        string sprint_name
-        date start_date
-        date end_date
-        number committed_points
-        number committed_stories
-        number non_working_days
-        number developers
-        number developer_pto_days
-    }
-
-    SPRINT_OUTCOMES {
-        int id 
-        int sprint_id
-        int outcome_id
-        int issue_count
-        int story_points
-        text notes    
-    }
-
-    OUTCOMES {
-        int  id
-        string  name
-        text    description
-    }
-
-    PROJECTS ||--o{ SPRINTS : ""
-    SPRINTS ||--|{ SPRINT_OUTCOMES : ""
-    OUTCOMES ||--o{ SPRINT_OUTCOMES: ""
-```
+1. Clone the repository
+2. Ensure you have sqlite3 and docker installed. See [Dependencies](#dependencies).
+3. Install npm dependencies `npm i`
+4. Globally install the sprint tracker `npm -g i`
+5. Follow the [General Usage](#general-usage) instructions.
 
+### ERD
 
+See the standalone [ERD document](./erd.md)
 
-## Generating Visualizations with R and Docker
+### Generating Visualizations with R and Docker
 
-There are several R scripts included in the project repository, more than just the sprint outcomes. They can be run from the command line using docker and the `rocker/tidyverse` image as shown below.
+If you choose to not have a local R install, you can use R in a docker container, manually. There are several R scripts included in the project repository, more than just the sprint outcomes. They can be run from the command line using docker and the `rocker/tidyverse` image as shown below.
 
 ```bash
 # PROJECT_DIR must have trailing slash
@@ -174,7 +128,7 @@ IMAGE=rocker/tidyverse
 docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rscript /home/rstudio/projects/sprint-tracker/R/sprintOutcomes.R' rstudio
 ```
 
-## Roadmap
+### Roadmap
 
 1. ~~Build local database using sqlite3~~
 2. ~~Script visualizations, possibly with R, graph-cli, chartsjs, PowerBI, or AWS QuickSight~~

package/cmds/readme.js

@@ -0,0 +1,21 @@
+const { helpers } = require('helpers')
+const cliMd = (...args) => import('cli-markdown').then(({default:cliMd}) => cliMd(...args));
+
+
+const command = 'readme'
+const desc = "Displays the project's REAMDE"
+const builder = {}
+
+const handler = async function () {
+
+    const readme = await helpers.readFile(`${__dirname}/../README.md`)
+    // ! Break out ERD to standalone document
+    console.log(await cliMd(readme))
+}
+
+module.exports = {
+    command,
+    desc,
+    builder,
+    handler
+}

package/erd.md

@@ -0,0 +1,47 @@
+# ERD
+
+```mermaid
+erDiagram
+    PROJECTS {
+        int id 
+        string name
+        string pm_name
+        string pm_email
+        string client
+        string project_number
+        date start_date
+        date end_date
+
+    }
+    SPRINTS {
+        int id
+        int project_id
+        string sprint_name
+        date start_date
+        date end_date
+        number committed_points
+        number committed_stories
+        number non_working_days
+        number developers
+        number developer_pto_days
+    }
+
+    SPRINT_OUTCOMES {
+        int id 
+        int sprint_id
+        int outcome_id
+        int issue_count
+        int story_points
+        text notes    
+    }
+
+    OUTCOMES {
+        int  id
+        string  name
+        text    description
+    }
+
+    PROJECTS ||--o{ SPRINTS : ""
+    SPRINTS ||--|{ SPRINT_OUTCOMES : ""
+    OUTCOMES ||--o{ SPRINT_OUTCOMES: ""
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/sprint-tracker",
-  "version": "0.6.6",
+  "version": "0.6.7",
   "description": "Database and R visualizations to track sprint performance",
   "main": "cli.js",
   "bin": {
@@ -37,6 +37,7 @@
   },
   "dependencies": {
     "@json2csv/node": "^7.0.1",
+    "cli-markdown": "^3.1.0",
     "cli-table3": "^0.6.3",
     "helpers": "npm:@beauraines/node-helpers@^2.4.0",
     "node-db-migration": "^1.4.0",