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

without-comments

v1.0.0

Published

Small utility that removes line/trailing comments from any input

Downloads

117

Readme

without-comments

A utility that parses stuff like this:

# line comment
someValue
another value bla bla bla
valueWithTrailingComment # isn't that nice


        anotherOne

Into this:


someValue
another value bla bla bla
valueWithTrailingComment


        anotherOne

You can use it for whatever data you want; all it does is remove line/trailing comments from your input.

Usage (CLI)

Given you have a file named stuff.txt, run:

npx without-comments ./stuff.txt

If you want to use a token other than # for comments, specify it like so:

npx without-comments --token '//' ./stuff.txt

Usage (API)

This package exports two functions:

export function parse(content: string, commentToken?: string): string;
export function parseFile(filename: string, commentToken?: string): string;

parse takes a content string, and optionally a comment token (it defaults to '#'), and returns the content string with the comments removed.

parseFile takes a path to a file, and optionally a comment token (it defaults to '#'), reads the file at that path synchronously, and returns the contents of that file with the comments removed.

Notes

Each line of the input is parsed separately, so inline and multiline comments (eg /* */ or --[[ ]]) aren't supported.

License

MIT