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

grunt-copytext

v1.0.0

Published

A Grunt plugin to convert a properly formatted XLSX spreadsheet into a JSON file for templates.

Downloads

6

Readme

grunt-copytext Build Status

A Grunt plugin to convert a properly formatted XLSX spreadsheet into a JSON file for templates using the copytext library.

Getting Started

This plugin requires Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-copytext --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-copytext');

The copytext task

Overview

In your project's Gruntfile, add a section named copytext to the data object passed into grunt.initConfig().

grunt.initConfig({
  copytext: {
    base: {
      options: {
        // Target-specific options go here.
      },
      src: // input file
      dest: // output file
    }
  }
});

grunt-copytext fully supports the all methods of file globbing Grunt provides, as well.

Options

options.basetype

Type: String Default value: 'keyvalue'

The default processor to use for converting XLSX sheets.

options.overrides

Type: Object Default value: []

A set of key/value pairs that override the basetype for each specified sheet.

// an example of `overrides` in use
{
  basetype: 'objectlist',
  overrides: {
    META: 'keyvalue'
  }
}

options.output

Type: Function Default value: function(input) { return JSON.stringify(input); }

By default the output of any XLSX files passed into grunt-copytext will be written to the dest as JSON. Provide your own function to bypass that. input represents the Object that copytext produces after processing the XLSX file.

Usage Examples

Default Options

In this example, it is assumed that all XLSX sheets being passed in are in the keyvalue format.

grunt.initConfig({
  copytext: {
    base: {
      options: {},
      src: './test/fixtures/basic_keyvalue.xlsx',
      dest: './tmp/basic_keyvalue.json'
    }
  }
})

Custom Options

In this example, custom options are used to tell grunt-copytext what to pass on to the copytext library.

grunt.initConfig({
  copytext: {
    base: {
      options: {
        basetype: 'objectlist',
        overrides: {
          SHIBA: 'keyvalue'
        }
      },
      src: './test/fixtures/mixed_keyvalue_objectlist.xlsx',
      dest: './tmp/mixed_keyvalue_objectlist.json'
    }
  }
});

If you wanted to process a whole bunch of XLSX files, that is also possible – as long as they all use the same sheet options. Otherwise you'll need to create separate tasks.

grunt.initConfig({
  copytext: {
    base: {
      options: {
        basetype: 'objectlist'
      },
      files: [{
        expand: true,
        cwd: './test/fixtures/',
        src: '*.xlsx',
        dest: './tmp/',
        ext: '.json'
      }]
    }
  }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

License

By Ryan Murphy.

Available under the MIT license.