dotlang-with-line-break v1.0.5

Dotlang with Line Break

This is a fork of the dotlang library by NobUwU. We do not claim the ownership of the official library, only this fork.

CREDIT: dotlang's official README with some tweaks, dotlang

Installation

npm i dotlang-with-line-break

Usage

const dotlang = require('dotlang-with-line-break')

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>

Parse lang file and return map

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

Parse multiple lang files and return map

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

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
dotlang.linebreak = hey \n im a line break

# 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-colorizer

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