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

lit-issue-reporter

v0.6.0

Published

Web application debugger. Provides form UI and issue submission functionality.

Downloads

15

Readme

lit-issue-reporter

main branch parameter Downloads Version License Vercel deployment

This library allows anyone to submit issues directly from a web application.
It is made of web-component (lit), provided as an ES module, and can be used in various FWs and designs.

Vanilla JS, React, Vue, Svelte ...

DEMO

https://user-images.githubusercontent.com/3760515/183294974-fb73c893-357e-42c2-9b0c-f4e7f24e51b1.mp4

Browsers support

| IE / Edge | Firefox | Chrome | | --------- | --------- | --------- | | Edge| last 2 versions| last 2 versions

  • Currently, some custom components are not supported, and Safari does not work.

🤔 Why is this needed?

During application development, when reporting a problem, it may not be easy for a non-engineer to intuitively imagine the information needed for verification.

This library, in addition to GitHub's Issue Template feature, automatically supplements the user's environment information to aid reproducibility.

✨ Features

  • 📝 Provide a form for the web application to submit a form (using GitHub API v4)
  • 🗂️ Issue Templates configured in the repository can be used
  • 🔦 Automatically adds information such as location, browser, OS, screen size, and monitor resolution
  • 🌏 All text in the form UI can be replaced with arbitrary text
  • 📸 Additional screenshot data can be added (available but in development)

📦 Install

yarn add lit-issue-reporter

🐣 Usage

Prepare

You must first issue a personal access token (PAT) with access permission to any repository from settings/tokens.

  • Please be careful when handling it, as it requires a repo scope!
  • It is recommended that PAT not be pushed to the remote side. for example, manage it in the .env variable and then ignore the build file.
    Also, be sure to use it in a restricted environment, as it will be embedded in your application.

Setup

if (process.env.NODE_ENV !== 'production') {
  import('lit-issue-reporter').then(({ createReporter }) => {
    createReporter({
      token: process.env.GITHUB_TOKEN,
      owner: '<GITHUB_USER_NAME>',
      repository: '<GITHUB_REPOSITORY_NAME>',
    })
  })
}

Then add to any position.

...
<issue-reporter></issue-reporter>
</body>

Finally, add a style.

@import 'lit-issue-reporter/dist/style.css';

Options

| key | type | default | description | |:--|:--|:--|:--| | lang | 'ja' \| 'en' | 'ja' | i18n by lit-translate | | stringsLoader | (lang) => Promise<Strings> | (lang) => import(./locales/${lang}.json) | Can be replaced by specifying any loader | | noticeDuration | number | 4000 | Notification time to open issues | | insertFrom | boolean | true | The following text will be inserted at the end of the body. Sent by lit-issue-repoter |

License

lit-issue-reporter is available under the MIT License.