From afacf01f96c92358e44c13f1eac5a95057ff4d51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=82=A3=E9=87=8C=E5=A5=BD=E8=84=8F=E4=B8=8D=E5=8F=AF?= =?UTF-8?q?=E4=BB=A5?= <453491931@qq.com> Date: Thu, 14 Apr 2022 20:08:24 +0800 Subject: [PATCH] docs(*): fix problems with sample code in documentation (#4572) --- packages/fetcher-base/README.md | 6 +++--- packages/modules-yaml/README.md | 2 +- packages/resolver-base/README.md | 2 +- packages/symlink-dependency/README.md | 1 - privatePackages/assert-project/README.md | 2 +- privatePackages/assert-store/README.md | 2 +- 6 files changed, 7 insertions(+), 8 deletions(-) diff --git a/packages/fetcher-base/README.md b/packages/fetcher-base/README.md index d6e3ec0b9ad..41829f3eac0 100644 --- a/packages/fetcher-base/README.md +++ b/packages/fetcher-base/README.md @@ -17,17 +17,17 @@ pnpm add @pnpm/fetcher-base Here's a template for a fetcher using types from `@pnpm/fetcher-base`: ```ts -import {Resolution} from '@pnpm/resolver-base' +import { Resolution } from '@pnpm/resolver-base' import { FetchOptions, FetchResult, } from '@pnpm/fetcher-base' -export async function ( +export async function demoFetcher ( resolution: Resolution, targetFolder: string, opts: FetchOptions, -): Promise +): Promise { // ... return { filesIndex, diff --git a/packages/modules-yaml/README.md b/packages/modules-yaml/README.md index 1b15811aa45..39349aca875 100644 --- a/packages/modules-yaml/README.md +++ b/packages/modules-yaml/README.md @@ -18,7 +18,7 @@ pnpm add @pnpm/modules-yaml import {write, read} from '@pnpm/modules-yaml' await write('node_modules', { - hoistedAliases: {} + hoistedAliases: {}, layoutVersion: 1, packageManager: 'pnpm@1.0.0', pendingBuilds: [], diff --git a/packages/resolver-base/README.md b/packages/resolver-base/README.md index dd054f9719c..6e36de58162 100644 --- a/packages/resolver-base/README.md +++ b/packages/resolver-base/README.md @@ -23,7 +23,7 @@ import { WantedDependency, } from '@pnpm/resolver-base' -export async function ( +export async function testResolver ( wantedDependency: WantedDependency, opts: ResolveOptions, ): Promise { diff --git a/packages/symlink-dependency/README.md b/packages/symlink-dependency/README.md index 4a1ad45c581..04cd9238d7e 100644 --- a/packages/symlink-dependency/README.md +++ b/packages/symlink-dependency/README.md @@ -15,7 +15,6 @@ import symlinkDependency from '@pnpm/symlink-dependency' await symlinkDependency('/home/src/foo', '/home/src/my-project/node_modules', 'foo') //> { reused: false } -} ``` ## License diff --git a/privatePackages/assert-project/README.md b/privatePackages/assert-project/README.md index 1a328db1490..a6c758e4eba 100644 --- a/privatePackages/assert-project/README.md +++ b/privatePackages/assert-project/README.md @@ -14,7 +14,7 @@ pnpm install -D @pnpm/assert-project import test = require('tape') import assertProject from '@pnpm/assert-project' -test('...', t => { +test('...', async t => { // ... const project = assertProject(t, pathToProject) diff --git a/privatePackages/assert-store/README.md b/privatePackages/assert-store/README.md index 820e84195b1..4a5967636e5 100644 --- a/privatePackages/assert-store/README.md +++ b/privatePackages/assert-store/README.md @@ -14,7 +14,7 @@ pnpm install -D @pnpm/assert-store import test = require('tape') import assertStore from '@pnpm/assert-store' -test('...', t => { +test('...', async t => { // ... const store = assertStore(t, pathToStore, encodedRegistryName)