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

casefu-cli

v1.0.1

Published

CaseFu.com command-line interface.

Downloads

8

Readme

CaseFu CLI module

Write functional specification in Markdown enhanced with specific keywords and generate a nice FSD in HTML format.

Installation

  1. Create a new node module:

     npm init

    and confirm (or answer) all the questions.

  2. Install the CaseFu CLI module:

     npm i casefu-cli --save-dev
  3. Add npm scripts. Add the following 2 rows into the scripts section of the package.json file:

     "scripts": {
     	"build": "casefu build",
     	"serve": "casefu serve"
     }
  4. Create a file at fsd/Overview.md and put the following into it:

     # My new system

Building FSD

To build output FSD run:

npm run build

The FSD is then available at build/index.html.

Writing FSD

  1. Open a terminal at the project directory and execute

     npm run serve
  2. Open a browser window and navigate to the URL given at the terminal.

  3. As you write into the files in the fsd/ directory and save a file, the FSD output in the browser gets automatically refreshed.

There is also a watch command that only re-builds the output FSD file on any change of the source files, but does not push the changes to the browser (the browser page needs to be refreshed manually in this case).

Parameters

The build, serve and watch commands have the following parameters:

  • -s, --sources <sources> - Glob pattern to match source files to process. Default: fsd/**/*.md
  • -t, --target <target> - Filename of generated HTML file. Default: build/index.html
  • -p, --port <port> (only for serve command) - Port to bind to. Default: 8080
  • -v, --verbose - List files processed

Sample FSD

A sample FSD demonstrating the use of CaseFu generator is available here.

It has been generated from the following source files.

Documentation

The complete documentation is available at CaseFu.com.