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

keyword-count

v0.1.0

Published

Get the keyword frequency for a file or directory output as JSON.

Downloads

3

Readme

keyword-count

Get the keyword frequency for a file or directory output as JSON.

Install

For the module:

npm install keyword-count

For the command:

npm install -g keyword-count

Example

File to Analyze - path/to/myFile.txt

'In that direction,' the Cat said, waving its right paw round, 'lives a Hatter: and in that direction,' waving the other paw, 'lives a March Hare. Visit either you like: they're both mad.'
'But I don't want to go among mad people,' Alice remarked.
'Oh, you can't help that,' said the Cat: 'we're all mad here. I'm mad. You're mad.'
'How do you know I'm mad?' said Alice.
'You must be,' said the Cat, 'or you wouldn't have come here.'

JSON with Keywords - path/to/keywords.json

{
	"keywords": ["Alice", "Cat", "March Hare", "Hatter", "mad"]
}

Usage

var keywordCount = require('keyword-count');

var options = {
    target: 'path/to/myFile.txt',
    keywordsList: 'path/to/keywords.json', // Can be filename or an array of strings, i.e. ["foo", "bar"]
    outputPath: 'path/to/results.json'    // Optional
};

keywordCount(options)
    .then(function(results) {
        // results written to path/to/results.json
        console.log(results);
    });

Tada! New file - path/to/results.json

{
	"myFile": {
		"Cat": 3,
		"Hatter": 1,
		"March Hare": 1,
		"Alice": 2,
		"mad": 6
	}
}

API

keywordCount(options)

Returns a promise that resolves with a results object. results matches the content written to your json file.

results will look like this:

// Given search for keywords ['foo', 'bar'] in MyFile.html
{
	MyFile: {
		foo: 5,
		bar: 2
	}
}
options
  • target (string) Name of file or directory to inspect
  • keywordsList (string or array) Name of json file with list of keywords or array of keywords
  • outputPath (string) Optional. Path of where json output should be written. If not provided, defaults to target/results.json
  • keyName (string) Optional. Name of array of keywords in keywordsList json file. Default is "keywords"
  • ignoreCase (boolean) Optional. Whether search should ignore case. Default is false

Command usage

$ keyword-count <path/to/target-file-to-inspect> <path/to/keyword-list-json> {OPTIONS}

Options
	-i, --ignore-case  Ignore case of keywords
	-k, --key-name     Name of keyword array in json file
	-o, --output-file  Name of file for json output, i.e. -o path/to/output.json