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 🙏

© 2023 – Pkg Stats / Ryan Hefner

@guardian/discussion-rendering

v13.0.0

Published

This codebase started as a hack day project by @gtrufitt and @nicl. The purpose is parity of the existing discussion application on Frontend using the discussion API (search for Private Repo).

Downloads

9,434

Readme

Discussion Rendering

This codebase started as a hack day project by @gtrufitt and @nicl. The purpose is parity of the existing discussion application on Frontend using the discussion API (search for Private Repo).

Getting up and running for local development

Once you've cloned the repo, run yarn to install and then yarn storybook to display the components yarn dev will show the full discussion app with query parameter options

Publishing changes to NPM

Versioning and publishing for this package is managed through changesets.

If you make a change to the repo which merits a version bump, you should add a changeset to your PR:

  1. Run yarn changeset. This will run a CLI with prompts you have to complete.
  2. Choose the appropriate semantic version bump: major, minor, or patch.
  3. Add a description of the change introduced.
  4. Merge the follow-up PR raised by the changesets bot`

Note When a PR with a changeset is merged to main, changesets will automatically open a new PR which, when merged, will automatically bump the version number (following semver conventions), publish the new version to npm, and update the github changelog for this package.

Changesets is a relatively new addition to this repo, so if you run into any difficulties using it, please feel free to open an issue in this repo.

Connection this package to DCR/Frontend to test local changes

If you don't want to publish but still want to see how your changes look when imported, you can use yarn's link command. From this directory, run yarn link Then, as per the prompts, go to the directory of the project you want to link to and run yarn link '@guardian/discussion-rendering' This will mean that this project will now read directly from your local copy of discussion-rendering, instead of downloading from npm. To reset and restore normal npm access run yarn unlink '@guardian/discussion-rendering' As per the prompts, you may need to force reinstall

While you are linked, you will need to run yarn build after making changes to discussion-rendering to see them in the linked repo.

yarn build

Builds the app for production to the build folder.

Snyk Code Scanning

There's a Github action set up on the repository to scan for vulnerabilities. This is set to "continue on error" and so will show a green tick regardless. In order to check the vulnerabilities we can use the Github code scanning feature in the security tab and this will list all vulnerabilities for a given branch etc. You should use this if adding/removing/updating packages to see if there are any vulnerabilities.