imdone-cli 0.1.7 → 0.2.1

package/README.md

@@ -3,7 +3,8 @@
 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.
 
-If you're looking for a more visual experience, check out the [Imdone Desktop App](https://imdone.io).
+## How it works
+![Imdone With Jira](./docs/images/imdone-with-jira.png)
 
 ## Installation
 

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

package/dist/index.cjs

@@ -78462,6 +78462,114 @@ function gitInstanceFactory(baseDir, options2) {
 init_git_response_error();
 var simpleGit = gitInstanceFactory;
 
+// node_modules/imdone-core/lib/adapters/logger.js
+var import_console = require("console");
+var LogLevel = {
+  ERROR: 0,
+  WARN: 1,
+  INFO: 2,
+  DEBUG: 3,
+  TRACE: 4,
+  NONE: -1
+  // Use this to disable all logging
+};
+function getCallerInfo() {
+  const err2 = new Error();
+  const stack = err2.stack?.split("\n");
+  if (!stack || stack.length < 5) return {};
+  const callerLine = stack[4] || stack[3];
+  const match2 = callerLine.match(/at (.+?) \((.+):(\d+):(\d+)\)/) || callerLine.match(/at (.+):(\d+):(\d+)/);
+  if (match2) {
+    if (match2.length === 5) {
+      return {
+        functionName: match2[1],
+        file: match2[2],
+        line: parseInt(match2[3], 10),
+        column: parseInt(match2[4], 10)
+      };
+    } else if (match2.length === 4) {
+      return {
+        functionName: "<anonymous>",
+        file: match2[1],
+        line: parseInt(match2[2], 10),
+        column: parseInt(match2[3], 10)
+      };
+    }
+  }
+  return {};
+}
+var Logger = class {
+  constructor() {
+    this.level = LogLevel.INFO;
+  }
+  // Setter for log level
+  setLevel(level) {
+    if (level in LogLevel) {
+      this.level = LogLevel[level];
+    } else if (typeof level === "number" && level >= -1 && level <= 4) {
+      this.level = level;
+    } else {
+      (0, import_console.warn)(`Invalid log level: ${level}. Using default INFO level.`);
+    }
+    return this;
+  }
+  // Check if the provided level should be logged
+  shouldLog(level) {
+    return level <= this.level;
+  }
+  formatMessage(args) {
+    const info3 = getCallerInfo();
+    const prefix = info3.file ? `[${info3.file}:${info3.line}] ${info3.functionName} - ` : "";
+    if (typeof args[0] === "string") {
+      args[0] = prefix + args[0];
+    } else {
+      args.unshift(prefix);
+    }
+    return args;
+  }
+  log(...args) {
+    if (this.shouldLog(LogLevel.INFO)) {
+      (0, import_console.info)(...this.formatMessage(args));
+    }
+  }
+  error(...args) {
+    if (this.shouldLog(LogLevel.ERROR)) {
+      (0, import_console.error)(...this.formatMessage(args));
+    }
+  }
+  warn(...args) {
+    if (this.shouldLog(LogLevel.WARN)) {
+      (0, import_console.warn)(...this.formatMessage(args));
+    }
+  }
+  info(...args) {
+    if (this.shouldLog(LogLevel.INFO)) {
+      (0, import_console.info)(...this.formatMessage(args));
+    }
+  }
+  debug(...args) {
+    if (this.shouldLog(LogLevel.DEBUG)) {
+      (0, import_console.info)(`[DEBUG]`, ...this.formatMessage(args));
+    }
+  }
+  trace(...args) {
+    if (this.shouldLog(LogLevel.TRACE)) {
+      (0, import_console.info)(`[TRACE]`, ...this.formatMessage(args));
+    }
+  }
+  time(label) {
+    if (this.shouldLog(LogLevel.DEBUG)) {
+      console.time(label);
+    }
+  }
+  timeEnd(label) {
+    if (this.shouldLog(LogLevel.DEBUG)) {
+      console.timeEnd(label);
+    }
+  }
+};
+var logger = new Logger();
+
 // node_modules/imdone-core/lib/constants.js
 var import_path = __toESM(require("path"), 1);
 
@@ -78753,116 +78861,6 @@ __export(file_gateway_exports, {
 var import_path2 = __toESM(require("path"), 1);
 var import_fs = __toESM(require("fs"), 1);
 var import_sanitize_filename = __toESM(require_sanitize_filename(), 1);
-
-// node_modules/imdone-core/lib/adapters/logger.js
-var import_console = require("console");
-var LogLevel = {
-  ERROR: 0,
-  WARN: 1,
-  INFO: 2,
-  DEBUG: 3,
-  TRACE: 4,
-  NONE: -1
-  // Use this to disable all logging
-};
-function getCallerInfo() {
-  const err2 = new Error();
-  const stack = err2.stack?.split("\n");
-  if (!stack || stack.length < 5) return {};
-  const callerLine = stack[4] || stack[3];
-  const match2 = callerLine.match(/at (.+?) \((.+):(\d+):(\d+)\)/) || callerLine.match(/at (.+):(\d+):(\d+)/);
-  if (match2) {
-    if (match2.length === 5) {
-      return {
-        functionName: match2[1],
-        file: match2[2],
-        line: parseInt(match2[3], 10),
-        column: parseInt(match2[4], 10)
-      };
-    } else if (match2.length === 4) {
-      return {
-        functionName: "<anonymous>",
-        file: match2[1],
-        line: parseInt(match2[2], 10),
-        column: parseInt(match2[3], 10)
-      };
-    }
-  }
-  return {};
-}
-var Logger = class {
-  constructor() {
-    this.level = LogLevel.INFO;
-  }
-  // Setter for log level
-  setLevel(level) {
-    if (level in LogLevel) {
-      this.level = LogLevel[level];
-    } else if (typeof level === "number" && level >= -1 && level <= 4) {
-      this.level = level;
-    } else {
-      (0, import_console.warn)(`Invalid log level: ${level}. Using default INFO level.`);
-    }
-    return this;
-  }
-  // Check if the provided level should be logged
-  shouldLog(level) {
-    return level <= this.level;
-  }
-  formatMessage(args) {
-    const info3 = getCallerInfo();
-    const prefix = info3.file ? `[${info3.file}:${info3.line}] ${info3.functionName} - ` : "";
-    if (typeof args[0] === "string") {
-      args[0] = prefix + args[0];
-    } else {
-      args.unshift(prefix);
-    }
-    return args;
-  }
-  log(...args) {
-    if (this.shouldLog(LogLevel.INFO)) {
-      (0, import_console.info)(...this.formatMessage(args));
-    }
-  }
-  error(...args) {
-    if (this.shouldLog(LogLevel.ERROR)) {
-      (0, import_console.error)(...this.formatMessage(args));
-    }
-  }
-  warn(...args) {
-    if (this.shouldLog(LogLevel.WARN)) {
-      (0, import_console.warn)(...this.formatMessage(args));
-    }
-  }
-  info(...args) {
-    if (this.shouldLog(LogLevel.INFO)) {
-      (0, import_console.info)(...this.formatMessage(args));
-    }
-  }
-  debug(...args) {
-    if (this.shouldLog(LogLevel.DEBUG)) {
-      (0, import_console.info)(`[DEBUG]`, ...this.formatMessage(args));
-    }
-  }
-  trace(...args) {
-    if (this.shouldLog(LogLevel.TRACE)) {
-      (0, import_console.info)(`[TRACE]`, ...this.formatMessage(args));
-    }
-  }
-  time(label) {
-    if (this.shouldLog(LogLevel.DEBUG)) {
-      console.time(label);
-    }
-  }
-  timeEnd(label) {
-    if (this.shouldLog(LogLevel.DEBUG)) {
-      console.timeEnd(label);
-    }
-  }
-};
-var logger = new Logger();
-
-// node_modules/imdone-core/lib/adapters/file-gateway.js
 var fs = import_fs.default;
 async function exists2(path13) {
   try {
@@ -79068,7 +79066,9 @@ async function expectNoChanges(projectPath, message) {
 }
 async function addAndCommitChanges(projectPath, message, add2 = ["."]) {
   const git = gitRepo(projectPath);
+  logger.debug("addAndCommitChanges before status: ", { message, add: add2 });
   const files = await status();
+  logger.debug("addAndCommitChanges after status: ", { message, files });
   if (files.length === 0) {
     return;
   }
@@ -79076,8 +79076,12 @@ async function addAndCommitChanges(projectPath, message, add2 = ["."]) {
   if (toAdd.length === 0) {
     return;
   }
-  await git.add(toAdd);
-  await git.commit(message);
+  logger.debug("addAndCommitChanges before add : ", { message, toAdd });
+  const addResponse = await git.add(toAdd);
+  logger.debug("addAndCommitChanges after add: ", { message, toAdd, addResponse });
+  logger.debug("addAndCommitChanges before commit: ", { message });
+  const commitResponse = await git.commit(message);
+  logger.debug("addAndCommitChanges after commit: ", { message, commitResponse });
 }
 async function stashChanges(projectPath) {
   const git = gitRepo(projectPath);
@@ -99296,7 +99300,7 @@ async function getJiraAdapter({ _fetch = fetch3, projectKeys, issueType, jiraUrl
   async function getIssueTypes() {
     const project2 = await getProject2();
     logger2.debug("PROJECT:", project2);
-    return project2.issueTypes.map((type) => type.name);
+    return project2.issueTypes?.map((type) => type.name);
   }
   function getTaskUrl(key2) {
     return `${jiraUrl}/browse/${key2}`;
@@ -99803,7 +99807,7 @@ var JiraPlugin = class extends import_imdone_api8.default {
     return this.getSettings().jql;
   }
   get projectKeys() {
-    return this.getSettings().projectKeys.map((p) => p.key);
+    return this.getSettings().projectKeys?.map((p) => p.key);
   }
   get issueType() {
     return this.getSettings().issueType;
@@ -99853,6 +99857,9 @@ ${task.interpretedContent}`;
       plugin: "JiraPlugin"
     };
   }
+  get defaultIssueType() {
+    return this.issueTypes && this.issueTypes.length > 0 && this.issueTypes[0];
+  }
   getBoardActions() {
     const project2 = this.project;
     const jiraAdapter = this.jiraAdapter;
@@ -99992,7 +99999,7 @@ ${e2.stack}`, "Error updating project from Jira. Copied to clipboard.");
       new import_settings.ArrayProperty().setTitle("Metadata Mappings").itemTitle("Metadata Mapping").addItemProperty("jira", new import_settings.StringProperty().setTitle("Jira Field")).addItemProperty("imdone", new import_settings.StringProperty().setTitle("Imdone Metadata"))
     ).addProperty(
       "issueType",
-      new import_settings.StringProperty().setTitle("Default Issue Type").allowedValues(this.issueTypes).setDefault(this.issueTypes[0])
+      new import_settings.StringProperty().setTitle("Default Issue Type").allowedValues(this.issueTypes).setDefault(this.defaultIssueType)
     );
     return this.settingSchema;
   }
@@ -102760,7 +102767,7 @@ async function imdoneInit(projectPath, { name: name2, jiraUrl, jiraProjectKey, j
 // package.json
 var package_default = {
   name: "imdone-cli",
-  version: "0.1.7",
+  version: "0.2.1",
   author: "Jesse Piascik",
   description: "An imdone cli that automates your jira updates with markdown files.",
   license: "Proprietary",
@@ -102773,6 +102780,12 @@ var package_default = {
     imdone: "dist/index.min.cjs",
     "imdone-debug": "dist/index.cjs"
   },
+  files: [
+    "dist",
+    "docs",
+    "LICENSE",
+    "README.md"
+  ],
   scripts: {
     prepublishOnly: "npm --prefix ../ install && npm --prefix ../ run build && npm i && npm test && npm run build",
     link: "npm link ../../imdone-core-2 ../../imdone-api",