From bbf897d05ab1d001aedd87802ebb450fb5dd83b2 Mon Sep 17 00:00:00 2001 From: NotWearingPants <26556598+NotWearingPants@users.noreply.github.com> Date: Mon, 8 Aug 2022 19:48:42 +0300 Subject: [PATCH] docs: fix formatting in packages/core/types/README (#3292) * docs: fix formatting in packages/core/types/README * format Co-authored-by: Juan Picado --- packages/core/types/README.md | 43 +++++++++++++++-------------------- 1 file changed, 18 insertions(+), 25 deletions(-) diff --git a/packages/core/types/README.md b/packages/core/types/README.md index ecc452c30..cf4bc25cb 100644 --- a/packages/core/types/README.md +++ b/packages/core/types/README.md @@ -1,42 +1,35 @@ -# Typescript types for Verdaccio +# TypeScript types for Verdaccio -Typescript definitions for verdaccio plugins and internal code +TypeScript definitions for Verdaccio plugins and internal code. -# Typescript +# TypeScript For usage with the library, the `tsconfig.json` should looks like this. -``` -//tsconfig.json +```json5 +// tsconfig.json { - "compilerOptions": { - "target": "esnext", - "module": "commonjs", - "declaration": true, - "noImplicitAny": false, - "strict": true, - "outDir": "lib", - "allowSyntheticDefaultImports": true, - "esModuleInterop": true, - "typeRoots": [ - "./node_modules/@verdaccio/types/lib/verdaccio", - "./node_modules/@types" - ] + compilerOptions: { + target: 'esnext', + module: 'commonjs', + declaration: true, + noImplicitAny: false, + strict: true, + outDir: 'lib', + allowSyntheticDefaultImports: true, + esModuleInterop: true, + typeRoots: ['./node_modules/@verdaccio/types/lib/verdaccio', './node_modules/@types'], }, - "include": [ - "src/*.ts", - "types/*.d.ts" - ] + include: ['src/*.ts', 'types/*.d.ts'], } ``` ### Imports -``` +```ts import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types'; - class LocalData implements ILocalData { - +class LocalData implements ILocalData { path: string; logger: Logger; data: LocalStorage;