1
0
Fork 0

fix(build): reduce coverage requirements to match previous, fix typedef warnings

This commit is contained in:
Sean Sube 2022-10-08 16:07:43 -05:00
parent 55a3250ebc
commit 66a8fc3979
6 changed files with 72 additions and 4 deletions

View File

@ -4,7 +4,7 @@
"mainEntryPointFilePath": "<projectFolder>/out/src/index.d.ts", "mainEntryPointFilePath": "<projectFolder>/out/src/index.d.ts",
"apiReport": { "apiReport": {
"enabled": true, "enabled": true,
"reportFolder": "<projectFolder>/out/", "reportFolder": "<projectFolder>/docs/",
"reportTempFolder": "<projectFolder>/out/tmp/" "reportTempFolder": "<projectFolder>/out/tmp/"
}, },
"docModel": { "docModel": {

View File

@ -32,6 +32,10 @@ clean-deps: ## clean up the node_modules directory
COVER_ARGS := --all \ COVER_ARGS := --all \
--check-coverage \ --check-coverage \
--branches 75 \
--functions 75 \
--lines 75 \
--statements 75 \
--exclude ".eslintrc.js" \ --exclude ".eslintrc.js" \
--exclude "config/**" \ --exclude "config/**" \
--exclude "docs/**" \ --exclude "docs/**" \

View File

@ -6,7 +6,7 @@
> Warning: This API is now obsolete. > Warning: This API is now obsolete.
> >
> use `createSchema` unless the include type is needed, since it requires a number of callbacks > either use `createSchema` by itself, or `createInclude` and extend the schema yourself
> >
Extended schema with the include type, and auto-configuration of the include schema. Extended schema with the include type, and auto-configuration of the include schema.

View File

@ -6,6 +6,7 @@
> Warning: This API is now obsolete. > Warning: This API is now obsolete.
> >
> either use `createSchema` by itself, or `createInclude` and extend the schema yourself
> >
<b>Signature:</b> <b>Signature:</b>

View File

@ -0,0 +1,63 @@
## API Report File for "@apextoaster/js-yaml-schema"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { Maybe } from '@apextoaster/js-utils';
import { Schema } from 'js-yaml';
import { Type } from 'js-yaml';
// Warning: (ae-forgotten-export) The symbol "IncludeResult" needs to be exported by the entry point index.d.ts
//
// @public
export function createInclude(options: Readonly<IncludeOptions>): IncludeResult;
// @public @deprecated
export function createIncludeSchema(options: Readonly<IncludeSchemaOptions>): Schema;
// @public (undocumented)
export function createSchema(options: SchemaOptions): Schema;
// @public (undocumented)
export const envType: Type;
// @public
export interface IncludeOptions {
// (undocumented)
exists: (path: string) => boolean;
// (undocumented)
join: (...path: Array<string>) => string;
// Warning: (ae-forgotten-export) The symbol "IncludeReader" needs to be exported by the entry point index.d.ts
//
// (undocumented)
read: IncludeReader;
// (undocumented)
resolve: (path: string) => string;
// (undocumented)
schema: Maybe<Schema>;
}
// @public @deprecated (undocumented)
export interface IncludeSchemaOptions {
// (undocumented)
base?: Schema;
// (undocumented)
include: Readonly<Omit<IncludeOptions, 'schema'>>;
}
// @public (undocumented)
export const regexpType: Type;
// @public (undocumented)
export interface SchemaOptions {
// (undocumented)
base?: Schema;
}
// @public (undocumented)
export const streamType: Type;
// (No @packageDocumentation comment for this package)
```

View File

@ -28,7 +28,7 @@ export function createSchema(options: SchemaOptions): Schema {
/** /**
* @public * @public
* @deprecated * @deprecated either use `createSchema` by itself, or `createInclude` and extend the schema yourself
*/ */
export interface IncludeSchemaOptions { export interface IncludeSchemaOptions {
base?: Schema; base?: Schema;
@ -40,7 +40,7 @@ export interface IncludeSchemaOptions {
* of the include schema. * of the include schema.
* *
* @public * @public
* @deprecated use `createSchema` unless the include type is needed, since it requires a number of callbacks * @deprecated either use `createSchema` by itself, or `createInclude` and extend the schema yourself
*/ */
export function createIncludeSchema(options: Readonly<IncludeSchemaOptions>): Schema { export function createIncludeSchema(options: Readonly<IncludeSchemaOptions>): Schema {
const base = mustDefault(options.base, DEFAULT_SCHEMA); const base = mustDefault(options.base, DEFAULT_SCHEMA);