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

leasot-to-readme

v1.0.21

Published

Parse and output TODOs and FIXMEs directly into your root README.md with each build

Downloads

8

Readme

leasot-to-readme

leasot-to-readme

Parse and output TODOs and FIXMEs directly into your root README.md with each build.

NPM Version NPM Downloads Build Status

*** NOTE: STILL IN BUILD STAGES! VERY BETA AND MANY OPTIONS MAY NOT FUNCTION!

Usage

First install leasot-to-readme globally: npm install -g leasot-to-readme

To install with default settings for a given project, run at the root of any valid npm project:

leasot-to-readme install

This will append the TODOs and FIXMEs to the bottom of README.md. Note that the TODOs and FIXMEs will not be appended to the project's README.md until the start command is run.

Alternatively, run leasot-to-readme at anytime with:

leasot-to-readme run

Other Options

--build-command, -b: Provide one or more build commands to hook into leasot-to-readme. Default is npm start --output-file, -o Provide the output file to append the TODO/FIXME summary to. Default is README.md. If a README.md does not exist, one will be generated --title-file, -t Provide the path name to the title file. Default is '' i.e. no title file.

Template Files

Template files can be any valid .md file that can be used to create a custom title/header before the TODOs and FIXMEs are listed. Providing a title file will eliminate the # TODOs and FIXMEs generated by leasot-to-readme default title, for example a title file my-super-cool-title-file.md could contain:

# :rocket: Awesome StUfF still on the todo/fix list!!! :rocket:

To use this as your title instead of the default title, you would issue

leasot-to-readme -t my-super-cool-title-file.md