Coder Social home page Coder Social logo

dotlang's Introduction

Dotlang

Dotlang is the official library yua uses to parse the .lang translation files and utilize them

Installation

npm i dotlang

Usage

const dotlang = require('dotlang')

const single = dotlang.parse('path/to/dotlang/file.lang')
console.log(single)

const multiple = dotlang.parseMultiple([
  'path/to/dotlang/file.lang',
  'path/to/another/dotlang/file.lang'
])
console.log(multiple)

const dir = dotlang.parseAllInDir('path/to/dir')
console.log(dir)

Functions

parse(path) Map<string, string>

Parameters Type Description
path string Path to .lang file

Parse lang file and return map

parseMultiple(paths) Map<string, Map<string, string>>

Parameters Type Description
paths string[] Array of .lang file paths

Parse multiple lang files and return map

parseAllInDir(dir) Map<string, Map<string, string>>

Parameters Type Description
dir string Path to directory

Finds all lang files in a directory and parses them

Returns

Map<string, string>

Map(int) {
  'key' => 'value'
}

Map<string, Map<string, string>>

Map(int) {
  'fileName' => Map(int) {
     'key' => 'value'
  }
}

Dotlang File

en_US.lang

# Parser Will Ignore comments, use hashtag to comment

dotlang.hello=Hi, I am grateful you found dis lib :)
dotlang.abnormal   =   Spaces Will Not Affect Parser

# Extra
dotlang.meta.description = Pretty Quickly thrown together lib probably has issues

Extra

If you would like your .lang files to be colorized try using our extension dotlang

Also something to note, keys are not required to be concatenated with dots eg: dotlang-weird=lel will work too. I just prefer dots :)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

AGPL-3.0

dotlang's People

Contributors

nobu-sh avatar tsukuyomiotoko 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.