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-onesky-export

v0.1.7

Published

Export translations from your OneSky projects

Downloads

4,061

Readme

grunt-onesky-export

Export translations from your OneSky projects

Getting Started

This plugin requires Grunt ~0.4.5

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-onesky-export --save-dev

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

grunt.loadNpmTasks('grunt-onesky-export');

The "oneskyExport" task

Overview

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

Options

options.authFile

Type: String Default value: onesky.json

A JSON file with your OneSky API keys.

{
    "publicKey": "YOUR_PUBLIC_KEY",
    "secretKey": "YOUR_SECRET_KEY"
}

options.dest

Type: String Default value: /

The destination of the exported translation file(s).

options.projectId

Type: String

Your OneSky project ID

options.sourceFile

Type: String

The filename of the imported translation document. You can find a list of your uploaded files at "Projects > YOUR-PROJECT-NAME > Phrases Management > Manage Files", when logged in as a project admin in your OneSky account.

options.locale

Type: String

The specific translation language you wish to export. This option is only required when options.exportType is set to locale

options.fileFormat

Type: String

The file format for OneSky to assume when exporting translations (if different from source file format). See list of available file formats. This option is only valid when options.exportType is set to multilingual.

NOTE: It is recommended to only convert from a source file with format: I18NEXT_HIERARCHICAL_JSON. Otherwise, leave this unset to maintain the original source file format.

options.output (optional)

Type: String

The filename for the exported translation file(s).

options.exportType (optional)

Type: String Default: multilingual Allowed values: locale, multilingual

The export method to generate translation documents.

  • locale fetches a specified language translation and exports to a single file.
  • multilingual fetches all language translations and exports to a single file.

options.readyToPublish (optional)

Type: Boolean Default: false

Checks whether the specified locale is flagged isReadyToPublish in your OneSky project. This options is only valid when options.exportType is set to locale.

NOTE: Enabling this option triggers an additional call to the OneSky API to first check the status of the locale before downloading the translations.

options.sortKeys (optional)

Type: Boolean Default value: false

Sort exported translation keys alphabetically.

options.indent (optional)

Type: Integer Default value: 4

Number of whitespaces to indent the output JSON

Usage Examples

grunt.initConfig({
    oneskyExport: {
        options: {
            authFile: 'onesky.json',
            dest: 'translations/',
            projectId: '12345',
            indent: 4,
            sortKeys: true
        },
        exportMedia: {
            options: {
                sourceFile: 'media.json',
                output: 'media.json',
                exportType: 'multilingual'
            }
        },
        exportUser: {
            options: {                
                sourceFile: 'user.json',
                output: 'user/en.json',
                exportType: 'locale',
                locale: 'en'
            }
        }
    },
});

Contributing

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