New Issue from Selection (0.5.0) 95f69b4a3ac2

## 0.5.0

- **New Issue from Selection** in the editor's context menu: the selected lines (or the current one) quoted in a new issue with a permalink to them on the hub. A TODO or FIXME line suggests the title, and the issue's number can be written back into it as `TODO(#12)`.

- File links on the hub can carry a line range (`#L3-L7`).

- **Issues from the editor**: turn a selection or a TODO line into an issue that quotes the code and links to it.

### 8.1 Issues from the editor

**New Issue from Selection** (editor context menu) opens an issue quoting the selected lines, or the current line when nothing is selected, under a permalink to them on the hub: to the bookmark's head when it has exactly one and the file is saved, otherwise to the bookmark, with a note that the lines may move. A `TODO`, `FIXME`, `XXX` or `HACK` line suggests the title, and after the issue is opened the extension offers to write its number into the line (`TODO(#12): …`). The new issue opens in the editor.

  "version": "0.5.0",

        "command": "oxygenhub.issueFromSelection",

        "title": "New Issue from Selection\u2026",

        "category": "Oxygenhub"

      },

      {

      ],

      "editor/context": [

        {

          "command": "oxygenhub.issueFromSelection",

          "when": "resourceScheme == file",

          "group": "9_oxygenhub@1"

        }

import { annotateTodo, issueBody, todoTitle } from "./refs";

    vscode.commands.registerCommand("oxygenhub.issueFromSelection", () => issueFromSelection()),

/**

 * An issue from the editor (spec §8.1): the selection, or the current line,

 * quoted under a permalink to it on the hub. A TODO line suggests the title

 * and afterwards records the issue's number.

 */

async function issueFromSelection(): Promise<void> {

  const editor = vscode.window.activeTextEditor;

  if (!editor || editor.document.uri.scheme !== "file") {

    void vscode.window.showWarningMessage("Oxygenhub: open a file of the repository first.");

    return;

  }

  const doc = editor.document;

  const file = doc.uri.fsPath;

  const repo = (await proposals.repos()).filter((r) => file.startsWith(r.handle.root + "/") || file.startsWith(r.handle.root + "\\")).sort((a, b) => b.handle.root.length - a.handle.root.length)[0];

  if (!repo) {

    void vscode.window.showWarningMessage("Oxygenhub: this file is not in a repository with a hub remote.");

    return;

  }

  const sel = editor.selection;

  const startLine = sel.start.line;

  const endLine = sel.isEmpty ? sel.start.line : sel.end.character === 0 && sel.end.line > sel.start.line ? sel.end.line - 1 : sel.end.line;

  const code = doc.getText(new vscode.Range(startLine, 0, endLine, doc.lineAt(endLine).text.length));

  const todoLine = [...Array(endLine - startLine + 1).keys()].map((i) => startLine + i).find((l) => todoTitle(doc.lineAt(l).text) !== undefined);

  const title = await vscode.window.showInputBox({ prompt: "Issue title", value: todoLine !== undefined ? todoTitle(doc.lineAt(todoLine).text) : "" });

  if (!title) {

    return;

  }

  // Pin the link to the head when the bookmark has one; otherwise follow the bookmark.

  const bookmark = repo.handle.bookmarks.find((b) => b.name === repo.handle.currentBookmark);

  const pinned = bookmark?.heads.length === 1 && !doc.isDirty;

  const reference = pinned ? bookmark!.heads[0] : (repo.handle.currentBookmark ?? "main");

  const path = file.slice(repo.handle.root.length + 1).split("\\").join("/");

  const permalink = hubUrl(repo.base, repo.owner, repo.name, { kind: "file", reference, path, line: startLine + 1, endLine: endLine + 1 });

  const body = issueBody({ permalink, path, startLine: startLine + 1, endLine: endLine + 1, language: doc.languageId === "plaintext" ? "" : doc.languageId, code, pinned });

  try {

    const client = auth.clientFor(repo.base);

    const issue = await client.createIssue(repo.owner, repo.name, title, body);

    issues.refresh();

    references.clear();

    if (todoLine !== undefined) {

      const line = doc.lineAt(todoLine);

      const annotated = annotateTodo(line.text, issue.number);

      if (annotated !== line.text) {

        const pick = await vscode.window.showInformationMessage(`Oxygenhub: opened #${issue.number}. Record it in the TODO?`, "Add (#" + issue.number + ")");

        if (pick) {

          await editor.edit((e) => e.replace(line.range, annotated));

        }

      }

    }

    await showIssue(auth, repo, issue);

  } catch (e) {

    void vscode.window.showErrorMessage(`Oxygenhub: ${(e as Error).message}`);

  }

}

      const end = typeof target.endLine === "number" && target.endLine !== target.line ? `-L${target.endLine}` : "";

      const line = typeof target.line === "number" ? `#L${target.line}${end}` : "";

/** The note of a `TODO`/`FIXME`/`XXX`/`HACK` comment line, as an issue title. */

export function todoTitle(line: string): string | undefined {

  const m = /\b(TODO|FIXME|XXX|HACK)\b(?:\([^)]*\))?[:\s-]*(.*)$/.exec(line);

  if (!m) {

    return undefined;

  }

  const text = m[2].replace(/\s*(\*\/|-->|#\}|\*\)|;)\s*$/, "").trim();

  return text ? text : `${m[1]} in the code`;

}

/** The TODO line with the new issue's number recorded: `TODO(#12): …`. */

export function annotateTodo(line: string, number: number): string {

  return line.replace(/\b(TODO|FIXME|XXX|HACK)\b(?!\()/, `$1(#${number})`);

}

/** An issue body quoting the code, with a permalink to it on the hub. */

export function issueBody(opts: { permalink: string; path: string; startLine: number; endLine: number; language: string; code: string; pinned: boolean }): string {

  const where = opts.startLine === opts.endLine ? `line ${opts.startLine}` : `lines ${opts.startLine}–${opts.endLine}`;

  const fence = opts.code.includes("```") ? "~~~" : "```";

  const note = opts.pinned ? "" : "\n\n_The link follows the bookmark, which has several heads, so the lines may move._";

  return `From [\`${opts.path}\`, ${where}](${opts.permalink}):\n\n${fence}${opts.language}\n${opts.code.replace(/\n$/, "")}\n${fence}${note}\n`;

}

import { hubUrl as hubUrl2 } from "../out/hub.mjs";

test("file links carry a line range", () => {

  assert.equal(hubUrl2("https://h", "a", "b", { kind: "file", reference: "main", path: "src/x.rs", line: 3, endLine: 7 }), "https://h/a/b/file/main/src/x.rs#L3-L7");

  assert.equal(hubUrl2("https://h", "a", "b", { kind: "file", reference: "main", path: "x", line: 3, endLine: 3 }), "https://h/a/b/file/main/x#L3");

});

import { todoTitle, annotateTodo, issueBody } from "../out/refs.mjs";

test("TODO lines become issue titles and then carry the number", () => {

  assert.equal(todoTitle("    // TODO: handle the empty well"), "handle the empty well");

  assert.equal(todoTitle("/* FIXME - leaks a buffer */"), "leaks a buffer");

  assert.equal(todoTitle("# XXX"), "XXX in the code");

  assert.equal(todoTitle("let x = 1;"), undefined);

  assert.equal(annotateTodo("    // TODO: handle the empty well", 12), "    // TODO(#12): handle the empty well");

  assert.equal(annotateTodo("// TODO(#3): already linked", 12), "// TODO(#3): already linked", "an existing link is kept");

});

test("the issue body quotes the code under a permalink", () => {

  const body = issueBody({ permalink: "https://h/a/b/file/abc/src/x.rs#L3-L4", path: "src/x.rs", startLine: 3, endLine: 4, language: "rust", code: "fn a() {}\nfn b() {}\n", pinned: true });

  assert.ok(body.startsWith("From [`src/x.rs`, lines 3–4](https://h/a/b/file/abc/src/x.rs#L3-L4)"), body);

  assert.ok(body.includes("```rust\nfn a() {}\nfn b() {}\n```"), body);

  assert.ok(!body.includes("several heads"));

  assert.ok(issueBody({ permalink: "p", path: "x", startLine: 1, endLine: 1, language: "", code: "a", pinned: false }).includes("several heads"));

});