Giter VIP home page Giter VIP logo

grunt-json-language's Introduction

grunt-json-language

manage language json files, checking, unique keys, syncing, remove unused, pretty format and minimum file size

Expmple of checking json file

Getting Started

This plugin requires Grunt ~0.4.5 and Node.js ~8.0

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-json-language --save-dev

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

grunt.loadNpmTasks('grunt-json-language');

The "json_language" task

Overview

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

grunt.initConfig({
  json_language: {
    options: {
  	// Task-specific options go here.
    },
    your_target: {
  	// Target-specific file lists and/or options go here.
    },
  },
});

Options

options.check

Type: Boolean Default value: true

A option to define whether to check json format or not.

options.sync

Type: Boolean Default value: true

A option to define whether to add language items which are not translated to multi languages or not.

options.unique

Type: Boolean Default value: false

A option to define whether to make sure json keys are all unique or not.

options.rev_unused

Type: Boolean Default value: false

A option to define whether to remove language items which are not used in project or not.

options.pretty

Type: Boolean Default value: false

A option to define whether to pretty json format or not.

options.minimum

Type: Boolean Default value: false

A option to define whether to remove space in json files or not.

options.www_out

Type: String Default value: 'build/'

A string value that is define where is web code.

options.eng_file

Type: String Default value: 'en-US.json'

A string value that is define what is name of English file.

options.ignore

Type: Array Default value: ['languagesList.json']

A string value that is define which files are not the language table.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  json_language: {
    options: {},
    files: {
  	'dest/default_options': ['src/testing', 'src/123'],
    },
  },
});

Custom Options

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  json_language: {
    options: {
  	check: true,
  	www_out: "build",
  	ignore: ["languagesList.json"]
    },
    src: ["build/languages/*.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.

Release History

build 0.1.0 on 2017.10.15

grunt-json-language's People

Contributors

liqingjht avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.