imdone-cli 0.1.6 → 0.2.0

package/.env

@@ -4,3 +4,5 @@
 # JIRA_AUTH_BASIC=true # Set to false to use Bearer token auth.
 # JIRA_USERNAME="<your jira username>" # e.g. your email address. Not needed if using Bearer token auth.
 # JIRA_TOKEN="<your personal access token>"
+
+IMDONE_LICENSE="eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiSmVzc2UgUGlhc2NpayIsImVtYWlsIjoiamVzc2VAaW1kb25lLmlvIiwib3JnIjoiSW5ub2J1aWx0IFNvZnR3YXJlLCBMTEMiLCJwbGFuIjoicHJlbWl1bSIsImlhdCI6MTc0NDczNjA1MSwiZXhwIjoxNzQ3MzI4MDUxfQ.QRQ6_qvKAS3oTCVJLYRRzpjThxLI-_Gw7SqeJUYZBE41jPQHDwR0wfGdXsltZ5MUqu0CVizfORt4FStyHBjJAOenQ7TSg32u_F__qADDv32fh-Ja4x1pK7EdUTulDUHq5qskwhrTIBXgGEkD6Gn8YUYD26-CZY-Hp4-kw9edraDJkwANxHhEYdSLtUCgoW9U-ZPBZHvEFQ761ykWl0nqTj75DeoiVIInfNGtQWI8Z29VgXMUavCNoIxJQONPHA_370wgJVdbcnpRKnwJ1HAISLRUSHyXwTNnokOxbN9BKMgvHqLVXqwa_gwu7obpVFp0wjie9i2bE4h5mkAvOEY09A"

package/.imdone/actions/board.js

@@ -0,0 +1,18 @@
+const path = require('path')
+
+// This module must export a function that returns an array of BoardActions
+// https://imdone.github.io/imdone-api/classes/plugin.Plugin.html#getboardactions
+module.exports = function () {
+  const project = this.project
+  return [
+    {
+      title: "Open in vscode", // This is what displays in the main menu
+      keys: ['alt+o'], // This is the keyboard shortcut
+      icon: "code", // This is the font awesome icon that displays in the main menu
+      action (task) {
+        const url = `vscode://file/${path.join(project.path, task.path)}:${task.line}`
+        project.openUrl(url) 
+      }
+    }
+  ]
+}

package/.imdone/actions/card.js

@@ -0,0 +1,6 @@
+// This module must export a function that returns an array of CardActions
+// https://imdone.github.io/imdone-api/classes/plugin.Plugin.html#getcardactions
+module.exports = function (task) {
+  const project = this.project
+  return []
+}

package/.imdone/config.yml

@@ -0,0 +1,80 @@
+keepEmptyPriority: false
+code:
+  include_lists:
+    - TODO
+    - DOING
+    - DONE
+    - PLANNING
+    - FIXME
+    - ARCHIVE
+    - HACK
+    - CHANGED
+    - XXX
+    - IDEA
+    - NOTE
+    - REVIEW
+lists:
+  - name: NOTE
+    hidden: false
+    id: jea6vnwm9pxtjls
+  - name: Past Due Reminders
+    hidden: true
+    ignore: false
+    filter: 'remind = /./ and remind < "${now}" and list != DONE -remind'
+    id: jea6vnwm9pxtjlt
+  - name: What's Due?
+    hidden: true
+    ignore: false
+    filter: 'dueDate < "${in 15 days}" AND list != DONE +dueDate +order'
+    id: jea6vnwm9pxtjlu
+  - name: TODO
+    hidden: false
+    id: jea6vnwm9pxtjlv
+  - name: DOING
+    hidden: false
+    id: jea6vnwm9pxtjlw
+  - name: DONE
+    hidden: false
+    ignore: true
+    id: jea6vnwm9pxtjlx
+  - name: Recently Completed
+    filter: 'completedDate > "${14 days ago}" -completed'
+    hidden: false
+    id: jea6vnwm9pxtjly
+settings:
+  '0': object Object
+  openIn: code
+  openCodeIn: default
+  journalType: New File
+  journalPath: backlog
+  appendNewCardsTo: imdone-tasks.md
+  newCardSyntax: HASHTAG
+  replaceSpacesWith: '-'
+  plugins: {}
+  journalTemplate: null
+  markdownOnly: false
+  kudosProbability: 0.5
+  name: cli-package
+  views: []
+  cards:
+    colors: []
+    template: '${template_simple}'
+    trackChanges: false
+    metaNewLine: true
+    addCompletedMeta: true
+    addCheckBoxTasks: false
+    doingList: DOING
+    doneList: DONE
+    tokenPrefix: '#'
+    taskPrefix: '##'
+    tagPrefix: '#'
+    metaSep: ':'
+    orderMeta: true
+    maxLines: 2
+    addNewCardsToTop: true
+    showTagsAndMeta: false
+    addStartedMeta: true
+    defaultList: TODO
+    computed: !<tag:yaml.org,2002:js/undefined> ''
+    archiveCompleted: true
+    archiveFolder: backlog/archive

package/.imdone/properties/board.js

@@ -0,0 +1,116 @@
+const icons = {
+  filter: `<span class="icon is-small fa-xs"><svg aria-hidden="true" focusable="false" data-prefix="fa" data-icon="search" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" class="svg-inline--fa fa-search fa-w-16"><path fill="currentColor" d="M505 442.7L405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9 0 208 0S0 93.1 0 208s93.1 208 208 208c48.3 0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9 0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7 0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7 0 128 57.2 128 128 0 70.7-57.2 128-128 128z" class=""></path></svg></span><span data-v-fd981bec="" class="icon is-small fa-xs"><svg aria-hidden="true" focusable="false" data-prefix="fa" data-icon="chevron-down" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512" class="svg-inline--fa fa-chevron-down fa-w-14"><path fill="currentColor" d="M207.029 381.476L12.686 187.132c-9.373-9.373-9.373-24.569 0-33.941l22.667-22.667c9.357-9.357 24.522-9.375 33.901-.04L224 284.505l154.745-154.021c9.379-9.335 24.544-9.317 33.901.04l22.667 22.667c9.373 9.373 9.373 24.569 0 33.941L240.971 381.476c-9.373 9.372-24.569 9.372-33.942 0z" class=""></path></svg></span>`
+  ,openFile: `<span class="icon is-medium"><svg version="1.1" width="16" height="16" viewBox="0 0 16 16" aria-hidden="true" class="octicon octicon-link"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></span>`
+  ,kebab: `<span class="icon is-medium"><svg version="1.1" width="3" height="16" viewBox="0 0 3 16" aria-hidden="true" class="octicon octicon-kebab-vertical"><path data-v-5bf4cb66="" fill-rule="evenodd" d="M0 2.5a1.5 1.5 0 1 0 3 0 1.5 1.5 0 0 0-3 0zm0 5a1.5 1.5 0 1 0 3 0 1.5 1.5 0 0 0-3 0zM1.5 14a1.5 1.5 0 1 1 0-3 1.5 1.5 0 0 1 0 3z"></path></svg></span>`
+  ,clone: `<span class="icon copy-button is-medium" style=""><svg aria-hidden="true" focusable="false" data-prefix="fa" data-icon="clone" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" class="svg-inline--fa fa-clone fa-w-16 fa-lg"><path fill="currentColor" d="M464 0c26.51 0 48 21.49 48 48v288c0 26.51-21.49 48-48 48H176c-26.51 0-48-21.49-48-48V48c0-26.51 21.49-48 48-48h288M176 416c-44.112 0-80-35.888-80-80V128H48c-26.51 0-48 21.49-48 48v288c0 26.51 21.49 48 48 48h288c26.51 0 48-21.49 48-48v-48H176z" class=""></path></svg></span>`
+  ,editCard: `<span class="icon is-medium"><svg version="1.1" width="14" height="16" viewBox="0 0 14 16" aria-hidden="true" class="octicon octicon-pencil"><path fill-rule="evenodd" d="M0 12v3h3l8-8-3-3-8 8zm3 2H1v-2h1v1h1v1zm10.3-9.3L12 6 9 3l1.3-1.3a.996.996 0 0 1 1.41 0l1.59 1.59c.39.39.39 1.02 0 1.41z"></path></svg></span>`
+}
+
+const EMOJI = {
+  BAD: ':rotating_light:',
+  GREAT: ':rocket:',
+  SLEEP: ':sleeping:',
+  GOOD: ':2nd_place_medal:',
+  CHART: '<span style="font-size: 1.5em;">:chart:</span>'
+}
+
+// This module must export a function that returns an object with properties that will be used to render the card
+// https://imdone.github.io/imdone-api/classes/plugin.Plugin.html#getboardproperties
+module.exports = function () {
+  const project = this.project
+
+  const emoji = {
+    due: dueEmoji(project.totals),
+    recent: recentEmoji(project.totals),
+    wip: wipEmoji(project.totals),
+    chart: EMOJI.CHART
+  }
+
+  // These are the properties that are available to use in your cards
+  // Use ${property_name} to permanently insert the value of the property
+  // Use {{property_name}} to insert the value of the property at runtime
+  return {
+    cardTotal: cardTotal(project.totals), 
+    allTopics: project.allTopics, // This is an array of all the topics in the project
+    topicTable: getTopicTable(project), // This is a markdown table with the count of tasks for each topic/list intersection
+    emoji,
+    icons
+  }
+}
+
+function cardTotal(totals) {
+  let count = 0
+  Object.keys(totals).forEach((list) => {
+    count += totals[list]
+  })
+  return count
+}
+
+function formatEmoji(emoji) {
+  return `<span style="font-size: 1.5em;">${emoji}</span>`
+}
+
+function dueEmoji(totals) {
+  const due = totals["What's Due?"]
+  let emoji = EMOJI.GOOD
+  if (due >= 3) {
+    emoji = EMOJI.BAD
+  } else if (due === 0) {
+    emoji = EMOJI.GREAT
+  }
+  return formatEmoji(emoji)
+}
+
+function recentEmoji(totals) {
+  const recentlyCompleted = totals['Recently Completed']
+  let emoji = EMOJI.GOOD
+  if (recentlyCompleted >= 3) {
+    emoji = EMOJI.GREAT
+  } else if (recentlyCompleted === 0) {
+    emoji = EMOJI.BAD
+  }
+  return formatEmoji(emoji)
+}
+
+function wipEmoji(totals) {
+  const doing = totals['DOING']
+  let emoji = EMOJI.GOOD
+  if (doing >= 3) {
+    emoji = EMOJI.BAD
+  } else if (doing === 0) {
+    emoji = EMOJI.SLEEP
+  } else if (doing === 1) {
+    emoji = EMOJI.GREAT
+  }
+  return formatEmoji(emoji)
+}
+
+function getTopicTable(project) {
+  const lists = project.allLists.filter(list => !list.filter)
+  const topicTable = project.allTopics.map((topic) => {
+    return {
+      name: topic,
+      lists: [
+        ...lists.map((list) => {
+          return {
+            name: list.name,
+            count: list.tasks.filter((task) => task.topics.includes(topic)).length
+          }
+        })
+      ]
+    }
+  });
+  
+  //convert topic table into a markdown table with topic name on the left and list names on the top and the count for each topic/list intersection
+  const table = `
+| Topic | ${lists.map((list) => list.name).join(' | ')} |
+| --- | ${lists.map(() => ' --- ').join(' | ')} |
+${topicTable.map((topic) => {
+  const topicLink = `imdone://${project.path}?filter=topics="${encodeURIComponent(topic.name)}"`;
+  return `| [[${topic.name}]] | ${topic.lists.map((list) => `[${list.count}](${topicLink})`).join(' | ')} |`;
+}).join('\n')}
+`;
+
+  console.log(table);
+  return table
+}

package/.imdone/properties/card.js

@@ -0,0 +1,12 @@
+// This module must export a function that returns an object with properties that will be available in your cards
+// https://imdone.github.io/imdone-api/classes/plugin.Plugin.html#getcardproperties
+module.exports = function ({ line, source }) {
+  // const project = this.project
+
+  // These are the properties that are available to use in your cards
+  // Use ${property_name} to permanently insert the value of the property
+  // Use {{property_name}} to insert the value of the property at runtime
+  return {
+    sourceLink: `[${source.path}:${line}](./${source.path}:${line})`,
+  }
+}

package/.imdone/tags.yml

@@ -0,0 +1,8 @@
+tags:
+  - 0.2.0
+  - devex
+  - feature
+  - premium
+  - release-0.1.1
+  - test
+  - urgent

package/.imdone/templates/user_story.md

@@ -0,0 +1,21 @@
+
+## Description
+
+[Description goes here]
+
+## Acceptance Criteria
+
+1. [Acceptance criteria goes here]
+
+## Tasks
+
+- [ ] Task 1
+- [ ] Task 2
+- [ ] Task 3
+
+<!-- 
+created:${timestamp}
+due in 2 weeks.
+remind in 1 day. 
+#user-story
+-->

package/.imdoneignore

@@ -0,0 +1,3 @@
+.obsidian
+.trash
+.imdone/plugins

package/README.md

@@ -1,7 +1,10 @@
 # Imdone CLI
 
-Imdone CLI is a command-line tool that integrates with Jira to manage your tasks and issues directly from markdown files and your terminal. It allows you to pull issues from Jira, update them, and push changes back to Jira seamlessly.
-This tool is designed to enhance your productivity by providing a simple and efficient way to manage your tasks without leaving your editor or terminal.
+Imdone CLI is a command-line tool that integrates with Jira to manage your tasks and issues directly from markdown files and your terminal. It allows you to pull issues from Jira, edit them as markdown files, and push changes back to Jira.
+This tool is designed to serve as a bridge between your local development environment and Jira, making it easier and more efficient to manage tasks without switching contexts.
+
+## How it works
+![Imdone With Jira](docs/images/imdone-with-jira.png)
 
 ## Installation
 
@@ -15,6 +18,26 @@ npm install -g imdone-cli
 - A valid Imdone license
 - Jira account with API access
 
+## Getting Started
+
+### Purchase a license
+
+To use Imdone CLI, you need a valid license. You can purchase a license from the [Imdone website](https://imdone.io/imdone-with-jira).
+
+### Install Imdone CLI
+
+Use the command above to install the CLI globally.
+
+### Set up your project
+
+Navigate to your project directory, create a backlog directory, cd to it and run `imdone init` to set up the integration with Jira.
+
+```bash
+mkdir backlog
+cd backlog
+imdone init
+```
+
 ## Commands
 
 ### Initialize Jira Integration
@@ -82,25 +105,6 @@ imdone license --token eyJhbGciOiJSUzI...
 imdone license --show
 ```
 
-## Project Structure
-
-When initializing a project, Imdone CLI will:
-
-1. Check if you're in a git repository
-2. Create or update the .env file for storing credentials
-3. Add necessary entries to .gitignore
-4. Set up the Imdone project configuration
-
-## Environment Variables
-
-The following environment variables are used by Imdone CLI:
-
-- `JIRA_USERNAME`: Your Jira username/email
-- `JIRA_TOKEN`: Your Jira API token
-- `IMDONE_LICENSE`: Your Imdone license token
-
-These are typically stored in a `.env` file in your project root.
-
 ## Troubleshooting
 
 ### Invalid License
@@ -126,6 +130,6 @@ If you're having trouble connecting to Jira, verify:
 
 ## Support
 
-If you encounter any issues or need assistance, please contact support@imdone.io
+If you encounter any issues or need assistance, please visit [imdone.io](https://imdone.io) or contact support@imdone.io
 
 

package/dist/.env

@@ -4,3 +4,4 @@
 # JIRA_AUTH_BASIC=true # Set to false to use Bearer token auth.
 # JIRA_USERNAME="<your jira username>" # e.g. your email address. Not needed if using Bearer token auth.
 # JIRA_TOKEN="<your personal access token>"
+# IMDONE_LICENSE="<your imdone license>"

package/dist/README.md

@@ -0,0 +1,61 @@
+# imdone-jira Backlog
+
+## Getting started
+
+### Clone this repo into your project's backlog directory
+
+From your project root:
+
+```bash
+git clone <repository-url> backlog
+cd backlog
+```
+
+### Create your own tracking branch
+
+Create a branch for your work. This should stay local. (e.g. `your-name-work`)
+
+```bash
+git checkout -b <your-branch-name>
+```
+
+### Install imdone-cli
+
+```bash
+npm install -g imdone-cli
+```
+
+### Set up your environment
+
+Copy the environment template file:
+
+```bash
+cp .env.temp .env
+```
+
+### Add your Jira credentials to your `.env` file
+
+**JIRA_USERNAME** is the email on your Jira profile
+
+**JIRA_TOKEN** Create a Jira personal access token in your Jira account settings
+
+### Working with Jira and imdone
+
+Run `imdone pull` from the backlog folder to get the latest content from Jira stories in the current sprint
+
+Now you can see the current sprint stories in the `backlog/current-sprint` folder
+
+Workflow for making changes to backlog items:
+
+1. Run `imdone pull` to get the latest changes from Jira
+2. Make your story updates in the local files
+3. Run `imdone push` to push your changes to Jira
+
+**What happens during push/pull:**
+
+1. Your local changes are stashed
+2. Latest changes are pulled from Jira
+3. Changes are committed to your local branch
+4. Your stashed changes are applied on top of the latest changes
+5. Your updates are pushed to Jira
+6. All changes are committed to your local branch