jira-ai 0.2.11 → 0.3.1

package/README.md

@@ -8,7 +8,9 @@ A TypeScript-based command-line interface for interacting with Atlassian Jira. B
 - List all projects
 - View task details with comments
 - Show available statuses for a project
+- Create new Jira issues (tasks, epics, subtasks, etc.)
 - Update issue descriptions from Markdown files
+- Add comments to issues from Markdown files
 - Execute JQL queries with formatted results
 - Beautiful table formatting with cli-table3
 - Colored output for better readability
@@ -210,6 +212,45 @@ JQL Query Results (5 issues found)
 └────────────┴──────────────────────────┴─────────────┴────────────┴──────────┘
 ```
 
+### Create New Issue
+
+Create a new Jira issue in any project.
+
+```bash
+jira-ai create-task --title <title> --project <project-key> --issue-type <type> [--parent <parent-key>]
+```
+
+**Example:**
+```bash
+jira-ai create-task --title "Configure production server" --project BP --issue-type Task
+```
+
+**For subtasks:**
+```bash
+jira-ai create-task --title "Update documentation" --project BP --issue-type Subtask --parent BP-1234
+```
+
+**Options:**
+- `--title` - Issue title/summary (required)
+- `--project` - Project key (required, e.g., "BP", "PROJ")
+- `--issue-type` - Issue type name (required, e.g., "Task", "Epic", "Subtask", "Bug", "Story")
+- `--parent` - Parent issue key (optional, required for subtasks)
+
+**Output:**
+```
+✔ Issue created successfully: BP-1235
+
+Title: Configure production server
+Project: BP
+Issue Type: Task
+
+Issue Key: BP-1235
+```
+
+**Tips:**
+- Use `jira-ai list-issue-types <project-key>` to see available issue types for a project
+- Use `jira-ai projects` to see available projects
+
 ### Update Issue Description
 
 Update a Jira issue's description from a Markdown file. The Markdown content is automatically converted to Atlassian Document Format (ADF).
@@ -246,6 +287,54 @@ File: /path/to/description.md
 
 **Note:** This command replaces the entire issue description with the content from the file.
 
+### Add Comment to Issue
+
+Add a comment to a Jira issue from a Markdown file. The Markdown content is automatically converted to Atlassian Document Format (ADF).
+
+```bash
+jira-ai add-comment --issue-key <issue-key> --file-path <path-to-markdown-file>
+```
+
+**Example:**
+```bash
+jira-ai add-comment --issue-key BP-1234 --file-path ./comment.md
+```
+
+**Output:**
+```
+✔ Comment added successfully to BP-1234
+
+File: /path/to/comment.md
+```
+
+### List Issue Types
+
+Display all available issue types for a project.
+
+```bash
+jira-ai list-issue-types <project-key>
+```
+
+**Example:**
+```bash
+jira-ai list-issue-types BP
+```
+
+**Output:**
+```
+Issue Types for Project BP (5 total)
+
+┌─────────────┬──────────────────────────┬──────────┬────────────────┐
+│ Name        │ Description              │ Subtask  │ Hierarchy      │
+├─────────────┼──────────────────────────┼──────────┼────────────────┤
+│ Epic        │ A big user story         │ No       │ Level 1        │
+├─────────────┼──────────────────────────┼──────────┼────────────────┤
+│ Task        │ A task                   │ No       │ Level 0        │
+├─────────────┼──────────────────────────┼──────────┼────────────────┤
+│ Subtask     │ A subtask                │ Yes      │ Level -1       │
+└─────────────┴──────────────────────────┴──────────┴────────────────┘
+```
+
 ## Settings
 
 The CLI uses a `settings.yaml` file to control which commands and projects are allowed. This provides an additional security layer.
@@ -262,11 +351,14 @@ commands:
   - projects
   - run-jql
   - task-with-details
-  # - update-description  # Uncomment to enable description updates
+  - list-issue-types
+  # - create-task        # Uncomment to enable creating issues
+  # - add-comment        # Uncomment to enable adding comments
+  # - update-description # Uncomment to enable description updates
   # - project-statuses
 ```
 
-**Important:** The `update-description` command is commented out by default since it's a WRITE operation. Uncomment it only if you need to update issue descriptions.
+**Important:** Write operations (`create-task`, `add-comment`, `update-description`) are commented out by default for safety. Uncomment them in `settings.yaml` only if you need these features.
 
 ## Development
 
@@ -285,6 +377,10 @@ jira-service/
 │   ├── cli.ts                       # Main entry point
 │   ├── commands/                    # Command implementations
 │   │   ├── about.ts
+│   │   ├── add-comment.ts           # Add comments to issues
+│   │   ├── auth.ts
+│   │   ├── create-task.ts           # Create new issues
+│   │   ├── list-issue-types.ts
 │   │   ├── me.ts
 │   │   ├── projects.ts
 │   │   ├── project-statuses.ts

package/dist/cli.js

@@ -16,6 +16,7 @@ const list_issue_types_1 = require("./commands/list-issue-types");
 const run_jql_1 = require("./commands/run-jql");
 const update_description_1 = require("./commands/update-description");
 const add_comment_1 = require("./commands/add-comment");
+const create_task_1 = require("./commands/create-task");
 const about_1 = require("./commands/about");
 const auth_1 = require("./commands/auth");
 const settings_1 = require("./lib/settings");
@@ -95,6 +96,15 @@ program
     .requiredOption('--file-path <path>', 'Path to Markdown file')
     .requiredOption('--issue-key <key>', 'Jira issue key (e.g., PS-123)')
     .action(withPermission('add-comment', add_comment_1.addCommentCommand));
+// Create task command
+program
+    .command('create-task')
+    .description('Create a new Jira issue')
+    .requiredOption('--title <title>', 'Issue title/summary')
+    .requiredOption('--project <project>', 'Project key (e.g., PROJ)')
+    .requiredOption('--issue-type <type>', 'Issue type (e.g., Task, Epic, Subtask)')
+    .option('--parent <key>', 'Parent issue key (required for subtasks)')
+    .action(withPermission('create-task', create_task_1.createTaskCommand));
 // About command (always allowed)
 program
     .command('about')

package/dist/commands/create-task.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTaskCommand = createTaskCommand;
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+const jira_client_1 = require("../lib/jira-client");
+async function createTaskCommand(options) {
+    const { title, project, issueType, parent } = options;
+    // Validate required fields
+    if (!title || title.trim() === '') {
+        console.error(chalk_1.default.red('\nError: Title is required (use --title)'));
+        process.exit(1);
+    }
+    if (!project || project.trim() === '') {
+        console.error(chalk_1.default.red('\nError: Project is required (use --project)'));
+        process.exit(1);
+    }
+    if (!issueType || issueType.trim() === '') {
+        console.error(chalk_1.default.red('\nError: Issue type is required (use --issue-type)'));
+        process.exit(1);
+    }
+    // Create issue with spinner
+    const spinner = (0, ora_1.default)(`Creating ${issueType} in project ${project}...`).start();
+    try {
+        const result = await (0, jira_client_1.createIssue)(project, title, issueType, parent);
+        spinner.succeed(chalk_1.default.green(`Issue created successfully: ${result.key}`));
+        console.log(chalk_1.default.gray(`\nTitle: ${title}`));
+        console.log(chalk_1.default.gray(`Project: ${project}`));
+        console.log(chalk_1.default.gray(`Issue Type: ${issueType}`));
+        if (parent) {
+            console.log(chalk_1.default.gray(`Parent: ${parent}`));
+        }
+        console.log(chalk_1.default.cyan(`\nIssue Key: ${result.key}`));
+    }
+    catch (error) {
+        spinner.fail(chalk_1.default.red('Failed to create issue'));
+        console.error(chalk_1.default.red('\nError: ' + (error instanceof Error ? error.message : 'Unknown error')));
+        // Provide helpful hints based on error
+        if (error instanceof Error) {
+            if (error.message.includes('project') || error.message.includes('Project')) {
+                console.log(chalk_1.default.yellow('\nHint: Check that the project key is correct'));
+                console.log(chalk_1.default.yellow('Use "jira-ai projects" to see available projects'));
+            }
+            else if (error.message.includes('issue type') || error.message.includes('issuetype')) {
+                console.log(chalk_1.default.yellow('\nHint: Check that the issue type is correct'));
+                console.log(chalk_1.default.yellow(`Use "jira-ai list-issue-types ${project}" to see available issue types`));
+            }
+            else if (error.message.includes('parent') || error.message.includes('Parent')) {
+                console.log(chalk_1.default.yellow('\nHint: Check that the parent issue key is correct'));
+                console.log(chalk_1.default.yellow('Parent issues are required for subtasks'));
+            }
+            else if (error.message.includes('403')) {
+                console.log(chalk_1.default.yellow('\nHint: You may not have permission to create issues in this project'));
+            }
+        }
+        process.exit(1);
+    }
+}

package/dist/lib/jira-client.js

@@ -10,6 +10,7 @@ exports.searchIssuesByJql = searchIssuesByJql;
 exports.updateIssueDescription = updateIssueDescription;
 exports.addIssueComment = addIssueComment;
 exports.getProjectIssueTypes = getProjectIssueTypes;
+exports.createIssue = createIssue;
 const jira_js_1 = require("jira.js");
 const utils_1 = require("./utils");
 const auth_storage_1 = require("./auth-storage");
@@ -270,3 +271,35 @@ async function getProjectIssueTypes(projectIdOrKey) {
         hierarchyLevel: issueType.hierarchyLevel || 0,
     })) || [];
 }
+/**
+ * Create a new issue
+ * @param projectKey - The project key (e.g., "PROJ")
+ * @param summary - The issue title/summary
+ * @param issueTypeName - The issue type name (e.g., "Task", "Epic", "Subtask")
+ * @param parentKey - Optional parent issue key for subtasks
+ */
+async function createIssue(projectKey, summary, issueTypeName, parentKey) {
+    const client = getJiraClient();
+    const fields = {
+        project: {
+            key: projectKey,
+        },
+        summary,
+        issuetype: {
+            name: issueTypeName,
+        },
+    };
+    // Add parent field if this is a subtask
+    if (parentKey) {
+        fields.parent = {
+            key: parentKey,
+        };
+    }
+    const response = await client.issues.createIssue({
+        fields,
+    });
+    return {
+        key: response.key || '',
+        id: response.id || '',
+    };
+}

package/package.json

@@ -1,16 +1,30 @@
 {
   "name": "jira-ai",
-  "version": "0.2.11",
+  "version": "0.3.1",
   "description": "CLI tool for interacting with Atlassian Jira",
   "main": "dist/cli.js",
   "bin": {
     "jira-ai": "./dist/cli.js"
   },
+  "files": [
+    "dist",
+    "settings.yaml",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yourusername/jira-ai.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yourusername/jira-ai/issues"
+  },
+  "homepage": "https://github.com/yourusername/jira-ai#readme",
   "scripts": {
     "dev": "ts-node src/cli.ts",
     "build": "tsc && chmod +x dist/cli.js",
     "start": "node dist/cli.js",
     "link": "npm run build && npm link",
+    "prepublishOnly": "npm run build && npm test",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
@@ -19,10 +33,18 @@
   "keywords": [
     "jira",
     "cli",
-    "atlassian"
+    "atlassian",
+    "jira-api",
+    "issue-tracker",
+    "task-management",
+    "command-line",
+    "typescript"
   ],
-  "author": "",
+  "author": "Your Name <your.email@example.com>",
   "license": "ISC",
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "dependencies": {
     "chalk": "^4.1.2",
     "cli-table3": "^0.6.5",

package/settings.yaml

@@ -11,7 +11,7 @@ projects:
   # - all
 
 # Commands: List of allowed commands (use "all" to allow all commands)
-# Available commands: me, projects, task-with-details, project-statuses, list-issue-types, run-jql, update-description, add-comment, about
+# Available commands: me, projects, task-with-details, project-statuses, list-issue-types, run-jql, update-description, add-comment, create-task, about
 commands:
   - me
   - projects
@@ -23,3 +23,4 @@ commands:
   - list-issue-types
   - update-description
   - add-comment
+  - create-task

package/jest.config.js

@@ -1,21 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  roots: ['<rootDir>/src', '<rootDir>/tests'],
-  testMatch: ['**/__tests__/**/*.ts', '**/*.test.ts', '**/*.spec.ts'],
-  collectCoverageFrom: [
-    'src/**/*.ts',
-    '!src/**/*.d.ts',
-    '!src/cli.ts'
-  ],
-  coverageDirectory: 'coverage',
-  coverageReporters: ['text', 'lcov', 'html'],
-  moduleFileExtensions: ['ts', 'js', 'json'],
-  verbose: true,
-  moduleNameMapper: {
-    '^jira\\.js$': '<rootDir>/tests/__mocks__/jira.js.ts',
-    '^mdast-util-from-adf$': '<rootDir>/tests/__mocks__/mdast-util-from-adf.ts',
-    '^mdast-util-to-markdown$': '<rootDir>/tests/__mocks__/mdast-util-to-markdown.ts',
-    '^md-to-adf$': '<rootDir>/tests/__mocks__/md-to-adf.ts'
-  }
-};

package/src/cli.ts

@@ -1,117 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from 'commander';
-import dotenv from 'dotenv';
-import chalk from 'chalk';
-import { validateEnvVars } from './lib/utils';
-import { meCommand } from './commands/me';
-import { projectsCommand } from './commands/projects';
-import { taskWithDetailsCommand } from './commands/task-with-details';
-import { projectStatusesCommand } from './commands/project-statuses';
-import { listIssueTypesCommand } from './commands/list-issue-types';
-import { runJqlCommand } from './commands/run-jql';
-import { updateDescriptionCommand } from './commands/update-description';
-import { addCommentCommand } from './commands/add-comment';
-import { aboutCommand } from './commands/about';
-import { authCommand } from './commands/auth';
-import { isCommandAllowed, getAllowedCommands } from './lib/settings';
-
-// Load environment variables
-dotenv.config();
-
-// Create CLI program
-const program = new Command();
-
-program
-  .name('jira-ai')
-  .description('CLI tool for interacting with Atlassian Jira')
-  .version('1.0.0');
-
-// Middleware to validate credentials for commands that need them
-const validateCredentials = () => {
-  validateEnvVars();
-};
-
-// Helper function to wrap commands with permission check and credential validation
-function withPermission(commandName: string, commandFn: (...args: any[]) => Promise<void>, skipValidation = false) {
-  return async (...args: any[]) => {
-    if (!skipValidation) {
-      validateCredentials();
-    }
-    
-    if (!isCommandAllowed(commandName)) {
-      console.error(chalk.red(`\n❌ Command '${commandName}' is not allowed.`));
-      console.log(chalk.gray('Allowed commands: ' + getAllowedCommands().join(', ')));
-      console.log(chalk.gray('Update settings.yaml to enable this command.\n'));
-      process.exit(1);
-    }
-    return commandFn(...args);
-  };
-}
-
-// Auth command (always allowed, skips validation)
-program
-  .command('auth')
-  .description('Set up Jira authentication credentials')
-  .action(() => authCommand());
-
-// Me command
-program
-  .command('me')
-  .description('Show basic user information')
-  .action(withPermission('me', meCommand));
-
-// Projects command
-program
-  .command('projects')
-  .description('Show list of projects')
-  .action(withPermission('projects', projectsCommand));
-
-// Task with details command
-program
-  .command('task-with-details <task-id>')
-  .description('Show task title, body, and comments')
-  .action(withPermission('task-with-details', taskWithDetailsCommand));
-
-// Project statuses command
-program
-  .command('project-statuses <project-id>')
-  .description('Show all possible statuses for a project')
-  .action(withPermission('project-statuses', projectStatusesCommand));
-
-// List issue types command
-program
-  .command('list-issue-types <project-key>')
-  .description('Show all issue types for a project')
-  .action(withPermission('list-issue-types', listIssueTypesCommand));
-
-// Run JQL command
-program
-  .command('run-jql <jql-query>')
-  .description('Execute JQL query and display results')
-  .option('-l, --limit <number>', 'Maximum number of results (default: 50)', '50')
-  .action(withPermission('run-jql', runJqlCommand));
-
-// Update description command
-program
-  .command('update-description <task-id>')
-  .description('Update task description from a Markdown file')
-  .requiredOption('--from-file <path>', 'Path to Markdown file')
-  .action(withPermission('update-description', updateDescriptionCommand));
-
-// Add comment command
-program
-  .command('add-comment')
-  .description('Add a comment to a Jira issue from a Markdown file')
-  .requiredOption('--file-path <path>', 'Path to Markdown file')
-  .requiredOption('--issue-key <key>', 'Jira issue key (e.g., PS-123)')
-  .action(withPermission('add-comment', addCommentCommand));
-
-// About command (always allowed)
-program
-  .command('about')
-  .description('Show information about available commands')
-  .action(aboutCommand);
-
-// Parse command line arguments
-program.parse();

package/src/commands/about.ts

@@ -1,103 +0,0 @@
-import chalk from 'chalk';
-import { getAllowedCommands, getAllowedProjects, isCommandAllowed, getSettingsPath } from '../lib/settings';
-
-interface CommandInfo {
-  name: string;
-  description: string;
-  usage: string;
-}
-
-const ALL_COMMANDS: CommandInfo[] = [
-  {
-    name: 'me',
-    description: 'Show details of current user',
-    usage: 'jira-ai me --help'
-  },
-  {
-    name: 'projects',
-    description: 'List available projects',
-    usage: 'jira-ai projects --help'
-  },
-  {
-    name: 'task-with-details',
-    description: 'Show task title, body, and comments',
-    usage: 'jira-ai task-with-details --help'
-  },
-  {
-    name: 'project-statuses',
-    description: 'Show all possible statuses for a project',
-    usage: 'jira-ai project-statuses --help'
-  },
-  {
-    name: 'list-issue-types',
-    description: 'Show all issue types for a project (e.g., Epic, Task, Subtask)',
-    usage: 'jira-ai list-issue-types <project-key>'
-  },
-  {
-    name: 'run-jql',
-    description: 'Execute JQL query and display results',
-    usage: 'jira-ai run-jql "<jql-query>" [-l <limit>]'
-  },
-  {
-    name: 'update-description',
-    description: 'Update task description from a Markdown file',
-    usage: 'jira-ai update-description <task-id> --from-file <path>'
-  },
-  {
-    name: 'add-comment',
-    description: 'Add a comment to a Jira issue from a Markdown file',
-    usage: 'jira-ai add-comment --file-path <path> --issue-key <key>'
-  },
-  {
-    name: 'about',
-    description: 'Show this help message',
-    usage: 'jira-ai about'
-  }
-];
-
-export async function aboutCommand() {
-  console.log(chalk.bold.cyan('\n📋 Jira AI - Available Commands\n'));
-
-  console.log(chalk.bold('Usage:'));
-  console.log('  jira-ai <command> [options]\n');
-
-  const allowedCommandsList = getAllowedCommands();
-  const isAllAllowed = allowedCommandsList.includes('all');
-
-  // Filter commands based on settings (about is always shown)
-  const commandsToShow = ALL_COMMANDS.filter(cmd =>
-    cmd.name === 'about' || isAllAllowed || isCommandAllowed(cmd.name)
-  );
-
-  console.log(chalk.bold('Available Commands:\n'));
-
-  for (const cmd of commandsToShow) {
-    console.log(chalk.yellow(`  ${cmd.name}`));
-    console.log(`    ${cmd.description}`);
-    console.log(`    Usage: ${cmd.usage}\n`);
-  }
-
-  // Show disabled commands if not all are allowed
-  if (!isAllAllowed) {
-    const disabledCommands = ALL_COMMANDS.filter(cmd =>
-      cmd.name !== 'about' && !isCommandAllowed(cmd.name)
-    );
-
-    if (disabledCommands.length > 0) {
-      console.log(chalk.bold('Disabled Commands:\n'));
-      for (const cmd of disabledCommands) {
-        console.log(chalk.gray(`  ${cmd.name} - ${cmd.description}`));
-      }
-      console.log();
-    }
-  }
-
-  console.log(chalk.bold('For detailed help on any command, run:'));
-  console.log(chalk.green('  jira-ai <command> --help\n'));
-
-  console.log(chalk.bold('Configuration:'));
-  console.log(`  Settings file: ${chalk.cyan(getSettingsPath())}`);
-  const allowedProjects = getAllowedProjects();
-  console.log(`  - Projects: ${allowedProjects.includes('all') ? 'All allowed' : allowedProjects.join(', ')}`);
-  console.log(`  - Commands: ${isAllAllowed ? 'All allowed' : allowedCommandsList.join(', ')}\n`);
-}

package/src/commands/add-comment.ts

@@ -1,94 +0,0 @@
-import chalk from 'chalk';
-import ora from 'ora';
-import * as fs from 'fs';
-import * as path from 'path';
-import mdToAdf from 'md-to-adf';
-import { addIssueComment } from '../lib/jira-client';
-
-export async function addCommentCommand(
-  options: { filePath: string; issueKey: string }
-): Promise<void> {
-  const { filePath, issueKey } = options;
-
-  // Validate issueKey
-  if (!issueKey || issueKey.trim() === '') {
-    console.error(chalk.red('\nError: Issue key is required (use --issue-key)'));
-    process.exit(1);
-  }
-
-  // Validate file path
-  if (!filePath || filePath.trim() === '') {
-    console.error(chalk.red('\nError: File path is required (use --file-path)'));
-    process.exit(1);
-  }
-
-  // Resolve file path to absolute
-  const absolutePath = path.resolve(filePath);
-
-  // Check file exists
-  if (!fs.existsSync(absolutePath)) {
-    console.error(chalk.red(`\nError: File not found: ${absolutePath}`));
-    process.exit(1);
-  }
-
-  // Read file
-  let markdownContent: string;
-  try {
-    markdownContent = fs.readFileSync(absolutePath, 'utf-8');
-  } catch (error) {
-    console.error(
-      chalk.red(
-        '\nError reading file: ' +
-          (error instanceof Error ? error.message : 'Unknown error')
-      )
-    );
-    process.exit(1);
-  }
-
-  // Validate file is not empty
-  if (markdownContent.trim() === '') {
-    console.error(chalk.red('\nError: File is empty'));
-    process.exit(1);
-  }
-
-  // Convert Markdown to ADF
-  let adfContent: any;
-  try {
-    adfContent = mdToAdf(markdownContent);
-  } catch (error) {
-    console.error(
-      chalk.red(
-        '\nError converting Markdown to ADF: ' +
-          (error instanceof Error ? error.message : 'Unknown error')
-      )
-    );
-    process.exit(1);
-  }
-
-  // Add comment with spinner
-  const spinner = ora(`Adding comment to ${issueKey}...`).start();
-
-  try {
-    await addIssueComment(issueKey, adfContent);
-    spinner.succeed(chalk.green(`Comment added successfully to ${issueKey}`));
-    console.log(chalk.gray(`\nFile: ${absolutePath}`));
-  } catch (error) {
-    spinner.fail(chalk.red('Failed to add comment'));
-    console.error(
-      chalk.red(
-        '\nError: ' + (error instanceof Error ? error.message : 'Unknown error')
-      )
-    );
-
-    // Provide helpful hints based on error
-    if (error instanceof Error && error.message.includes('404')) {
-      console.log(chalk.yellow('\nHint: Check that the issue key is correct'));
-    } else if (error instanceof Error && error.message.includes('403')) {
-      console.log(
-        chalk.yellow('\nHint: You may not have permission to comment on this issue')
-      );
-    }
-
-    process.exit(1);
-  }
-}