feat: fromFile function add

index.js

@@ -29,6 +29,16 @@ class Glossary {
     this._entries[term] = description
   }
 
+  fromFile (filename) {
+    let glossary = require(filename)
+    assert(Object.keys(glossary).length, 'The file seems to be empty')
+    glossary.forEach(term => {
+      assert(term, 'Term or description not found')
+      this.add(term[0], term[1])
+    })
+    this._entries = glossary
+  }
+
   get entries () {
     return this._entries
   }

readme.md

@@ -1,4 +1,4 @@
-# crowdin-glossary 
+# crowdin-glossary
 
 Create and upload translation glossaries using the Crowdin API
 
@@ -17,7 +17,6 @@ and
 npm install crowdin-glossary --save
 ```
 
-
 ## Usage
 
 ```js
@@ -51,6 +50,13 @@ call `glossary.upload()`
 - `term` String (required)
 - `description` String (required)
 
+### `glossary.fromFile(filename)`
+
+Uploads entries from the file provided. Entries only exist in memory until you
+call `glossary.upload()`
+
+- `filename` String (required)(should be the relative path to the .json file)
+
 ### `glossary.upload()`
 
 Async function that uploads all the added terms to Crowdin.
@@ -67,9 +73,19 @@ A getter that returns the web URL of your project's glossary on crowdin.com
 
 ### `glossary.csv`
 
-A getter that converts your entries into a valid CSV string for upload to 
+A getter that converts your entries into a valid CSV string for upload to
 Crowdin. Used for internal purposes.
 
+#### `.json` file template
+
+```json
+[
+  [$term, $description]
+]
+```
+
+A 2D Array of term and description
+
 ## License
 
 MIT

test.js

@@ -64,6 +64,22 @@ describe('glossary.add()', () => {
   })
 })
 
+describe('glossary.fromFile()', () => {
+  const glossary = Glossary({project: 'bar', crowdinKey: 'xyz'})
+
+  test('is empty', () => {
+    expect(() => {
+      glossary.fromFile('./test/empty-file.json')
+    }).toThrow('The file seems to be empty')
+  })
+
+  test('upload from a file', () => {
+    expect(() => {
+      glossary.fromFile('./test/glossary_test.json')
+    })
+  })
+})
+
 describe('glossary.webpage', () => {
   test('is a crowdin URL', () => {
     const glossary = Glossary({project: 'foo-bar', crowdinKey: 'xyz'})

test/empty-file.json

@@ -0,0 +1,3 @@
+{
+
+}

test/glossary_test.json

@@ -0,0 +1,4 @@
+{
+  "something": "this is something",
+  "other": "this is other"
+}