Add Prettier

Author: tobyzerner

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{html,less,css,yml}]
+indent_size = 2

.prettierignore

@@ -0,0 +1,3 @@
+dist
+package-lock.json
+CHANGELOG.md

README.md

@@ -22,20 +22,22 @@ models.sync({
         id: '1',
         attributes: { name: 'Toby' },
         relationships: {
-            dog: { data: { type: 'dogs', id: '1' }}
-        }
+            dog: { data: { type: 'dogs', id: '1' } },
+        },
     },
-    included: [{
-        type: 'dogs',
-        id: '1',
-        attributes: { name: 'Rosie' }
-    }]
+    included: [
+        {
+            type: 'dogs',
+            id: '1',
+            attributes: { name: 'Rosie' },
+        },
+    ],
 });
 
 // Resource data is transformed into easy-to-consume models
 const human = models.find('humans', '1');
-human.name // Toby
-human.dog // { type: 'dogs', id: '1', name: 'Rosie' }
+human.name; // Toby
+human.dog; // { type: 'dogs', id: '1', name: 'Rosie' }
 ```
 
 ### Syncing JSON:API Data
@@ -54,7 +56,7 @@ You can also sync an individual resource using the `syncResource` method:
 const model = models.syncResource({
     type: 'users',
     id: '1',
-    attributes: { name: 'Toby' }
+    attributes: { name: 'Toby' },
 });
 ```
 
@@ -67,7 +69,7 @@ const model = models.find('users', '1');
 const model = models.find({ type: 'users', id: '1' });
 const models = models.find([
     { type: 'users', id: '1' },
-    { type: 'users', id: '2' }
+    { type: 'users', id: '2' },
 ]);
 ```
 
@@ -79,19 +81,19 @@ const models = models.findAll('users');
 
 ### Working with Models
 
-Models are a *superset* of JSON:API resource objects, meaning they contain all of the members you would expect (`type`, `id`, `attributes`, `relationships`, `meta`, `links`) plus some additional functionality.
+Models are a _superset_ of JSON:API resource objects, meaning they contain all of the members you would expect (`type`, `id`, `attributes`, `relationships`, `meta`, `links`) plus some additional functionality.
 
 Getters are automatically defined for all fields, allowing you to easily access their contents. Relationship fields are automatically resolved to their related models (if present within the store):
 
 ```ts
-model.name // => model.attributes.name
-model.dog // => models.find(model.relationships.dog.data)
+model.name; // => model.attributes.name
+model.dog; // => models.find(model.relationships.dog.data)
 ```
 
 To easily retrieve a resource identifier object for the model, the `identifier` method is available. This is useful when constructing relationships in JSON:API request documents.
 
 ```ts
-model.identifier() // { type: 'users', id: '1' }
+model.identifier(); // { type: 'users', id: '1' }
 ```
 
 ### Forgetting Models
@@ -112,7 +114,7 @@ import { Model } from 'json-api-models';
 class User extends Model<'users'> {
     public declare name: string;
     public declare age: number;
-    
+
     get firstName() {
         return this.name.split(' ')[0];
     }
@@ -133,9 +135,9 @@ You can define typecasts for attributes on your custom models:
 
 ```ts
 class User extends Model<'users'> {
-    declare public name: string;
-    declare public createdAt: Date;
-    
+    public declare name: string;
+    public declare createdAt: Date;
+
     protected casts = {
         createdAt: Date,
     };
@@ -158,16 +160,17 @@ function api(url, options = {}) {
         options.headers['Content-Type'] = 'application/vnd.api+json';
     }
 
-    return fetch('http://example.org/api/' + url, options)
-    	.then(async response => {
-        	if (response.status === 204) {
+    return fetch('http://example.org/api/' + url, options).then(
+        async (response) => {
+            if (response.status === 204) {
                 return { response };
             } else {
                 const document = await response.json();
                 const data = models.sync(document);
                 return { response, document, data };
             }
-    	});
+        }
+    );
 }
 
 api('users/1').then(({ data }) => {
@@ -185,9 +188,9 @@ api(user.links.self, {
     body: {
         data: {
             ...user.identifier(),
-            attributes: { name: 'Changed' }
-        }
-    }
+            attributes: { name: 'Changed' },
+        },
+    },
 });
 ```
 
@@ -199,7 +202,7 @@ Building query strings for your JSON:API requests can be tedious, and sometimes
 import { Query } from 'json-api-models';
 
 const query = new Query({
-    'include': 'foo',
+    include: 'foo',
     'fields[users]': 'name',
 });
 

jest.config.js

@@ -1,4 +1,4 @@
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+};

package.json

@@ -1,50 +1,54 @@
 {
-  "name": "json-api-models",
-  "description": "A lightweight layer for working with JSON:API data.",
-  "version": "0.1.0-beta.8",
-  "author": "Toby Zerner",
-  "license": "MIT",
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.es.js",
-  "unpkg": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "src",
-    "dist",
-    "README.md",
-    "!**/.DS_Store"
-  ],
-  "scripts": {
-    "test": "jest",
-    "build": "rollup -c",
-    "build:watch": "rollup -cw",
-    "release": "release-it --npm.tag=latest"
-  },
-  "devDependencies": {
-    "@release-it/keep-a-changelog": "^2.3.0",
-    "@rollup/plugin-typescript": "^8.2.5",
-    "@types/jest": "^26.0.20",
-    "jest": "^26.6.3",
-    "release-it": "^14.11.5",
-    "rollup": "^2.56.3",
-    "rollup-plugin-terser": "^7.0.2",
-    "ts-jest": "^26.4.4",
-    "tslib": "^2.3.1",
-    "typescript": "^4.6.3"
-  },
-  "release-it": {
-    "github": {
-      "release": true
+    "name": "json-api-models",
+    "description": "A lightweight layer for working with JSON:API data.",
+    "version": "0.1.0-beta.8",
+    "author": "Toby Zerner",
+    "license": "MIT",
+    "main": "./dist/index.cjs.js",
+    "module": "./dist/index.es.js",
+    "unpkg": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "files": [
+        "src",
+        "dist",
+        "README.md",
+        "!**/.DS_Store"
+    ],
+    "scripts": {
+        "test": "jest",
+        "build": "rollup -c",
+        "build:watch": "rollup -cw",
+        "release": "release-it --npm.tag=latest"
     },
-    "plugins": {
-      "@release-it/keep-a-changelog": {
-        "filename": "CHANGELOG.md",
-        "addUnreleased": true,
-        "addVersionUrl": true
-      }
+    "devDependencies": {
+        "@release-it/keep-a-changelog": "^2.3.0",
+        "@rollup/plugin-typescript": "^8.2.5",
+        "@types/jest": "^26.0.20",
+        "jest": "^26.6.3",
+        "prettier": "^2.6.2",
+        "release-it": "^14.11.5",
+        "rollup": "^2.56.3",
+        "rollup-plugin-terser": "^7.0.2",
+        "ts-jest": "^26.4.4",
+        "tslib": "^2.3.1",
+        "typescript": "^4.6.3"
     },
-    "hooks": {
-      "after:bump": "npm run build"
+    "release-it": {
+        "github": {
+            "release": true
+        },
+        "plugins": {
+            "@release-it/keep-a-changelog": {
+                "filename": "CHANGELOG.md",
+                "addUnreleased": true,
+                "addVersionUrl": true
+            }
+        },
+        "hooks": {
+            "after:bump": "npm run build"
+        }
+    },
+    "prettier": {
+        "singleQuote": true
     }
-  }
 }

rollup.config.js

@@ -3,24 +3,21 @@ import typescript from '@rollup/plugin-typescript';
 import { terser } from 'rollup-plugin-terser';
 
 export default {
-  input: 'src/index.ts',
-  output: [
-    {
-      file: pkg.main,
-      format: 'cjs'
-    },
-    {
-      file: pkg.module,
-      format: 'es'
-    },
-    {
-      file: pkg.unpkg,
-      format: 'iife',
-      name: 'JsonApiModels'
-    }
-  ],
-  plugins: [
-    typescript({ tsconfig: './tsconfig.json' }),
-    terser()
-  ]
+    input: 'src/index.ts',
+    output: [
+        {
+            file: pkg.main,
+            format: 'cjs',
+        },
+        {
+            file: pkg.module,
+            format: 'es',
+        },
+        {
+            file: pkg.unpkg,
+            format: 'iife',
+            name: 'JsonApiModels',
+        },
+    ],
+    plugins: [typescript({ tsconfig: './tsconfig.json' }), terser()],
 };