From bd2b1d99b9132680451ae0969257468335bad844 Mon Sep 17 00:00:00 2001 From: Timothy Farrell Date: Wed, 22 Aug 2018 15:22:59 -0500 Subject: [PATCH] Upgrade Lerna and require prettier. Some format changes --- package.json | 3 ++- packages/frptools/README.md | 8 +++++--- packages/pouchdb-attachmentproxy/README.md | 8 ++++---- packages/pouchtype/README.md | 4 ++-- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/package.json b/package.json index 539d761..e0b07a4 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,8 @@ "chrome-launcher": "^0.10.2", "chrome-remote-interface": "^0.25.5", "husky": "1.0.0-rc.13", - "lerna": "2.0.0-beta.32" + "lerna": "3.1.4", + "prettier": "1.14.2" }, "scripts": { "check_code_format": "nodejs node_modules/prettier/bin-prettier.js --config ./prettier.config.js --list-different \"{.,{packages,bin}/**/!(dist)}/*.{js,json,md}\"", diff --git a/packages/frptools/README.md b/packages/frptools/README.md index a62f966..60102e1 100644 --- a/packages/frptools/README.md +++ b/packages/frptools/README.md @@ -6,8 +6,8 @@ and derived state. # [property](./src/property.js) A `property` is a simple value store that can report when its value changes. It is good for wrapping -external values passed into a component so compute types can depend on them and only recompute -when these values change. It can also be used to receive events such as _window.onresize_ to always +external values passed into a component so compute types can depend on them and only recompute when +these values change. It can also be used to receive events such as _window.onresize_ to always provide the current viewport size. ## Usage @@ -174,7 +174,9 @@ const getToken = stream( ### Read ```js -if (await getToken()) { /* do stuff with the token */ } +if (await getToken()) { + /* do stuff with the token */ +} ``` Call it to receive the stored value, recomputing if necessary. diff --git a/packages/pouchdb-attachmentproxy/README.md b/packages/pouchdb-attachmentproxy/README.md index a049121..b100ce1 100644 --- a/packages/pouchdb-attachmentproxy/README.md +++ b/packages/pouchdb-attachmentproxy/README.md @@ -7,10 +7,10 @@ metadata without having the raw data bogging down your PouchDB database. ## Overview Attachment Proxy works by intercepting attachments bound for the pouchdb backend and passing them to -a custom `save` function that will return a blob to be saved in the pouchdb document. The returned -blob should be a smaller *sentry* blob with just enough information needed to fetch the full version -that is being proxied. `stringToBlob` is provided to make this process easier for simple string -identifier cases. Alternatively, you can pass the original attachment through if you do not want it +a custom `save` function that will return a blob to be saved in the pouchdb document. The returned +blob should be a smaller _sentry_ blob with just enough information needed to fetch the full version +that is being proxied. `stringToBlob` is provided to make this process easier for simple string +identifier cases. Alternatively, you can pass the original attachment through if you do not want it to be proxied. When an attachment is requested, the document attached blob (returned from `save`) will be provided diff --git a/packages/pouchtype/README.md b/packages/pouchtype/README.md index d9bc899..0bbc456 100644 --- a/packages/pouchtype/README.md +++ b/packages/pouchtype/README.md @@ -131,7 +131,7 @@ const db = PDB('type_example'); export const Contact = new ContactHandler(db, 'contact'); const doc = await Contact.getOrCreate({ - name: "John Doe", - email: "jd@example.com" + name: 'John Doe', + email: 'jd@example.com' }); ```