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-smartling-sdk

v0.0.3

Published

Grunt tasks for smartling-sdk

Downloads

3

Readme

grunt-smartling-sdk Build Status

Grunt tasks for smartling-sdk

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-smartling-sdk

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

grunt.loadNpmTasks('grunt-smartling-sdk');

The "smartling_sdk" task

Overview

In your project's Gruntfile, add a section for each task you want to use in grunt.initConfig().

grunt.initConfig({
  smartling_list: {
    options: {
      // Task-specific options go here.
      smartling: {
        apiBaseUrl: SmartlingSdk.API_BASE_URLS.SANDBOX,
        apiKey: '',
        projectId: ''
      }
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  }
})

Options

options.smartling

Type: Object Default value: None

An object with your Smartling API and Project settings. This is require for all smartling tasks

{
  apiBaseUrl: SmartlingSdk.API_BASE_URLS.LIVE,
  apiKey: 'your-api-key',
  projectId: 'your-project-id'
}

options.operation

Type: Object Default value: None

A object that is used to set Smartling options for a given operation (status, get, upload, etc).

Example options.operation for smartling_upload

{
  fileType: 'json',
  approved: false
}

options.fileUriFunc

Type: Function Default value: None

When src is used to provide files, this function is used to generate fileUri's from the filepaths.

Example in smartling_upload this will used each files 'basename' as its fileUri

smartling_upload: {
  options: {
    smartling: { ... },
    operation: {
      fileType: 'json',
      approved: false
    },
    fileUriFunc: function(filepath) {
      return path.basename(filepath);
    }
  },
  default: {
    src: 'path/to/translations/*.json'
  }
}

options.verbose

Type: Boolean Default value: false

If true extra debugging information will be logged to the console.

smartling_status: {
  options: {
    smartling: { ... },
    operation: {
      locale: 'en',
    },
    fileUriFunc: function(filepath) {
      return path.basename(filepath);
    },
    verbose: true
  },
  default: {
    src: 'path/to/translations/*.json'
  }
}

Usage Examples

See Gruntfile.js for usage examples

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.

Release History

(Nothing yet)

License

Copyright (c) 2014 Hightail. Licensed under the ISC license.