From c7209fcfad5ffbdd54175d740e4c9680f075d5f1 Mon Sep 17 00:00:00 2001 From: gcanti Date: Thu, 12 Dec 2019 18:51:16 +0100 Subject: [PATCH] upgrade to latest docs-ts --- .prettierrc | 5 + .vscode/settings.json | 3 +- docs/modules/At/Record.ts.md | 4 + docs/modules/At/Set.ts.md | 4 + docs/modules/Either.ts.md | 4 + docs/modules/Index/Array.ts.md | 4 + docs/modules/Index/NonEmptyArray.ts.md | 6 +- docs/modules/Index/Record.ts.md | 4 + docs/modules/index.ts.md | 4 + package-lock.json | 168 +++++++++++++------------ package.json | 2 +- src/At/Record.ts | 3 + src/At/Set.ts | 3 + src/Either.ts | 3 + src/Index/Array.ts | 3 + src/Index/NonEmptyArray.ts | 5 +- src/Index/Record.ts | 3 + src/index.ts | 3 + 18 files changed, 143 insertions(+), 88 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..31ba22d --- /dev/null +++ b/.prettierrc @@ -0,0 +1,5 @@ +{ + "semi": false, + "singleQuote": true, + "printWidth": 120 +} diff --git a/.vscode/settings.json b/.vscode/settings.json index 2ca2d99..97bef4c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,4 +1,3 @@ { - "typescript.tsdk": "./node_modules/typescript/lib", - "prettier.printWidth": 120 + "typescript.tsdk": "./node_modules/typescript/lib" } diff --git a/docs/modules/At/Record.ts.md b/docs/modules/At/Record.ts.md index 8e63414..427f719 100644 --- a/docs/modules/At/Record.ts.md +++ b/docs/modules/At/Record.ts.md @@ -4,6 +4,10 @@ nav_order: 1 parent: Modules --- +# Record overview + +Added in v1.7.0 + ---

Table of contents

diff --git a/docs/modules/At/Set.ts.md b/docs/modules/At/Set.ts.md index dbe1240..06f655e 100644 --- a/docs/modules/At/Set.ts.md +++ b/docs/modules/At/Set.ts.md @@ -4,6 +4,10 @@ nav_order: 2 parent: Modules --- +# Set overview + +Added in v1.2.0 + ---

Table of contents

diff --git a/docs/modules/Either.ts.md b/docs/modules/Either.ts.md index f677177..0ae70b3 100644 --- a/docs/modules/Either.ts.md +++ b/docs/modules/Either.ts.md @@ -4,6 +4,10 @@ nav_order: 3 parent: Modules --- +# Either overview + +Added in v1.6.0 + ---

Table of contents

diff --git a/docs/modules/Index/Array.ts.md b/docs/modules/Index/Array.ts.md index 7386366..383007b 100644 --- a/docs/modules/Index/Array.ts.md +++ b/docs/modules/Index/Array.ts.md @@ -4,6 +4,10 @@ nav_order: 5 parent: Modules --- +# Array overview + +Added in v1.2.0 + ---

Table of contents

diff --git a/docs/modules/Index/NonEmptyArray.ts.md b/docs/modules/Index/NonEmptyArray.ts.md index ac3b802..557030f 100644 --- a/docs/modules/Index/NonEmptyArray.ts.md +++ b/docs/modules/Index/NonEmptyArray.ts.md @@ -4,6 +4,10 @@ nav_order: 6 parent: Modules --- +# NonEmptyArray overview + +Added in v1.5.0 + ---

Table of contents

@@ -20,4 +24,4 @@ parent: Modules export function indexNonEmptyArray(): Index, number, A> { ... } ``` -Added in v1.2.0 +Added in v1.5.0 diff --git a/docs/modules/Index/Record.ts.md b/docs/modules/Index/Record.ts.md index 189c684..a908968 100644 --- a/docs/modules/Index/Record.ts.md +++ b/docs/modules/Index/Record.ts.md @@ -4,6 +4,10 @@ nav_order: 7 parent: Modules --- +# Record overview + +Added in v1.7.0 + ---

Table of contents

diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md index acdae7a..19be848 100644 --- a/docs/modules/index.ts.md +++ b/docs/modules/index.ts.md @@ -4,6 +4,10 @@ nav_order: 4 parent: Modules --- +# index overview + +Added in v1.0.0 + ---

Table of contents

diff --git a/package-lock.json b/package-lock.json index 19c78f7..94c1dae 100644 --- a/package-lock.json +++ b/package-lock.json @@ -456,31 +456,65 @@ } }, "@nodelib/fs.scandir": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.1.tgz", - "integrity": "sha512-NT/skIZjgotDSiXs0WqYhgcuBKhUMgfekCmCGtkUAiLqZdOnrdjmZr9wRl3ll64J9NF79uZ4fk16Dx0yMc/Xbg==", + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.3.tgz", + "integrity": "sha512-eGmwYQn3gxo4r7jdQnkrrN6bY478C3P+a/y72IJukF8LjB6ZHeB3c+Ehacj3sYeSmUXGlnA67/PmbM9CVwL7Dw==", "dev": true, "requires": { - "@nodelib/fs.stat": "2.0.1", + "@nodelib/fs.stat": "2.0.3", "run-parallel": "^1.1.9" } }, "@nodelib/fs.stat": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.1.tgz", - "integrity": "sha512-+RqhBlLn6YRBGOIoVYthsG0J9dfpO79eJyN7BYBkZJtfqrBwf2KK+rD/M/yjZR6WBmIhAgOV7S60eCgaSWtbFw==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.3.tgz", + "integrity": "sha512-bQBFruR2TAwoevBEd/NWMoAAtNGzTRgdrqnYCc7dhzfoNvqPzLyqlEQnzZ3kVnNrSp25iyxE00/3h2fqGAGArA==", "dev": true }, "@nodelib/fs.walk": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.2.tgz", - "integrity": "sha512-J/DR3+W12uCzAJkw7niXDcqcKBg6+5G5Q/ZpThpGNzAUz70eOR6RV4XnnSN01qHZiVl0eavoxJsBypQoKsV2QQ==", + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.4.tgz", + "integrity": "sha512-1V9XOY4rDW0rehzbrcqAmHnz8e7SKvX27gh8Gt2WgB0+pdzdiLV83p72kZPU+jvMbS1qU5mauP2iOvO8rhmurQ==", "dev": true, "requires": { - "@nodelib/fs.scandir": "2.1.1", + "@nodelib/fs.scandir": "2.1.3", "fastq": "^1.6.0" } }, + "@ts-morph/common": { + "version": "0.1.1", + "resolved": "https://registry.npmjs.org/@ts-morph/common/-/common-0.1.1.tgz", + "integrity": "sha512-8TLlC85CXgKNoTeqoXtrscPmKDbQCBfwZJ4hqli/QI4STa7sD2H6UqI9LSg8uBV5FYaD0QSdj/mtrCDrELvF+Q==", + "dev": true, + "requires": { + "@dsherret/to-absolute-glob": "^2.0.2", + "fs-extra": "^8.1.0", + "glob-parent": "^5.1.0", + "globby": "^10.0.1", + "is-negated-glob": "^1.0.0", + "multimatch": "^4.0.0", + "typescript": "~3.7.2" + }, + "dependencies": { + "fs-extra": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", + "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", + "dev": true, + "requires": { + "graceful-fs": "^4.2.0", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, + "graceful-fs": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.3.tgz", + "integrity": "sha512-a30VEBm4PEdx1dRB7MFK7BejejvCvBronbLjht+sHuGYj8PHs7M/5Z+rt5lw551vZ7yfTCj4Vuyy3mSJytDWRQ==", + "dev": true + } + } + }, "@types/babel__core": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.1.0.tgz", @@ -1281,9 +1315,9 @@ "dev": true }, "code-block-writer": { - "version": "9.4.1", - "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-9.4.1.tgz", - "integrity": "sha512-LHAB+DL4YZDcwK8y/kAxZ0Lf/ncwLh/Ux4cTVWbPwIdrf1gPxXiPcwpz8r8/KqXu1aD+Raz46EOxDjFlbyO6bA==", + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/code-block-writer/-/code-block-writer-10.1.0.tgz", + "integrity": "sha512-RG9hpXtWFeUWhuUav1YuP/vGcyncW+t90yJLk9fNZs1De2OuHTHKAKThVCokt29PYq5RoJ0QSZaIZ+rvPO23hA==", "dev": true }, "code-point-at": { @@ -1613,9 +1647,9 @@ } }, "docs-ts": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/docs-ts/-/docs-ts-0.2.1.tgz", - "integrity": "sha512-ewBCcx9t3VIKHTfN0e3CjL46nLSQ0BvusMvzh0fGn9tf3rEh5l9MgrTv0yoU5G/XNGEoO7MY6sJ185sz9aDVEg==", + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/docs-ts/-/docs-ts-0.3.0.tgz", + "integrity": "sha512-zDD2K7t5mRC5y8lgYXFht7QHUxVZUAp/WjG/3Q9sOfqn2xOS5XbxAWz4wuf2dH/hXjB4u0u22pQatHUtO7FQBQ==", "dev": true, "requires": { "chalk": "^2.4.2", @@ -1624,9 +1658,8 @@ "fs-extra": "^7.0.1", "glob": "^7.1.3", "markdown-toc": "^1.2.0", - "prettier": "^1.16.4", "rimraf": "^2.6.3", - "ts-morph": "^3.1.2", + "ts-morph": "^5.0.0", "ts-node": "^8.0.2" }, "dependencies": { @@ -1660,9 +1693,9 @@ } }, "fp-ts": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/fp-ts/-/fp-ts-2.0.3.tgz", - "integrity": "sha512-b/WPo5AVPDYbdye/AGOMST/tqudtgbpMjm3TJGkd36ROihD67UEKFeUH83V3iSdrIG4wwoFsd6lLpjtpek1oVw==", + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/fp-ts/-/fp-ts-2.3.0.tgz", + "integrity": "sha512-Sfwvnsg2VHIdc/bwrFR9ym2QyZz7HZICBL2CWNRqDm7Alflf0oXIIL4nP7L75y2b+so0uupx1/nOPEBYJTxWQw==", "dev": true }, "fs-extra": { @@ -1676,12 +1709,6 @@ "universalify": "^0.1.0" } }, - "prettier": { - "version": "1.18.2", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.18.2.tgz", - "integrity": "sha512-OeHeMc0JhFE9idD4ZdtNibzY0+TPHSpSSb9h8FqtP+YnoZZ1sl8Vc9b1sasjfymH3SonAF4QcA2+mzHPhMvIiw==", - "dev": true - }, "supports-color": { "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", @@ -2058,16 +2085,15 @@ "dev": true }, "fast-glob": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.0.4.tgz", - "integrity": "sha512-wkIbV6qg37xTJwqSsdnIphL1e+LaGz4AIQqr00mIubMaEhv1/HEmJ0uuCGZRNRUkZZmOB5mJKO0ZUTVq+SxMQg==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.1.1.tgz", + "integrity": "sha512-nTCREpBY8w8r+boyFYAx21iL6faSsQynliPHM4Uf56SbkyohCNxpVPEH9xrF5TXKy+IsjkPUHDKiUkzBVRXn9g==", "dev": true, "requires": { - "@nodelib/fs.stat": "^2.0.1", - "@nodelib/fs.walk": "^1.2.1", - "glob-parent": "^5.0.0", - "is-glob": "^4.0.1", - "merge2": "^1.2.3", + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.0", + "merge2": "^1.3.0", "micromatch": "^4.0.2" }, "dependencies": { @@ -2284,9 +2310,9 @@ } }, "glob-parent": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.0.0.tgz", - "integrity": "sha512-Z2RwiujPRGluePM6j699ktJYxmPpJKCfpGA13jz2hmFZC7gKetzrWvg5KN3+OsIFmydGyZ1AVwERCq1w/ZZwRg==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.0.tgz", + "integrity": "sha512-qjtRgnIVmOfnKUE3NJAQEdk+lKrxfw8t5ke7SXtfMTHcjsBfOfWXCQfdb30zfDoZQ2IRSIiidmjtbHZPZ++Ihw==", "dev": true, "requires": { "is-glob": "^4.0.1" @@ -2368,9 +2394,9 @@ } }, "handlebars": { - "version": "4.5.1", - "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.5.1.tgz", - "integrity": "sha512-C29UoFzHe9yM61lOsIlCE5/mQVGrnIOrOq7maQl76L7tYPCgC1og0Ajt6uWnX4ZTxBPnjw+CUvawphwCfJgUnA==", + "version": "4.5.3", + "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.5.3.tgz", + "integrity": "sha512-3yPecJoJHK/4c6aZhSvxOyG4vJKDshV36VHp0iVCDVh7o9w2vwi3NSnL2MMPj3YdduqaBcu7cGbggJQM0br9xA==", "dev": true, "requires": { "neo-async": "^2.6.0", @@ -2535,9 +2561,9 @@ } }, "ignore": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.2.tgz", - "integrity": "sha512-vdqWBp7MyzdmHkkRWV5nY+PfGRbYbahfuvsBCh277tq+w9zyNi7h5CYJCK0kmzti9kU+O/cB7sE8HvKv6aXAKQ==", + "version": "5.1.4", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.4.tgz", + "integrity": "sha512-MzbUSahkTW1u7JpKKjY7LCARd1fU5W2rLdxlM4kdkayuCwZImjkpluF9CM1aLewYJguPDqewLam18Y6AU69A8A==", "dev": true }, "import-local": { @@ -3795,9 +3821,9 @@ } }, "merge2": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.2.4.tgz", - "integrity": "sha512-FYE8xI+6pjFOhokZu0We3S5NKCirLbCzSh2Usf3qEyr4X8U+0jNg9P8RZ4qz+V2UoECLVwSyzU3LxXBaLGtD3A==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.3.0.tgz", + "integrity": "sha512-2j4DAdlBOkiSZIsaXk4mTE3sRS02yBHAtfy127xRV3bQUFqXkjHCHLW6Scv7DwNRbIWNHH8zpnz9zMaKXIdvYw==", "dev": true }, "micromatch": { @@ -4387,9 +4413,9 @@ "dev": true }, "picomatch": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.0.7.tgz", - "integrity": "sha512-oLHIdio3tZ0qH76NybpeneBhYVj0QFTfXEFTc/B3zKQspYfYYkWYgFsmzo+4kvId/bQRcNkVeguI3y+CD22BtA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.1.1.tgz", + "integrity": "sha512-OYMyqkKzK7blWO/+XZYP6w8hH0LDvkBvdvKukti+7kqYFCiEAk+gI3DWnryapc0Dau05ugGTy0foQ6mqn4AHYA==", "dev": true }, "pify": { @@ -5392,38 +5418,14 @@ } }, "ts-morph": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-3.1.3.tgz", - "integrity": "sha512-CwjgyJTtd3f8vBi7Vr0IOgdOY6Wi/Tq0MhieXOE2B5ns5WWRD7BwMNHtv+ZufKI/S2U/lMrh+Q3bOauE4tsv2g==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ts-morph/-/ts-morph-5.0.0.tgz", + "integrity": "sha512-VP5dFnOzmlsDkSyuGczgVNtyJdYXMxFqMO2Rb0pIeni0o0Cy/nDljETBWhJs4FI4DIWv7Ftq69kgZO8p8w6LCw==", "dev": true, "requires": { "@dsherret/to-absolute-glob": "^2.0.2", - "code-block-writer": "9.4.1", - "fs-extra": "^8.1.0", - "glob-parent": "^5.0.0", - "globby": "^10.0.1", - "is-negated-glob": "^1.0.0", - "multimatch": "^4.0.0", - "typescript": "^3.0.1" - }, - "dependencies": { - "fs-extra": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz", - "integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==", - "dev": true, - "requires": { - "graceful-fs": "^4.2.0", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" - } - }, - "graceful-fs": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.0.tgz", - "integrity": "sha512-jpSvDPV4Cq/bgtpndIWbI5hmYxhQGHPC4d4cqBPb4DLniCfhJokdXhwhaDuLBGLQdvvRum/UiX6ECVIPvDXqdg==", - "dev": true - } + "@ts-morph/common": "~0.1.0", + "code-block-writer": "^10.0.0" } }, "ts-node": { @@ -5548,9 +5550,9 @@ "dev": true }, "uglify-js": { - "version": "3.6.8", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.6.8.tgz", - "integrity": "sha512-XhHJ3S3ZyMwP8kY1Gkugqx3CJh2C3O0y8NPiSxtm1tyD/pktLAkFZsFGpuNfTZddKDQ/bbDBLAd2YyA1pbi8HQ==", + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.7.2.tgz", + "integrity": "sha512-uhRwZcANNWVLrxLfNFEdltoPNhECUR3lc+UdJoG9CBpMcSnKyWA94tc3eAujB1GcMY5Uwq8ZMp4qWpxWYDQmaA==", "dev": true, "optional": true, "requires": { diff --git a/package.json b/package.json index f8acc72..fd5f94f 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "devDependencies": { "@types/jest": "22.2.2", "@types/node": "7.0.4", - "docs-ts": "^0.2.1", + "docs-ts": "^0.3.0", "dtslint": "github:gcanti/dtslint", "fp-ts": "^2.0.0", "jest": "^24.3.0", diff --git a/src/At/Record.ts b/src/At/Record.ts index bdcd45e..c886821 100644 --- a/src/At/Record.ts +++ b/src/At/Record.ts @@ -1,3 +1,6 @@ +/** + * @since 1.7.0 + */ import { At, Lens } from '../index' import { Option, isNone } from 'fp-ts/lib/Option' import * as R from 'fp-ts/lib/Record' diff --git a/src/At/Set.ts b/src/At/Set.ts index 2b49e1f..861738d 100644 --- a/src/At/Set.ts +++ b/src/At/Set.ts @@ -1,3 +1,6 @@ +/** + * @since 1.2.0 + */ import { At, Lens } from '../index' import { Eq } from 'fp-ts/lib/Eq' import * as S from 'fp-ts/lib/Set' diff --git a/src/Either.ts b/src/Either.ts index 35c99d8..1ffa3ef 100644 --- a/src/Either.ts +++ b/src/Either.ts @@ -1,3 +1,6 @@ +/** + * @since 1.6.0 + */ import { Either, right, left, fold } from 'fp-ts/lib/Either' import { fromEither, none, some } from 'fp-ts/lib/Option' import { Prism } from '.' diff --git a/src/Index/Array.ts b/src/Index/Array.ts index 756108d..d5cd8fe 100644 --- a/src/Index/Array.ts +++ b/src/Index/Array.ts @@ -1,3 +1,6 @@ +/** + * @since 1.2.0 + */ import { Index, Optional } from '../index' import { lookup, updateAt } from 'fp-ts/lib/Array' import { isNone } from 'fp-ts/lib/Option' diff --git a/src/Index/NonEmptyArray.ts b/src/Index/NonEmptyArray.ts index 8e7c47e..1b0d4eb 100644 --- a/src/Index/NonEmptyArray.ts +++ b/src/Index/NonEmptyArray.ts @@ -1,10 +1,13 @@ +/** + * @since 1.5.0 + */ import { Index, Optional } from '../index' import { NonEmptyArray, updateAt } from 'fp-ts/lib/NonEmptyArray' import { lookup } from 'fp-ts/lib/Array' import { isNone } from 'fp-ts/lib/Option' /** - * @since 1.2.0 + * @since 1.5.0 */ export function indexNonEmptyArray(): Index, number, A> { return new Index( diff --git a/src/Index/Record.ts b/src/Index/Record.ts index 75a5cd5..19ffa38 100644 --- a/src/Index/Record.ts +++ b/src/Index/Record.ts @@ -1,3 +1,6 @@ +/** + * @since 1.7.0 + */ import { Index } from '../index' import { atRecord } from '../At/Record' diff --git a/src/index.ts b/src/index.ts index b885fcb..bfdf4fe 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,3 +1,6 @@ +/** + * @since 1.0.0 + */ import { HKT, URIS, URIS2, URIS3, Kind3, Kind2, Kind } from 'fp-ts/lib/HKT' import { Monoid, monoidAll, monoidAny } from 'fp-ts/lib/Monoid' import { Applicative, Applicative1, Applicative2, Applicative3, Applicative2C } from 'fp-ts/lib/Applicative'