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

fs-cson

v0.3.2

Published

Read and write CSON to the filesystem

Downloads

246

Readme

fs-cson

Build Status Dependency Status NPM Version

Read and write CSON to the filesystem, require CSON files

Installation

npm install fs-cson

API

readFile(filePath, callback)

Asynchronously reads the file and parses the contents. The callback is passed two arguments (err, data), where data is the parsed object.

Synchronous version: readFileSync(filePath)

Example

# sample.cson
a: 1
b: 2

# read.coffee
fsCson = require 'fs-cson'

fsCson.readFile 'sample.cson', (err, data) ->
  # data will be {a: 1, b: 2}

register()

Allows cson files to be required.

fsCson = require 'fs-cson'
fsCson.register()

# or

require 'fs-cson/register'

updateFile(filePath, updater, callback)

Asynchronously reads the file, parses the contents, calls updater, and writes the stringified object. updater is passed on argument (data) and should return the updated data. The callback is passed one argument (err).

Synchronous version: updateFileSync(filePath, updater)

Example

# sample.cson
a: 1
b: 2

# update.coffee
fsCson = require 'fs-cson'

updater = (data) ->
  result = {}
  for key, value in data
    result[key] = value * 2
  result.c = 6
  result

fsCson.updateFile 'sample.cson', (err) ->
  # sample.cson now has the content
  # a: 2
  # b: 4
  # c: 6

writeFile(filePath, object, callback)

Stringifies the object and then asynchronously writes to a file. The callback is passed one argument (err).

Synchronous version: writeFileSync(filePath, object)

# write.coffee
fsCson = require 'fs-cson'

fsCson.writeFile 'sample.cson', {a: 1, b: 2}, (err) ->
  # sample.cson now has the content
  # a: 1
  # b: 2

writeFileSafe(filePath, object, callback)

Same as writeFile but creates parent directories if they do not exist.

Synchronous version: writeFileSafeSync(filePath, object)