Use prettier for formatting

Author: nathan818fr

.prettierrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+    trailingComma: 'es5',
+    printWidth: 120,
+    tabWidth: 4,
+    semi: true,
+    singleQuote: true,
+    bracketSpacing: false,
+    overrides: [
+        {
+            files: ['*.json', '*.yml'],
+            options: {tabWidth: 2},
+        },
+    ],
+};

.travis.yml

@@ -1,16 +1,16 @@
 language: node_js
 node_js:
-- "16"
-- "14"
-- "12"
-- "10"
-- "8"
-- "6"
+  - '16'
+  - '14'
+  - '12'
+  - '10'
+  - '8'
+  - '6'
 install:
-- npm install -g yarn
-- npm install -g codecov
-- yarn install
+  - npm install -g yarn
+  - npm install -g codecov
+  - yarn install
 script:
-- yarn run test
-- '[[ "$(node -v)" == v6.* ]] && echo skip || codecov'
-- yarn run build
+  - yarn run test
+  - '[[ "$(node -v)" == v6.* ]] && echo skip || codecov'
+  - yarn run build

README.md

@@ -44,50 +44,60 @@ javaProps
 
 <!-- jsdoc2md start -->
 
-* [javaProps](#javaProps)
-    * [.parse(str)](#javaProps.parse) ⇒ <code>Object</code>
-    * [.parseFile(path, [encoding])](#javaProps.parseFile) ⇒ <code>Promise.&lt;Object&gt;</code>
-    * [.stringify(props)](#javaProps.stringify) ⇒ <code>String</code>
+-   [javaProps](#javaProps)
+    -   [.parse(str)](#javaProps.parse) ⇒ <code>Object</code>
+    -   [.parseFile(path, [encoding])](#javaProps.parseFile) ⇒ <code>Promise.&lt;Object&gt;</code>
+    -   [.stringify(props)](#javaProps.stringify) ⇒ <code>String</code>
 
 <a name="javaProps.parse"></a>
 
 ### javaProps.parse(str) ⇒ <code>Object</code>
+
 Parses a .properties string, constructing a corresponding JavaScript object.
 
-**Returns**: <code>Object</code> - The [Object](Object) corresponding to the given string  
+**Returns**: <code>Object</code> - The [Object](Object) corresponding to the given string
+
+| Param | Type                | Description                        |
+| ----- | ------------------- | ---------------------------------- |
+| str   | <code>String</code> | The string to parse as .properties |
 
-| Param | Type | Description |
-| --- | --- | --- |
-| str | <code>String</code> | The string to parse as .properties |
+**Example**
 
-**Example**  
 ```js
 const props = javaProps.parse('foo=Hello\nbar=World');
 console.log(props.foo + ' ' + props.bar);
 // "Hello World"
 ```
+
 <a name="javaProps.parseFile"></a>
 
 ### javaProps.parseFile(path, [encoding]) ⇒ <code>Promise.&lt;Object&gt;</code>
+
 Parses a .properties file, constructing a corresponding JavaScript object.
 
-**Returns**: <code>Promise.&lt;Object&gt;</code> - The [Object](Object) corresponding to the given string  
+**Returns**: <code>Promise.&lt;Object&gt;</code> - The [Object](Object) corresponding to the given string
+
+| Param      | Type                                                                                  | Default           | Description                 |
+| ---------- | ------------------------------------------------------------------------------------- | ----------------- | --------------------------- |
+| path       | <code>String</code> \| <code>Buffer</code> \| <code>URL</code> \| <code>number</code> |                   | Filename or file descriptor |
+| [encoding] | <code>String</code>                                                                   | <code>utf8</code> | File encoding               |
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| path | <code>String</code> \| <code>Buffer</code> \| <code>URL</code> \| <code>number</code> |  | Filename or file descriptor |
-| [encoding] | <code>String</code> | <code>utf8</code> | File encoding |
+**Example**
 
-**Example**  
 ```js
-javaProps.parseFile('./foobar.properties').then((props) => {
-    console.log(props.foo + ' ' + props.bar);
-    // "Hello World"
-}).catch((err) => {
-    console.error(err);
-});
+javaProps
+    .parseFile('./foobar.properties')
+    .then((props) => {
+        console.log(props.foo + ' ' + props.bar);
+        // "Hello World"
+    })
+    .catch((err) => {
+        console.error(err);
+    });
 ```
-*- or with async/await -*
+
+_- or with async/await -_
+
 ```js
 async function fct() {
     try {
@@ -99,20 +109,23 @@ async function fct() {
     }
 }
 ```
+
 <a name="javaProps.stringify"></a>
 
 ### javaProps.stringify(props) ⇒ <code>String</code>
+
 Convert a JavaScript object to the corresponding .properties string.
 
-**Returns**: <code>String</code> - The .properties string corresponding to the given JavaScript object  
+**Returns**: <code>String</code> - The .properties string corresponding to the given JavaScript object
 
-| Param | Type | Description |
-| --- | --- | --- |
+| Param | Type                | Description                      |
+| ----- | ------------------- | -------------------------------- |
 | props | <code>Object</code> | The JavaScript object to convert |
 
-**Example**  
+**Example**
+
 ```js
-const str = javaProps.stringify({'foo': 'Hello', 'bar': 'World'});
+const str = javaProps.stringify({foo: 'Hello', bar: 'World'});
 console.log(str);
 // "foo: Hello\nbar: World\n"
 ```

jest.config.js

@@ -4,15 +4,10 @@ module.exports = {
             tsConfig: 'tsconfig.json',
         },
     },
-    moduleFileExtensions: [
-        'ts',
-        'js',
-    ],
+    moduleFileExtensions: ['ts', 'js'],
     transform: {
         '^.+\\.(ts|tsx)$': 'ts-jest',
     },
-    testMatch: [
-        '**/test/**/*.test.(ts|js)',
-    ],
+    testMatch: ['**/test/**/*.test.(ts|js)'],
     testEnvironment: 'node',
 };

package.json

@@ -25,6 +25,7 @@
     "build": "yarn run clean && yarn run build:ts",
     "build:ts": "tsc",
     "lint": "tslint -c ./tslint.json -p ./tsconfig.json",
+    "format": "prettier -w ./src ./test/**.ts *.md *.json *.js *.yml",
     "test": "jest --coverage --verbose",
     "test:watch": "yarn run test -- --watchAll",
     "release": "yarn run lint && yarn run build && np"

test/java-props.test.ts

@@ -15,7 +15,9 @@ const dataFiles = [
 describe('parse', () => {
     for (const file of dataFiles) {
         it('validate ' + file, async () => {
-            const res = JSON.parse(fs.readFileSync(__dirname + '/data/' + file.replace('.dos', '') + '-result.json', 'utf8'));
+            const res = JSON.parse(
+                fs.readFileSync(__dirname + '/data/' + file.replace('.dos', '') + '-result.json', 'utf8')
+            );
             const props = JavaProps.parse(fs.readFileSync(__dirname + '/data/' + file, 'utf8'));
             expect(props).toEqual(res);
         });
@@ -55,14 +57,14 @@ describe('stringify', () => {
 
     it('must handle spacings', async () => {
         expectConvertBack({' key': 'value'});
-        expectConvertBack({'key': ' value'});
+        expectConvertBack({key: ' value'});
         expectConvertBack({'key ': 'value'});
-        expectConvertBack({'key': 'value '});
+        expectConvertBack({key: 'value '});
         expectConvertBack({'  ke:y=  ': ' =  \\nval\\ue\n   '});
     });
 
     it('must skip non-own properties', async () => {
-        const obj = {'key': 'value'};
+        const obj = {key: 'value'};
         (Object.prototype as any).notAKey = 'x';
         expect(JavaProps.stringify(obj)).toBe('key: value\n');
     });
@@ -123,7 +125,9 @@ for (const isKey of [false, true]) {
             if (converts.hasOwnProperty(char)) {
                 const repl = converts[char];
                 it('must encode \\' + char, () => {
-                    expect(encodeLine('abc' + repl + 'def' + repl + 'ghi')).toBe('abc\\' + char + 'def\\' + char + 'ghi');
+                    expect(encodeLine('abc' + repl + 'def' + repl + 'ghi')).toBe(
+                        'abc\\' + char + 'def\\' + char + 'ghi'
+                    );
                 });
             }
         }

tsconfig.json

@@ -11,10 +11,7 @@
     "outDir": "dist",
     "baseUrl": ".",
     "paths": {
-      "*": [
-        "node_modules/*",
-        "src/types/*"
-      ]
+      "*": ["node_modules/*", "src/types/*"]
     }
   },
   "include": ["src/**/*.ts"]

tslint.json

@@ -5,22 +5,20 @@
     "array-type": [true, "array"],
     "ban-types": {
       "options": [
-        ["Object", "Avoid using the `Object` type. Did you mean `object`?"], [
+        ["Object", "Avoid using the `Object` type. Did you mean `object`?"],
+        [
           "Function",
           "Avoid using the `Function` type. Prefer a specific function type, like `() => void`, or use `ts.AnyFunction`."
-        ], ["Boolean", "Avoid using the `Boolean` type. Did you mean `boolean`?"],
+        ],
+        ["Boolean", "Avoid using the `Boolean` type. Did you mean `boolean`?"],
         ["Number", "Avoid using the `Number` type. Did you mean `number`?"],
         ["String", "Avoid using the `String` type. Did you mean `string`?"]
       ]
     },
     "class-name": true,
-    "comment-format": [
-      true, "check-space"
-    ],
+    "comment-format": [true, "check-space"],
     "curly": [true, "ignore-same-line"],
-    "indent": [
-      true, "spaces"
-    ],
+    "indent": [true, "spaces"],
     "interface-name": [true, "never-prefix"],
     "interface-over-type-literal": true,
     "jsdoc-format": true,
@@ -33,34 +31,30 @@
     "no-unnecessary-qualifier": true,
     "no-var-keyword": true,
     "object-literal-shorthand": true,
-    "one-line": [
-      true, "check-open-brace", "check-whitespace"
-    ],
+    "one-line": [true, "check-open-brace", "check-whitespace"],
     "prefer-const": true,
-    "quotemark": [
-      true, "single", "avoid-escape"
-    ],
+    "quotemark": [true, "single", "avoid-escape"],
     "semicolon": [true, "always", "ignore-bound-class-methods"],
     "space-within-parens": true,
     "triple-equals": true,
     "typedef-whitespace": [
-      true, {
+      true,
+      {
         "call-signature": "nospace",
         "index-signature": "nospace",
         "parameter": "nospace",
         "property-declaration": "nospace",
         "variable-declaration": "nospace"
-      }, {
+      },
+      {
         "call-signature": "onespace",
         "index-signature": "onespace",
         "parameter": "onespace",
         "property-declaration": "onespace",
         "variable-declaration": "onespace"
       }
     ],
-    "whitespace": [
-      true, "check-branch", "check-decl", "check-operator", "check-separator", "check-type"
-    ],
+    "whitespace": [true, "check-branch", "check-decl", "check-operator", "check-separator", "check-type"],
     // Config different from tslint:latest
     "no-implicit-dependencies": [true, "dev"],
     "object-literal-key-quotes": [true, "consistent-as-needed"],
@@ -105,4 +99,4 @@
     "object-literal-sort-keys": false,
     "one-variable-per-declaration": false
   }
-}
+}