npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

octokit-plugin-unique-issue

v1.1.2

Published

Creates and retrieves unique GitHub issues

Downloads

12

Readme

octokit-plugin-unique-issue

Creates and retrieves unique GitHub issues

@latest Build Status

Usage

Browsers

Load octokit-plugin-unique-issue and @octokit/core (or core-compatible module) directly from cdn.skypack.dev

<script type="module">
  import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
  import { uniqueIssue } from "https://cdn.skypack.dev/octokit-plugin-unique-issue";
</script>

Node

Install with npm install @octokit/core octokit-plugin-unique-issue. Optionally replace @octokit/core with a compatible module

const { Octokit } = require("@octokit/core");
const { uniqueIssue } = require("octokit-plugin-unique-issue");

createOrUpdateUniqueIssue

Creates or updates an issue with the provided identifier.

By default, when close_previous is false and a single issue with the provided identifier is found, that issue will be updated, otherwise a new issue is created. An error will be thrown if more than one issue with the provided identifier is found.

When close_previous is true, all existing issues with the provided identifier will be closed before creating a new issue.

createOrUpdateUniqueIssue accepts all supported parameters for creating or updating an issue with the GitHub REST API.

Create or Update Issue

const MyOctokit = Octokit.plugin(uniqueIssue);
const octokit = new MyOctokit({ auth: "secret123" });

const { data, updated } = await octokit.createOrUpdateUniqueIssue({
  identifier: "super-unique-identifier",
  owner: "tmelliottjr",
  repo: "octokit-plugin-unique-issue",
  title: "My unique issue",
  body: "The body of my unique issue!",
});

const action = updated ? "Updated" : "Created";

console.log(`${action} issue: ${data.number}`);

Create and Close Previous Issue

const MyOctokit = Octokit.plugin(uniqueIssue);
const octokit = new MyOctokit({ auth: "secret123" });

const { data, updated, closed_issues } =
  await octokit.createOrUpdateUniqueIssue({
    identifier: "super-unique-identifier",
    owner: "tmelliottjr",
    repo: "octokit-plugin-unique-issue",
    title: "My unique issue",
    body: "The body of my unique issue!",
    close_previous: true,
  });

console.log(`Created issue: ${data.number}`);

if (closed_issues.length) {
  console.log(
    `Closed issue(s) ${closed_issues.map((issue) => issue.number).join(", ")}`,
  );
}

Options

How it Works

createOrUpdateUniqueIssue will add an MDAST Comment Marker to an issue's body containing the unique identifier provided.

<!-- octokit-unique-issue id="super-unique-identifier" -->

Contributing

See CONTRIBUTING.md

License

MIT