feat(docs-readme): add overview to readme #3635

rwaskiewicz · 2022-09-29T19:34:50Z

Pull request checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)
Build (npm run build) was run locally and any changes were pushed
Unit tests (npm test) were run locally and passed
E2E Tests (npm run test.karma.prod) were run locally and passed
Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

What is the current behavior?

the component-level JSDoc is not taken into account when we generate MD for a component

/**
 * This is my component
 * @slot someSlot - Slot desc
 * @part partName - Part desc
 */
@Component({ ... })
export class MyComponent {...}

Running npm run build with MD docs enabled generates a MD file that starts with:

# my-component



<!-- Auto Generated Below -->

GitHub Issue Number: N/A

What is the new behavior?

this commit adds an 'Overview' section to the generated README.md file
for a component. this implementation is simple (and arguably naive)
intentionally. there is quite a bit that folks could do in the context
of a JSDoc. rather than attempting to capture every use case and
potentially overcomplicate our solution, we start simple and can iterate
from there.

with the example above, we now generate something like:

# my-component



<!-- Auto Generated Below -->


## Overview

This is my component

Does this introduce a breaking change?

Yes
No - however, the output of running npm build will change here

Testing

In addition to the manual testing described above, unit tests have been written for the overview generation

Other information

github-actions · 2022-09-29T19:36:53Z

`--strictNullChecks` error report

Typechecking with --strictNullChecks resulted in 2159 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files

Path	Error Count
src/compiler/config/test/validate-dev-server.spec.ts	45
src/compiler/config/test/validate-output-www.spec.ts	40
src/screenshot/connector-base.ts	40
src/dev-server/index.ts	38
src/mock-doc/serialize-node.ts	36
src/compiler/sys/tests/in-memory-fs.spec.ts	34
src/screenshot/screenshot-compare.ts	33
src/compiler/transformers/test/parse-props.spec.ts	32
src/dev-server/server-process.ts	32
src/runtime/vdom/vdom-render.ts	31
src/compiler/sys/typescript/typescript-config.ts	28
src/compiler/build/build-stats.ts	27
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts	26
src/compiler/prerender/prerender-main.ts	25
src/sys/node/test/worker-manager.spec.ts	24
src/compiler/style/test/optimize-css.spec.ts	23
src/compiler/sys/in-memory-fs.ts	23
src/runtime/update-component.ts	23
src/compiler/config/test/validate-paths.spec.ts	22
src/compiler/bundle/dev-module.ts	21

Our most common errors

Typescript Error Code	Count	Error messages
TS2532	647	Error messages Object is possibly 'undefined'.
TS2345	616	Error messages Argument of type 'CompilerSystem \| undefined' is not assignable to parameter of type 'CompilerSystem'. Type 'undefined' is not assignable to type 'CompilerSystem'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'Promise<(() => void) \| null>' is not assignable to parameter of type 'Promise<() => void>'. Argument of type 'null' is not assignable to parameter of type 'BuildResultsComponentGraph'. Argument of type 'DevServerConfig \| undefined' is not assignable to parameter of type 'StencilDevServerConfig'. Type 'undefined' is not assignable to type 'StencilDevServerConfig'. Argument of type 'Promise<(() => void) \| null>' is not assignable to parameter of type 'Promise<() => void>'. Type '(() => void) \| null' is not assignable to type '() => void'. Type 'null' is not assignable to type '() => void'. Argument of type 'ComponentRuntimeHostListener[] \| undefined' is not assignable to parameter of type 'ComponentRuntimeHostListener[]'. Type 'undefined' is not assignable to type 'ComponentRuntimeHostListener[]'. Argument of type 'HTMLScriptElement \| null \| undefined' is not assignable to parameter of type 'HTMLScriptElement'. Type 'undefined' is not assignable to type 'HTMLScriptElement'. Argument of type 'string \| null' is not assignable to parameter of type 'string'. Type 'null' is not assignable to type 'string'. Argument of type 'Logger \| undefined' is not assignable to parameter of type 'Logger'. Type 'undefined' is not assignable to type 'Logger'. Argument of type 'string[] \| undefined' is not assignable to parameter of type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. Argument of type 'string' is not assignable to parameter of type 'never'. Argument of type 'Diagnostic[] \| undefined' is not assignable to parameter of type 'readonly Diagnostic[]'. Type 'undefined' is not assignable to type 'readonly Diagnostic[]'. Argument of type 'boolean \| undefined' is not assignable to parameter of type 'boolean'. Argument of type 'BuildConditionals \| undefined' is not assignable to parameter of type 'BuildConditionals'. Type 'undefined' is not assignable to type 'BuildConditionals'. Argument of type 'Diagnostic[] \| undefined' is not assignable to parameter of type 'Diagnostic[]'. Type 'undefined' is not assignable to type 'Diagnostic[]'. Argument of type 'WorkerMeta \| undefined' is not assignable to parameter of type 'WorkerMeta'. Type 'undefined' is not assignable to type 'WorkerMeta'. Argument of type 'CopyTask[] \| undefined' is not assignable to parameter of type 'boolean \| CopyTask[]'. Argument of type 'CopyTask[] \| undefined' is not assignable to parameter of type 'boolean \| CopyTask[]'. Type 'undefined' is not assignable to type 'boolean \| CopyTask[]'. Argument of type 'OutputTargetWww' is not assignable to parameter of type 'never'. Argument of type 'string \| null \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'Set<string \| null>' is not assignable to parameter of type 'Set'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Argument of type 'Set<string \| null>' is not assignable to parameter of type 'Set'. Argument of type 'RollupConfig \| undefined' is not assignable to parameter of type 'RollupConfig'. Type 'undefined' is not assignable to type 'RollupConfig'. Argument of type '(string[] \| undefined)[]' is not assignable to parameter of type 'string[][]'. Type 'string[] \| undefined' is not assignable to type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. Argument of type 'ComponentCompilerMeta \| undefined' is not assignable to parameter of type 'ComponentCompilerMeta'. Type 'undefined' is not assignable to type 'ComponentCompilerMeta'. Argument of type 'true \| Object \| undefined' is not assignable to parameter of type 'boolean \| Object \| null'. Type 'undefined' is not assignable to type 'boolean \| Object \| null'. Argument of type 'SourceTarget \| undefined' is not assignable to parameter of type 'SourceTarget'. Type 'undefined' is not assignable to type 'SourceTarget'. Argument of type 'boolean \| undefined' is not assignable to parameter of type 'boolean'. Type 'undefined' is not assignable to type 'boolean'. Argument of type '(string \| undefined)[]' is not assignable to parameter of type 'string[]'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type '(string \| undefined)[]' is not assignable to parameter of type 'string[]'. Argument of type 'RollupSourceMap \| undefined' is not assignable to parameter of type 'SourceMap'. Type 'undefined' is not assignable to type 'SourceMap'. Argument of type 'EntryModule \| undefined' is not assignable to parameter of type 'EntryModule'. Type 'undefined' is not assignable to type 'EntryModule'. Argument of type '(Module \| undefined)[]' is not assignable to parameter of type 'Module[]'. Type 'Module \| undefined' is not assignable to type 'Module'. Type 'undefined' is not assignable to type 'Module'. Argument of type 'Document \| null' is not assignable to parameter of type 'Document'. Type 'null' is not assignable to type 'Document'. Argument of type 'Document \| null' is not assignable to parameter of type 'Node \| MockNode'. Type 'null' is not assignable to type 'Node \| MockNode'. Argument of type 'HydrateAnchorElement' is not assignable to parameter of type '{ [attrName: string]: string; }'. 'string' index signatures are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'URL \| null' is not assignable to parameter of type 'URL'. Type 'null' is not assignable to type 'URL'. Argument of type 'number \| undefined' is not assignable to parameter of type 'number'. Type 'undefined' is not assignable to type 'number'. Argument of type 'SitemapXmpResults \| null' is not assignable to parameter of type 'SitemapXmpResults'. Type 'null' is not assignable to type 'SitemapXmpResults'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| URL'. Argument of type 'Map<string, string[]> \| undefined' is not assignable to parameter of type 'Map<string, string[]>'. Type 'undefined' is not assignable to type 'Map<string, string[]>'. Argument of type 'undefined' is not assignable to parameter of type 'string'. Argument of type 'ServiceWorkerConfig \| undefined' is not assignable to parameter of type 'ServiceWorkerConfig'. Type 'undefined' is not assignable to type 'ServiceWorkerConfig'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| URL'. Type 'undefined' is not assignable to type 'string \| URL'. Argument of type 'CssNode[] \| null \| undefined' is not assignable to parameter of type 'void \| CssNode[]'. Argument of type 'CssNode[] \| null \| undefined' is not assignable to parameter of type 'void \| CssNode[]'. Type 'null' is not assignable to type 'void \| CssNode[]'. Argument of type 'null' is not assignable to parameter of type 'string'. Argument of type 'CompilerSystemCreateDirectoryOptions \| undefined' is not assignable to parameter of type 'CompilerSystemCreateDirectoryOptions'. Type 'undefined' is not assignable to type 'CompilerSystemCreateDirectoryOptions'. Argument of type 'null' is not assignable to parameter of type 'CompilerFileWatcherEvent'. Argument of type 'null' is not assignable to parameter of type '{ access: (filePath: string) => Promise; accessSync: (filePath: string) => boolean; cancelDeleteDirectoriesFromDisk: (dirPaths: string[]) => void; cancelDeleteFilesFromDisk: (filePaths: string[]) => void; ... 17 more ...; writeFiles: (files: { ...; } \| Map<...>, opts?: FsWriteOptions \| undefined) => Promise...'. Argument of type 'undefined' is not assignable to parameter of type 'TypeChecker'. Argument of type 'CollectionBundleManifest[] \| undefined' is not assignable to parameter of type 'any[]'. Type 'undefined' is not assignable to type 'any[]'. Argument of type 'Module \| undefined' is not assignable to parameter of type 'Module'. Type 'undefined' is not assignable to type 'Module'. Argument of type 'NodeArray \| undefined' is not assignable to parameter of type 'NodeArray \| HeritageClause[]'. Type 'undefined' is not assignable to type 'NodeArray \| HeritageClause[]'. Argument of type 'Block \| undefined' is not assignable to parameter of type 'Block'. Type 'undefined' is not assignable to type 'Block'. Argument of type 'undefined' is not assignable to parameter of type 'readonly ParameterDeclaration[]'. Argument of type 'Expression \| undefined' is not assignable to parameter of type 'Expression'. Type 'undefined' is not assignable to type 'Expression'. Argument of type 'Symbol \| undefined' is not assignable to parameter of type 'Symbol'. Type 'undefined' is not assignable to type 'Symbol'. Argument of type 'TypeNode \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type '(PropertyAssignment \| null)[]' is not assignable to parameter of type 'readonly ObjectLiteralElementLike[]'. Type 'PropertyAssignment \| null' is not assignable to type 'ObjectLiteralElementLike'. Type 'null' is not assignable to type 'ObjectLiteralElementLike'. Argument of type 'Signature \| undefined' is not assignable to parameter of type 'Signature'. Type 'undefined' is not assignable to type 'Signature'. Argument of type '(PropertyAssignment \| null)[]' is not assignable to parameter of type 'readonly ObjectLiteralElementLike[]'. Argument of type 'Identifier \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'undefined' is not assignable to parameter of type 'readonly ClassElement[]'. Argument of type 'Config \| null \| undefined' is not assignable to parameter of type 'Config'. Type 'undefined' is not assignable to type 'Config'. Argument of type 'null' is not assignable to parameter of type 'CollectionCompilerMeta'. Argument of type 'PropertyName \| undefined' is not assignable to parameter of type 'PropertyName'. Type 'undefined' is not assignable to type 'PropertyName'. Argument of type 'NamedExportBindings \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'Declaration \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'Identifier \| undefined' is not assignable to parameter of type 'string \| BindingName'. Type 'undefined' is not assignable to type 'string \| BindingName'. Argument of type 'ScriptTarget \| undefined' is not assignable to parameter of type 'ScriptTarget \| CreateSourceFileOptions'. Type 'undefined' is not assignable to type 'ScriptTarget \| CreateSourceFileOptions'. Argument of type 'Diagnostic' is not assignable to parameter of type 'DiagnosticWithLocation'. Types of property 'file' are incompatible. Type 'SourceFile \| undefined' is not assignable to type 'SourceFile'. Type 'undefined' is not assignable to type 'SourceFile'. Argument of type '(...pathSegments: string[]) => string \| undefined' is not assignable to parameter of type '(...args: string[]) => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'OpenInEditorCallback \| undefined' is not assignable to parameter of type 'OpenInEditorCallback'. Type 'undefined' is not assignable to type 'OpenInEditorCallback'. Argument of type 'CompilerWatcher \| undefined' is not assignable to parameter of type 'CompilerWatcher'. Type 'undefined' is not assignable to type 'CompilerWatcher'. Argument of type '{ editor: string \| undefined; }' is not assignable to parameter of type 'OpenInEditorOptions'. Types of property 'editor' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'string \| undefined' is not assignable to parameter of type 'PathLike'. Argument of type 'DevServerConfig \| undefined' is not assignable to parameter of type 'DevServerConfig'. Type 'undefined' is not assignable to type 'DevServerConfig'. Argument of type 'CompilerBuildResults \| undefined' is not assignable to parameter of type 'CompilerBuildResults'. Type 'undefined' is not assignable to type 'CompilerBuildResults'. Argument of type 'Window \| undefined' is not assignable to parameter of type 'Window'. Type 'undefined' is not assignable to type 'Window'. Argument of type 'SerializeDocumentOptions \| undefined' is not assignable to parameter of type 'HydrateDocumentOptions'. Type 'undefined' is not assignable to type 'HydrateDocumentOptions'. Argument of type 'HydrateDocumentOptions \| undefined' is not assignable to parameter of type 'HydrateDocumentOptions'. Type 'undefined' is not assignable to type 'HydrateDocumentOptions'. Argument of type 'MockNode \| null' is not assignable to parameter of type 'MockNode'. Type 'null' is not assignable to type 'MockNode'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| null'. Type 'undefined' is not assignable to type 'string \| null'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| null'. Argument of type 'ShadowRoot \| null' is not assignable to parameter of type 'Node'. Type 'null' is not assignable to type 'Node'. Argument of type 'MockElement' is not assignable to parameter of type 'MockHTMLElement'. Types of property 'namespaceURI' are incompatible. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Argument of type 'null' is not assignable to parameter of type 'string \| Node'. Argument of type 'null' is not assignable to parameter of type 'string \| boolean \| undefined'. Argument of type '(Window & typeof globalThis) \| null' is not assignable to parameter of type 'Window'. Type 'null' is not assignable to type 'Window'. Argument of type 'string \| null \| undefined' is not assignable to parameter of type 'string \| undefined'. Argument of type 'HostRef \| undefined' is not assignable to parameter of type 'HostRef'. Type 'undefined' is not assignable to type 'HostRef'. Argument of type 'this' is not assignable to parameter of type 'HostElement'. Type 'HostElement' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/declarations/stencil-private").HostElement'. The types returned by 'componentOnReady()' are incompatible between these types. Type 'Promise \| undefined' is not assignable to type 'Promise'. Type 'undefined' is not assignable to type 'Promise'. Argument of type 'this' is not assignable to parameter of type 'HostElement'. Argument of type 'string \| null' is not assignable to parameter of type 'string \| undefined'. Argument of type 'PropertyDescriptor \| undefined' is not assignable to parameter of type 'PropertyDescriptor & ThisType'. Type 'undefined' is not assignable to type 'PropertyDescriptor & ThisType'. Type 'undefined' is not assignable to type 'PropertyDescriptor'. Argument of type 'HTMLElement \| undefined' is not assignable to parameter of type 'HTMLElement'. Type 'undefined' is not assignable to type 'HTMLElement'. Argument of type 'HostElement \| undefined' is not assignable to parameter of type 'HostElement'. Type 'undefined' is not assignable to type 'HostElement'. Argument of type 'HostElement \| undefined' is not assignable to parameter of type 'EventTarget'. Type 'undefined' is not assignable to type 'EventTarget'. Argument of type 'HostElement \| undefined' is not assignable to parameter of type 'Element'. Type 'undefined' is not assignable to type 'Element'. Argument of type 'VNode[] \| undefined' is not assignable to parameter of type 'VNode[]'. Type 'undefined' is not assignable to type 'VNode[]'. Argument of type 'null \| undefined' is not assignable to parameter of type 'ChildType'. Type 'undefined' is not assignable to type 'ChildType'. Argument of type 'VNode \| null' is not assignable to parameter of type 'ChildType'. Type 'null' is not assignable to type 'ChildType'. Argument of type 'VNode \| undefined' is not assignable to parameter of type 'ChildType'. Type 'undefined' is not assignable to type 'ChildType'. Argument of type 'VNode \| null \| undefined' is not assignable to parameter of type 'ChildType'. Type 'undefined' is not assignable to type 'ChildType'. Argument of type 'null \| undefined' is not assignable to parameter of type 'ChildType'. Argument of type 'RenderNode \| undefined' is not assignable to parameter of type 'Node \| null'. Type 'undefined' is not assignable to type 'Node \| null'. Argument of type 'VNode \| undefined' is not assignable to parameter of type 'VNode'. Type 'undefined' is not assignable to type 'VNode'. Argument of type 'null' is not assignable to parameter of type 'VNode'. Argument of type 'RenderNode \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'null' is not assignable to parameter of type 'RenderNode'. Argument of type 'ScreenshotDiff \| undefined' is not assignable to parameter of type 'ScreenshotDiff'. Type 'undefined' is not assignable to type 'ScreenshotDiff'. Argument of type 'string \| undefined' is not assignable to parameter of type 'PathLike'. Type 'undefined' is not assignable to type 'PathLike'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| SemVer'. Type 'undefined' is not assignable to type 'string \| SemVer'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| SemVer'. Argument of type 'null' is not assignable to parameter of type 'number \| undefined'. Argument of type 'null' is not assignable to parameter of type 'number \| PromiseLike'. Argument of type 'CompilerWorkerTask \| undefined' is not assignable to parameter of type 'CompilerWorkerTask'. Type 'undefined' is not assignable to type 'CompilerWorkerTask'. Argument of type 'null' is not assignable to parameter of type 'CompilerWorkerTask'. Argument of type 'undefined' is not assignable to parameter of type 'ErrorHandler'. Argument of type 'string \| undefined' is not assignable to parameter of type 'MockRequestInfo'. Type 'undefined' is not assignable to type 'MockRequestInfo'. Argument of type 'string \| undefined' is not assignable to parameter of type 'MockRequestInfo'. Argument of type 'MockResponse \| undefined' is not assignable to parameter of type 'MockResponse'. Type 'undefined' is not assignable to type 'MockResponse'. Argument of type 'RuntimeRef \| undefined' is not assignable to parameter of type 'RuntimeRef'. Type 'undefined' is not assignable to type 'RuntimeRef'. Argument of type 'this' is not assignable to parameter of type 'E2EElementInternal'. Type 'E2EElement' is not assignable to type 'E2EElementInternal'. Types of property 'find' are incompatible. Type '(selector: string) => Promise<E2EElement \| null>' is not assignable to type '(selector: FindSelector) => Promise'. Argument of type 'string \| null \| undefined' is not assignable to parameter of type 'SerializableOrJSHandle'. Type 'undefined' is not assignable to type 'SerializableOrJSHandle'. Argument of type 'this' is not assignable to parameter of type 'E2EElementInternal'. Argument of type 'ElementHandle \| null' is not assignable to parameter of type 'ElementHandle'. Type 'null' is not assignable to type 'ElementHandle'. Argument of type '{ viewport: EmulateViewport \| undefined; userAgent: string \| undefined; }' is not assignable to parameter of type '{ viewport: Viewport; userAgent: string; }'. Types of property 'viewport' are incompatible. Type 'EmulateViewport \| undefined' is not assignable to type 'Viewport'. Type 'undefined' is not assignable to type 'Viewport'. Argument of type 'null' is not assignable to parameter of type 'SourceMap \| undefined'.
TS2322	539	Error messages Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'string \| null \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'null' is not assignable to type 'DevServerConfig \| undefined'. Type 'boolean \| null \| undefined' is not assignable to type 'boolean \| undefined'. Type 'null' is not assignable to type 'boolean \| undefined'. Type 'null' is not assignable to type 'DevServer'. Type 'undefined' is not assignable to type 'ComponentConstructor \| Promise'. Type 'HTMLElement \| null' is not assignable to type 'HTMLElement'. Type 'null' is not assignable to type 'HTMLElement'. Type '({ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; } \| { ...; })[]' is not assignable to type 'RollupResult[]'. Type '{ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; } \| { ...; }' is not assignable to type 'RollupResult'. Type '{ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; }' is not assignable to type 'RollupResult'. Type '{ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; }' is not assignable to type 'RollupChunkResult'. Types of property 'moduleFormat' are incompatible. Type 'ModuleFormat \| undefined' is not assignable to type 'ModuleFormat'. Type 'undefined' is not assignable to type 'ModuleFormat'. Type 'null' is not assignable to type 'CompilerBuildResults'. Type 'undefined' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'Document'. Type 'null' is not assignable to type 'Promise'. Type 'null' is not assignable to type 'LoggerTimeSpan'. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type 'number \| undefined' is not assignable to type 'number'. Type 'undefined' is not assignable to type 'number'. Type 'boolean \| "prod" \| undefined' is not assignable to type 'boolean \| "prod"'. Type 'undefined' is not assignable to type 'boolean \| "prod"'. Type 'BuildResultsComponentGraph \| undefined' is not assignable to type 'BuildResultsComponentGraph'. Type 'undefined' is not assignable to type 'BuildResultsComponentGraph'. Type 'RollupResults \| undefined' is not assignable to type 'RollupResults'. Type 'undefined' is not assignable to type 'RollupResults'. Type '{ name: string \| undefined; source: string; tags: any[]; }[]' is not assignable to type '{ name: string; source: string; tags: string[]; }[]'. Type '{ name: string \| undefined; source: string; tags: any[]; }' is not assignable to type '{ name: string; source: string; tags: string[]; }'. Types of property 'name' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'null' is not assignable to type 'CompilerWorkerContext'. Type 'null' is not assignable to type 'WatchOfConfigFile'. Type 'null' is not assignable to type 'Promise<(void \| void[])[]>'. Type 'Promise<(void \| void[] \| null)[]>' is not assignable to type 'Promise<(void \| void[])[]>'. Type '(void \| void[] \| null)[]' is not assignable to type '(void \| void[])[]'. Type 'void \| void[] \| null' is not assignable to type 'void \| void[]'. Type 'null' is not assignable to type 'void \| void[]'. Type 'null' is not assignable to type '{ program: WatchOfConfigFile; rebuild: () => void; }'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string \| undefined'. Type 'string' is not assignable to type 'never'. Type 'null' is not assignable to type 'never'. Type 'never[]' is not assignable to type 'never'. Type '{ code: string; exports: string[]; workerMsgId: string; dependencies: string[]; } \| null' is not assignable to type 'WorkerMeta \| undefined'. Type 'null' is not assignable to type 'WorkerMeta \| undefined'. Type 'WorkerMeta \| undefined' is not assignable to type 'WorkerMeta'. Type 'undefined' is not assignable to type 'WorkerMeta'. Type 'CompilerSystem \| undefined' is not assignable to type 'CompilerSystem'. Type 'undefined' is not assignable to type 'CompilerSystem'. Type 'Logger \| undefined' is not assignable to type 'Logger'. Type 'undefined' is not assignable to type 'Logger'. Type 'import("/home/runner/work/stencil/stencil/src/compiler/cache").Cache' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/declarations/stencil-private").Cache'. The types returned by 'get(...)' are incompatible between these types. Type 'Promise<string \| null>' is not assignable to type 'Promise'. Type 'null' is not assignable to type 'ValidatedConfig'. Type 'null' is not assignable to type 'Config'. Type 'null' is not assignable to type 'string[]'. Type '{ dir: string; buildDir: string; collectionDir: string \| null; typesDir: string; esmLoaderPath: string; copy: d.CopyTask[]; polyfills: boolean \| undefined; empty: boolean; transformAliasedImportPathsInCollection: boolean; type: "dist"; }' is not assignable to type 'Required'. Types of property 'polyfills' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type 'string \| undefined' is not assignable to type 'never'. Type 'undefined' is not assignable to type 'never'. Type 'boolean \| undefined' is not assignable to type 'never'. Type 'undefined' is not assignable to type 'never'. Type 'boolean' is not assignable to type 'never'. Type 'CopyTask[]' is not assignable to type 'never'. Type 'null' is not assignable to type 'number \| undefined'. Type 'null' is not assignable to type 'HistoryApiFallback \| undefined'. Type 'null' is not assignable to type 'CopyTask[] \| undefined'. Type '{ dirPath: string; filePath: string; fileName: string; readmePath: string; usagesDir: string; tag: string; readme: string \| undefined; usage: JsonDocsUsage; docs: string; docsTags: CompilerJsDocTagInfo[]; ... 11 more ...; listeners: JsonDocsListener[]; }[]' is not assignable to type 'JsonDocsComponent[]'. Type '{ dirPath: string; filePath: string; fileName: string; readmePath: string; usagesDir: string; tag: string; readme: string \| undefined; usage: d.JsonDocsUsage; docs: string; docsTags: d.CompilerJsDocTagInfo[]; ... 11 more ...; listeners: d.JsonDocsListener[]; }' is not assignable to type 'JsonDocsComponent'. Types of property 'readme' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'string[] \| undefined' is not assignable to type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. Type '{ name: string; type: string; mutable: boolean; attr: string \| undefined; reflectToAttr: boolean; docs: string; docsTags: CompilerJsDocTagInfo[]; default: string \| undefined; deprecation: string \| undefined; values: JsonDocsValue[]; optional: boolean; required: boolean; }[]' is not assignable to type 'JsonDocsProp[]'. Type '{ name: string; type: string; mutable: boolean; attr: string \| undefined; reflectToAttr: boolean; docs: string; docsTags: d.CompilerJsDocTagInfo[]; default: string \| undefined; deprecation: string \| undefined; values: d.JsonDocsValue[]; optional: boolean; required: boolean; }' is not assignable to type 'JsonDocsProp'. Types of property 'default' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '{ name: string; type: string; mutable: false; attr: string; reflectToAttr: false; docs: string; docsTags: never[]; default: undefined; deprecation: undefined; values: JsonDocsValue[]; optional: true; required: false; }[]' is not assignable to type 'JsonDocsProp[]'. Type '{ name: string; type: string; mutable: false; attr: string; reflectToAttr: false; docs: string; docsTags: never[]; default: undefined; deprecation: undefined; values: d.JsonDocsValue[]; optional: true; required: false; }' is not assignable to type 'JsonDocsProp'. Types of property 'default' are incompatible. Type 'undefined' is not assignable to type 'string'. Type '(ComponentCompilerMeta \| undefined)[]' is not assignable to type 'ComponentCompilerMeta[]'. Type 'ComponentCompilerMeta \| undefined' is not assignable to type 'ComponentCompilerMeta'. Type 'undefined' is not assignable to type 'ComponentCompilerMeta'. Type '(ComponentCompilerMeta \| undefined)[][]' is not assignable to type 'readonly ComponentCompilerMeta[][]'. Type '(ComponentCompilerMeta \| undefined)[]' is not assignable to type 'ComponentCompilerMeta[]'. Type 'null' is not assignable to type 'boolean \| SourceMapOptions \| undefined'. Type 'null' is not assignable to type 'SourceMap \| undefined'. Type '{ name: string \| undefined; tags: string[]; }[]' is not assignable to type 'CollectionDependencyData[]'. Type '{ name: string \| undefined; tags: string[]; }' is not assignable to type 'CollectionDependencyData'. Types of property 'name' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'string \| undefined' is not assignable to type 'string \| number'. Type 'undefined' is not assignable to type 'string \| number'. Type 'SourceMap \| undefined' is not assignable to type 'SourceMap'. Type 'undefined' is not assignable to type 'SourceMap'. Type 'string \| null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'Function'. Type 'null' is not assignable to type 'Map<string, string[]>'. Type 'null' is not assignable to type 'PrerenderConfig'. Type 'null' is not assignable to type 'Set'. Type 'null' is not assignable to type 'HydrateAnchorElement[]'. Type 'null' is not assignable to type '(prerenderRequest: PrerenderUrlRequest) => Promise'. Type 'CssNode \| null' is not assignable to type 'void \| CssNode'. Type 'null' is not assignable to type 'void \| CssNode'. Type 'CssNode \| null' is not assignable to type 'CssNode'. Type 'null' is not assignable to type 'CssNode'. Type 'CssNode \| null' is not assignable to type 'void \| CssNode'. Type 'RegExpExecArray \| null' is not assignable to type 'RegExpExecArray'. Type 'null' is not assignable to type 'RegExpExecArray'. Type 'null' is not assignable to type '() => string'. Type 'null' is not assignable to type 'number'. Type 'null' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'boolean \| undefined'. Type 'FsItem \| undefined' is not assignable to type 'FsItem'. Type 'undefined' is not assignable to type 'FsItem'. Type 'null' is not assignable to type 'CompilerFileWatcherCallback[]'. Type '(key: string) => string \| undefined' is not assignable to type '(key: string) => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '(p: string) => Promise<string \| undefined>' is not assignable to type '{ (p: string): Promise; (p: string, encoding: "utf8"): Promise; (p: string, encoding: "binary"): Promise; }'. Type 'Promise<string \| undefined>' is not assignable to type 'Promise'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '(p: string) => string \| undefined' is not assignable to type '(p: string, encoding?: string \| undefined) => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '((maxConcurrentWorkers: number) => WorkerMainController) \| null' is not assignable to type '((maxConcurrentWorkers: number) => WorkerMainController) \| undefined'. Type 'null' is not assignable to type '((maxConcurrentWorkers: number) => WorkerMainController) \| undefined'. Type 'null' is not assignable to type 'ResolvedModuleWithFailedLookupLocations'. Type 'null' is not assignable to type 'Worker'. Type 'CollectionCompilerMeta \| undefined' is not assignable to type 'CollectionCompilerMeta'. Type 'undefined' is not assignable to type 'CollectionCompilerMeta'. Type 'null' is not assignable to type 'PropertyAssignment'. Type 'boolean \| null' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'boolean'. Type 'undefined' is not assignable to type 'ComponentCompilerVirtualProperty'. Type '{ name: string; method: string; bubbles: boolean; cancelable: boolean; composed: boolean; docs: CompilerJsDoc; complexType: ComponentCompilerEventComplexType; internal: boolean \| undefined; }[]' is not assignable to type 'ComponentCompilerEvent[]'. Type '{ name: string; method: string; bubbles: boolean; cancelable: boolean; composed: boolean; docs: d.CompilerJsDoc; complexType: d.ComponentCompilerEventComplexType; internal: boolean \| undefined; }' is not assignable to type 'ComponentCompilerEvent'. Types of property 'internal' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type '{ name: string; docs: CompilerJsDoc; complexType: ComponentCompilerMethodComplexType; internal: boolean \| undefined; }[]' is not assignable to type 'ComponentCompilerMethod[]'. Type '{ name: string; docs: d.CompilerJsDoc; complexType: d.ComponentCompilerMethodComplexType; internal: boolean \| undefined; }' is not assignable to type 'ComponentCompilerMethod'. Types of property 'internal' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type '{ name: string; type: ComponentCompilerPropertyType; attribute: string \| undefined; reflect: boolean; mutable: boolean; required: boolean; optional: boolean; defaultValue: string \| undefined; complexType: ComponentCompilerPropertyComplexType; docs: CompilerJsDoc; internal: boolean \| undefined; }[]' is not assignable to type 'ComponentCompilerProperty[]'. Type '{ name: string; type: d.ComponentCompilerPropertyType; attribute: string \| undefined; reflect: boolean; mutable: boolean; required: boolean; optional: boolean; defaultValue: string \| undefined; complexType: d.ComponentCompilerPropertyComplexType; docs: d.CompilerJsDoc; internal: boolean \| undefined; }' is not assignable to type 'ComponentCompilerProperty'. Types of property 'internal' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'ImportData'. Type 'undefined' is not assignable to type '"queryparams" \| null'. Type 'null' is not assignable to type 'WeakSet'. Type 'null' is not assignable to type 'Module'. Type 'Module \| undefined' is not assignable to type 'Module'. Type 'undefined' is not assignable to type 'Module'. Type 'undefined' is not assignable to type 'CompilerJsDoc'. Type '{ [x: string]: d.TypesMemberNameData[] \| undefined; }' is not assignable to type 'TypesImportData'. 'string' index signatures are incompatible. Type 'TypesMemberNameData[] \| undefined' is not assignable to type 'TypesMemberNameData[]'. Type 'undefined' is not assignable to type 'TypesMemberNameData[]'. Type 'string \| undefined' is not assignable to type 'string \| null'. Type '((data: { file: string; line: number; column: number; }) => void) \| null' is not assignable to type 'OpenInEditorCallback \| undefined'. Type 'null' is not assignable to type 'OpenInEditorCallback \| undefined'. Type 'null' is not assignable to type 'WebSocket'. Type 'null' is not assignable to type 'BuildOnEventRemove'. Type 'null' is not assignable to type '() => void'. Type 'null' is not assignable to type '(msg: DevServerMessage) => void'. Type 'DevServerConfig \| undefined' is not assignable to type 'DevServerConfig'. Type 'undefined' is not assignable to type 'DevServerConfig'. Type 'null' is not assignable to type '{ open(openId: string): Promise; }'. Type 'string \| null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'Promise<DevServerEditor[]>'. Type 'null' is not assignable to type '(req: IncomingMessage, res: ServerResponse, next: () => void) => void'. Type 'null' is not assignable to type 'URL'. Type 'null' is not assignable to type 'URLSearchParams'. Type 'PageReloadStrategy \| undefined' is not assignable to type 'PageReloadStrategy'. Type 'undefined' is not assignable to type 'PageReloadStrategy'. Type 'null' is not assignable to type 'Server<typeof IncomingMessage, typeof ServerResponse>'. Type 'null' is not assignable to type 'DevWebSocket'. Type 'null' is not assignable to type 'DevServerContext'. Type 'DevWebSocket \| null' is not assignable to type 'DevWebSocket'. Type 'null' is not assignable to type 'DevWebSocket'. Type 'null' is not assignable to type 'ChildProcess'. Type 'null' is not assignable to type 'HydrateApp'. Type '() => undefined' is not assignable to type '{ (cb?: (() => void) \| undefined): TestServerResponse; (chunk: any, cb?: (() => void) \| undefined): TestServerResponse; (chunk: any, encoding: BufferEncoding, cb?: (() => void) \| undefined): TestServerResponse; }'. Type 'undefined' is not assignable to type 'TestServerResponse'. Type 'null' is not assignable to type 'ComponentConstructor'. Type '(this: HostElement) => Promise \| undefined' is not assignable to type '() => Promise'. Type 'Promise \| undefined' is not assignable to type 'Promise'. Type 'undefined' is not assignable to type 'Promise'. Type 'null' is not assignable to type 'Window & typeof globalThis'. Type 'null' is not assignable to type 'Window'. Type 'null' is not assignable to type 'Window & typeof globalThis'. Type 'null' is not assignable to type 'MockCSSStyleSheet'. Type 'null' is not assignable to type 'string \| boolean'. Type 'null' is not assignable to type 'Location'. Type 'null' is not assignable to type 'MockElement'. Type 'null' is not assignable to type 'SVGSVGElement'. Type 'null' is not assignable to type 'SVGElement'. Type 'null' is not assignable to type 'EventTarget'. Type 'null' is not assignable to type 'MockEventListener[]'. Type 'null' is not assignable to type 'MockDocument'. Type '{ name: string; value: string; namespace: string \| null; prefix: null; }[]' is not assignable to type 'Attribute[]'. Type '{ name: string; value: string; namespace: string \| null; prefix: null; }' is not assignable to type 'Attribute'. Types of property 'namespace' are incompatible. Type 'string \| null' is not assignable to type 'string \| undefined'. Type '(element: MockElement) => string \| null' is not assignable to type '(element: unknown) => string'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Type 'ParentNode \| null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'Document'. Type 'string \| null \| undefined' is not assignable to type 'string \| undefined'. Type 'never[] \| null' is not assignable to type 'RenderNode[]'. Type 'null' is not assignable to type 'RenderNode[]'. Type 'null' is not assignable to type 'VNode[]'. Type 'null' is not assignable to type 'string \| number \| undefined'. Type 'null' is not assignable to type 'string \| number \| Function'. Type 'RenderNode \| null' is not assignable to type 'RenderNode'. Type 'null' is not assignable to type 'RenderNode'. Type 'HTMLElement \| null' is not assignable to type 'EventTarget'. Type 'null' is not assignable to type 'EventTarget'. Type 'string \| null \| undefined' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'Set \| undefined'. Type 'null' is not assignable to type '[string, any][] \| undefined'. Type 'VNode[] \| undefined' is not assignable to type 'VNode[]'. Type 'undefined' is not assignable to type 'VNode[]'. Type '(props: {}, children: VNode[], utils: FunctionalUtilities) => null' is not assignable to type 'FunctionalComponent<{}>'. Type 'null' is not assignable to type 'VNode \| VNode[]'. Type '() => null' is not assignable to type 'FunctionalComponent<{}>'. Type 'null' is not assignable to type 'VNode \| VNode[]'. Type 'null' is not assignable to type 'VNode'. Type 'undefined' is not assignable to type 'VNode'. Type 'RenderNode \| undefined' is not assignable to type 'RenderNode'. Type 'undefined' is not assignable to type 'RenderNode'. Type 'RelocateNodeData \| undefined' is not assignable to type 'RelocateNodeData'. Type 'undefined' is not assignable to type 'RelocateNodeData'. Type 'ChildNode \| null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'ScreenshotBuild'. Type 'null' is not assignable to type 'ScreenshotCache'. Type 'null' is not assignable to type 'Buffer'. Type 'null' is not assignable to type 'Screenshot'. Type '(() => void) \| undefined' is not assignable to type '() => any'. Type 'undefined' is not assignable to type '() => any'. Type '() => null' is not assignable to type '(opts: { rootDir: string; moduleId: string; path: string; }) => string'. Type 'null' is not assignable to type 'string'. Type '() => null' is not assignable to type '(opts: { moduleId: string; path?: string \| undefined; version?: string \| undefined; }) => string'. Type 'null' is not assignable to type 'string'. Type '() => string \| undefined' is not assignable to type '() => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'number \| null' is not assignable to type 'number'. Type 'null' is not assignable to type 'number'. Type 'any[] \| undefined' is not assignable to type 'any[]'. Type 'undefined' is not assignable to type 'any[]'. Type 'boolean \| null \| undefined' is not assignable to type 'boolean \| undefined'. Type 'null' is not assignable to type 'ConfigBundle[] \| undefined'. Type 'null' is not assignable to type 'OutputTarget[] \| undefined'. Type 'null' is not assignable to type 'TestingConfig \| undefined'. Type 'null' is not assignable to type 'Cache'. Type 'null' is not assignable to type '{ access: (filePath: string) => Promise; accessSync: (filePath: string) => boolean; cancelDeleteDirectoriesFromDisk: (dirPaths: string[]) => void; cancelDeleteFilesFromDisk: (filePaths: string[]) => void; ... 17 more ...; writeFiles: (files: { ...; } \| Map<...>, opts?: FsWriteOptions \| undefined) => Promise...'. Type 'HostRef \| undefined' is not assignable to type 'HostRef'. Type 'undefined' is not assignable to type 'HostRef'. Type 'Function \| undefined' is not assignable to type 'Function'. Type 'undefined' is not assignable to type 'Function'. Type 'RafCallback \| undefined' is not assignable to type 'Function'. Type 'undefined' is not assignable to type 'Function'. Type 'QueuedLoadModule \| undefined' is not assignable to type 'QueuedLoadModule'. Type 'undefined' is not assignable to type 'QueuedLoadModule'. Type 'null' is not assignable to type 'ElementHandle'. Type 'null' is not assignable to type 'E2EPageInternal'. Type 'ElementHandle \| null' is not assignable to type 'ElementHandle'. Type 'null' is not assignable to type 'ElementHandle'. Type 'null' is not assignable to type 'Promise<JSHandle>'. Type '(a?: any, b?: any) => Promise<ScreenshotDiff \| undefined>' is not assignable to type '{ (): Promise; (description: string): Promise; (opts: ScreenshotOptions): Promise<...>; (description: string, opts: ScreenshotOptions): Promise<...>; }'. Type 'Promise<ScreenshotDiff \| undefined>' is not assignable to type 'Promise'. Type 'ScreenshotDiff \| undefined' is not assignable to type 'ScreenshotDiff'. Type 'undefined' is not assignable to type 'ScreenshotDiff'. Type 'null' is not assignable to type 'CompilerWatcher'. Type 'null' is not assignable to type 'Promise'. Type 'Browser \| null' is not assignable to type 'Browser'. Type 'null' is not assignable to type 'Browser'. Type 'null' is not assignable to type 'ValidatedConfig'. Type 'null' is not assignable to type 'Browser'. Type 'null' is not assignable to type 'SourceMap'. Type 'null' is not assignable to type 'PackageJsonData'. Type 'null' is not assignable to type '{ [moduleId: string]: string; } \| undefined'.
TS2531	203	Error messages Object is possibly 'null'.
TS2454	46	Error messages Variable 'pkgJsonData' is used before being assigned. Variable 'minifyOpts' is used before being assigned. Variable 'workerCtrl' is used before being assigned. Variable 'timespan' is used before being assigned. Variable 'content' is used before being assigned. Variable 'compilerExe' is used before being assigned. Variable 'outputText' is used before being assigned. Variable 'importResolvedFile' is used before being assigned. Variable 'win' is used before being assigned. Variable 'attrName' is used before being assigned. Variable 'oldValue' is used before being assigned. Variable 'newValue' is used before being assigned. Variable 'hostId' is used before being assigned. Variable 'promise' is used before being assigned. Variable 'textContent' is used before being assigned. Variable 'resolve' is used before being assigned. Variable 'opts' is used before being assigned.
TS2722	41	Error messages Cannot invoke an object which is possibly 'undefined'.
TS2352	19	Error messages Conversion of type 'null' to type 'CompilerSystem' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Conversion of type 'null' to type 'string' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Conversion of type 'null' to type 'string[]' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Conversion of type '{ cmps: never[]; }' to type 'Module' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Type '{ cmps: never[]; }' is missing the following properties from type 'Module': coreRuntimeApis, collectionName, dtsFilePath, excludeFromCollection, and 27 more. Conversion of type 'null' to type 'ScreenshotCache' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
TS2769	13	Error messages No overload matches this call. Overload 1 of 2, '(type: keyof DocumentEventMap, listener: (this: Document, ev: PointerEvent \| MouseEvent \| UIEvent \| Event \| ErrorEvent \| ... 13 more ... \| WheelEvent) => any, options?: boolean \| ... 1 more ... \| undefined): void', gave the following error. Argument of type '"e"' is not assignable to parameter of type 'keyof DocumentEventMap'. Overload 2 of 2, '(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions \| undefined): void', gave the following error. Argument of type 'null' is not assignable to parameter of type 'EventListenerOrEventListenerObject'. No overload matches this call. Overload 1 of 2, '(o: {}): string[]', gave the following error. Argument of type 'BuildResultsComponentGraph \| undefined' is not assignable to parameter of type '{}'. Type 'undefined' is not assignable to type '{}'. Overload 2 of 2, '(o: object): string[]', gave the following error. Argument of type 'BuildResultsComponentGraph \| undefined' is not assignable to parameter of type 'object'. Type 'undefined' is not assignable to type 'object'. No overload matches this call. Overload 1 of 4, '(object: {}, method: never): SpyInstance<never, never>', gave the following error. Argument of type 'CompilerWorkerContext \| undefined' is not assignable to parameter of type '{}'. Type 'undefined' is not assignable to type '{}'. Overload 2 of 4, '(object: {}, method: never): SpyInstance<never, never>', gave the following error. Argument of type 'CompilerWorkerContext \| undefined' is not assignable to parameter of type '{}'. Type 'undefined' is not assignable to type '{}'. No overload matches this call. The last overload gave the following error. Argument of type 'string \| null' is not assignable to parameter of type '(substring: string, ...args: any[]) => string'. Type 'null' is not assignable to type '(substring: string, ...args: any[]) => string'. No overload matches this call. The last overload gave the following error. Argument of type 'string \| null' is not assignable to parameter of type 'string \| number \| boolean \| PseudoBigInt'. Type 'null' is not assignable to type 'string \| number \| boolean \| PseudoBigInt'. No overload matches this call. The last overload gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| RegExp'. Type 'undefined' is not assignable to type 'string \| RegExp'. No overload matches this call. Overload 1 of 2, '(configFileName: string, optionsToExtend: CompilerOptions \| undefined, system: System, createProgram?: CreateProgram \| undefined, reportDiagnostic?: DiagnosticReporter \| undefined, reportWatchStatus?: WatchStatusReporter \| undefined, watchOptionsToExtend?: WatchOptions \| undefined, extraFileExtensions?: readonly FileExtensionInfo[] \| undefined): WatchCompilerHostOfConfigFile<...>', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Overload 2 of 2, '(rootFiles: string[], options: CompilerOptions, system: System, createProgram?: CreateProgram \| undefined, reportDiagnostic?: DiagnosticReporter \| undefined, reportWatchStatus?: WatchStatusReporter \| undefined, projectReferences?: readonly ProjectReference[] \| undefined, watchOptions?: WatchOptions \| undefined): WatchCompilerHostOfFilesAndCompilerOptions<...>', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. No overload matches this call. Overload 1 of 2, '(timeoutId: string \| number \| Timeout \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'string \| number \| Timeout \| undefined'. Type 'null' is not assignable to type 'string \| number \| Timeout \| undefined'. Overload 2 of 2, '(id?: number \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'number \| undefined'. Type 'null' is not assignable to type 'number \| undefined'. No overload matches this call. Overload 1 of 2, '(timeoutId: string \| number \| Timeout \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'string \| number \| Timeout \| undefined'. Overload 2 of 2, '(id?: number \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'number \| undefined'. No overload matches this call. Overload 1 of 3, '(p: string, encoding: "utf8"): Promise', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Overload 2 of 3, '(p: string, encoding: "binary"): Promise', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. No overload matches this call. Overload 1 of 2, '(values: [] \| readonly unknown[]): Promise<unknown[] \| []>', gave the following error. Argument of type 'Promise[] \| undefined' is not assignable to parameter of type '[] \| readonly unknown[]'. Type 'undefined' is not assignable to type '[] \| readonly unknown[]'. Overload 2 of 2, '(values: Iterable<void \| PromiseLike>): Promise<void[]>', gave the following error. Argument of type 'Promise[] \| undefined' is not assignable to parameter of type 'Iterable<void \| PromiseLike>'. Type 'undefined' is not assignable to type 'Iterable<void \| PromiseLike>'.
TS2790	10	Error messages The operand of a 'delete' operator must be optional.
TS2538	8	Error messages Type 'undefined' cannot be used as an index type. Type 'null' cannot be used as an index type.
TS2416	4	Error messages Property 'get' in type 'Cache' is not assignable to the same property in base type 'Cache'. Type '(key: string) => Promise<string \| null>' is not assignable to type '(key: string) => Promise'. Type 'Promise<string \| null>' is not assignable to type 'Promise'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Property 'getMemoryStats' in type 'Cache' is not assignable to the same property in base type 'Cache'. Type '() => string \| null' is not assignable to type '() => string'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Property 'find' in type 'E2EElement' is not assignable to the same property in base type 'E2EElementInternal'. Type '(selector: string) => Promise<E2EElement \| null>' is not assignable to type '(selector: FindSelector) => Promise'. Type 'Promise<E2EElement \| null>' is not assignable to type 'Promise'. Type 'E2EElement \| null' is not assignable to type 'E2EElement'. Type 'null' is not assignable to type 'E2EElement'. Property 'findAll' in type 'E2EElement' is not assignable to the same property in base type 'E2EElementInternal'. Type '(selector: string) => Promise<E2EElement[]>' is not assignable to type '(selector: FindSelector) => Promise<E2EElement[]>'. Type 'Promise<import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-element").E2EElement[]>' is not assignable to type 'Promise<import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-declarations").E2EElement[]>'. Type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-element").E2EElement[]' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-declarations").E2EElement[]'. Type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-element").E2EElement' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-declarations").E2EElement'. The types returned by 'find(...)' are incompatible between these types. Type 'Promise<E2EElement \| null>' is not assignable to type 'Promise'.
TS2533	3	Error messages Object is possibly 'null' or 'undefined'.
TS2493	3	Error messages Tuple type '[]' of length '0' has no element at index '0'.
TS2488	2	Error messages Type 'Diagnostic[] \| undefined' must have a 'Symbol.iterator' method that returns an iterator. Type 'string[] \| undefined' must have a 'Symbol.iterator' method that returns an iterator.
TS2774	2	Error messages This condition will always return true since this function is always defined. Did you mean to call it instead?
TS2684	1	Error messages The 'this' context of type 'ResolveIdHook \| undefined' is not assignable to method's 'this' of type 'Function'. Type 'undefined' is not assignable to type 'Function'.
TS2464	1	Error messages A computed property name must be of type 'string', 'number', 'symbol', or 'any'.
TS2430	1	Error messages Interface 'SerializeOpts' incorrectly extends interface 'SerializeCssOptions'. Types of property 'usedSelectors' are incompatible. Type 'UsedSelectors \| null' is not assignable to type 'UsedSelectors \| undefined'. Type 'null' is not assignable to type 'UsedSelectors \| undefined'.

Unused exports report

There are 9 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!

Unused exports

File	Line	Identifier
src/screenshot/screenshot-fs.ts	18	readScreenshotData
src/testing/testing-utils.ts	186	withSilentWarn
src/compiler/app-core/app-data.ts	3	BUILD
src/compiler/app-core/app-data.ts	88	Env
src/compiler/app-core/app-data.ts	90	NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts	111	updateCacheFromRebuild
src/testing/platform/testing-platform.ts	29	cssVarShim
src/testing/puppeteer/puppeteer-declarations.ts	513	WaitForEventOptions
src/client/polyfills/css-shim/utils.ts	1	GLOBAL_SCOPE

this commit adds an 'Overview' section to the generated `README.md` file for a component. this implementation is simple (and arguably naive) intentionally. there is quite a bit that folks could do in the context of a JSDoc. rather than attempting to capture every use case and potentially overcomplicate our solution, we start simple and can iterate from there.

this commit adds JSDoc to a portion of the codebase that is related to the generation of documentation

alicewriteswrongs · 2022-10-04T17:25:47Z

functionality works great! reading code now

alicewriteswrongs

a few comments and questions

alicewriteswrongs · 2022-10-04T17:58:50Z

src/compiler/docs/readme/markdown-overview.ts

+  const content: string[] = [];
+  content.push(`## Overview`);
+  content.push('');
+  content.push(`${overview.trim()}`);


Is there any escaping / illegal character type stuff we should be concerned about here? I know that a lot of Markdown syntax is supported in a lot of JSDoc ecosystem stuff, but not sure if there are some edge cases we need to be aware of

Ah missed this the first time around. Perhaps? Although I don't think there's any sanitization done for any MD files yet. It's probably best served as a separate task, but I think the risk some someone doing something super funky is pretty low here

yeah agreed, and it would just mainly be ending up in their own markdown file so 🤷‍♀️ I think we don't need to worry about it

alicewriteswrongs · 2022-10-04T18:00:20Z

src/declarations/stencil-public-docs.ts

+ *   'foo': STRING_CONTENTS_OF_FOO.MD
+ * }
+ * ```
+ */


comments like these 🙌

alicewriteswrongs · 2022-10-04T18:52:10Z

src/compiler/docs/test/markdown-overview.spec.ts

+
+describe('markdown-overview', () => {
+  describe('overviewToMarkdown', () => {
+    it('returns an empty string if no docs exist on the component', () => {


nit: s/string/array/ ?

de1e73f - good catch! I kept doing that throughout the implementation for some reason 🙃

alicewriteswrongs · 2022-10-04T18:53:31Z

src/compiler/docs/test/markdown-overview.spec.ts

+`);
+    });
+
+    it('trims leading & trailing newlines single lines', () => {


should this be something like

Suggested change

it('trims leading & trailing newlines single lines', () => {

it('trims all leading newlines & leaves one at the end', () => {

idk that's kind of awkward

Done in 9e41a13, also tweaked the tests ever so slightly to line up better with their descriptions

alicewriteswrongs · 2022-10-04T18:54:41Z

src/compiler/docs/generate-doc-data.ts

+ * This function is responsible for reading the contents of all markdown files in a provided `usage` directory and
+ * returning their contents
+ * @param compilerCtx the current compiler context
+ * @param usagesDir the directory to read usages markdown files from


Suggested change

* @param usagesDir the directory to read usages markdown files from

* @param usagesDir the directory to read usage markdown files from

alicewriteswrongs · 2022-10-04T18:55:53Z

src/compiler/docs/generate-doc-data.ts

      isContent = true;
    }
    if (isContent) {
+      // we're actively parsing the first found block of content, add it to our list for later
      contentLines.push(line);
    }


nice, state machine parser! kind of neat to find

alicewriteswrongs · 2022-10-04T19:12:57Z

src/compiler/build/build-ctx.ts

+ * Generate a timestamp of the format `YYYY-MM-DDThh:mm:ss`, using the number of seconds that have elapsed since
+ * January 01, 1970, and the time this function was called
+ * @returns the generated timestamp
+ */
 export const getBuildTimestamp = () => {


am I missing something, or does this produce the same output as (new Date()).toISOString().split(".")[0] ?

Yeah, I think it does (create the same string)

🤷‍♀️ seems to work so...idk! let's keep it

also make tests a little clearer

alicewriteswrongs

👍

rwaskiewicz · 2022-10-05T17:54:03Z

Potentially closes #3412

jgroth · 2022-10-25T10:40:05Z

Would be great to have the component level doc block in the components.d.ts file as well
hint hint 😄 👉 #3525

this commit fixes a regression that was introduced in 2db4f4d (#3635). the original commit did not take into account the fact that a user could have manually written text in their component's markdown file. that content would be assigned to the value used to generated the markdown file's "Overview" section, causing the content to be displayed twice. the contents of the `docs` field (i.e. the way that value is generated). cannot be changed, as `JsonDocs` publicly exposes that field (via a `JsonDocsComponent` value), and may be used by custom documentation generators. instead, this commit adds an optional 'overview' field to the `JsonDocsComponent` type. the intent here is to avoid _most_ assignability errors by making this field optional. the value is assigned when stencil generates its documentation data with the text from the class component's jsdoc.

this commit fixes a regression that was introduced in 2db4f4d (#3635). the original commit did not take into account the fact that a user could have manually written text in their component's markdown file. that content would be assigned to the value used to generated the markdown file's "Overview" section, causing the content to be displayed twice. the contents of the `docs` field (i.e. the way that value is generated). cannot be changed, as `JsonDocs` publicly exposes that field (via a `JsonDocsComponent` value), and may be used by custom documentation generators. instead, this commit adds an optional 'overview' field to the `JsonDocsComponent` type. the intent here is to avoid _most_ assignability errors by making this field optional. the value is assigned when stencil generates its documentation data with the text from the class component's jsdoc. this commit adds additional testing coverage to the 'docs' field of `JsonDocsComponent`

rwaskiewicz added 2 commits September 29, 2022 16:36

chore(jsdoc): add doc to parts of doc gen code

5aa96f2

this commit adds JSDoc to a portion of the codebase that is related to the generation of documentation

rwaskiewicz force-pushed the rwaskiewicz/docs branch from 1317cdf to 5aa96f2 Compare September 29, 2022 20:37

rwaskiewicz marked this pull request as ready for review September 30, 2022 14:03

rwaskiewicz requested a review from a team as a code owner September 30, 2022 14:03

rwaskiewicz assigned alicewriteswrongs and tanner-reits Sep 30, 2022

alicewriteswrongs suggested changes Oct 4, 2022

View reviewed changes

rwaskiewicz added 3 commits October 4, 2022 15:25

review(ap): fix test title that used the type "string"

de1e73f

review(ap): update testing title for leading/trailing newlines

9e41a13

also make tests a little clearer

review(ap): usages->usage

ed21aac

rwaskiewicz requested a review from alicewriteswrongs October 4, 2022 19:36

alicewriteswrongs approved these changes Oct 4, 2022

View reviewed changes

rwaskiewicz unassigned alicewriteswrongs Oct 5, 2022

rwaskiewicz requested a review from tanner-reits October 5, 2022 12:17

tanner-reits approved these changes Oct 5, 2022

View reviewed changes

rwaskiewicz added 2 commits October 5, 2022 13:19

Merge branch 'main' into rwaskiewicz/docs

a099df2

Merge branch 'main' into rwaskiewicz/docs

89620f5

rwaskiewicz merged commit 2db4f4d into main Oct 5, 2022

rwaskiewicz deleted the rwaskiewicz/docs branch October 5, 2022 17:49

rwaskiewicz added the Resolution: Refine This PR is marked for Jira refinement. We're not working on it - we're talking it through. label Oct 5, 2022

jeripeierSBB mentioned this pull request Oct 25, 2022

bug: readme overview duplicates markdown content #3762

Closed

3 tasks

rwaskiewicz mentioned this pull request Oct 25, 2022

fix(docs): avoid duplicating manual documentation #3766

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs-readme): add overview to readme #3635

feat(docs-readme): add overview to readme #3635

rwaskiewicz commented Sep 29, 2022 •

edited

Loading

github-actions bot commented Sep 29, 2022 •

edited

Loading

alicewriteswrongs commented Oct 4, 2022

alicewriteswrongs left a comment

alicewriteswrongs Oct 4, 2022

rwaskiewicz Oct 4, 2022

alicewriteswrongs Oct 5, 2022

alicewriteswrongs Oct 4, 2022

alicewriteswrongs Oct 4, 2022

rwaskiewicz Oct 4, 2022

alicewriteswrongs Oct 4, 2022

rwaskiewicz Oct 4, 2022

alicewriteswrongs Oct 4, 2022

rwaskiewicz Oct 4, 2022

alicewriteswrongs Oct 4, 2022

alicewriteswrongs Oct 4, 2022

rwaskiewicz Oct 4, 2022

alicewriteswrongs Oct 4, 2022

alicewriteswrongs left a comment

rwaskiewicz commented Oct 5, 2022

jgroth commented Oct 25, 2022

	it('trims leading & trailing newlines single lines', () => {
	it('trims all leading newlines & leaves one at the end', () => {

	* @param usagesDir the directory to read usages markdown files from
	* @param usagesDir the directory to read usage markdown files from

feat(docs-readme): add overview to readme #3635

feat(docs-readme): add overview to readme #3635

Conversation

rwaskiewicz commented Sep 29, 2022 • edited Loading

Pull request checklist

Pull request type

What is the current behavior?

What is the new behavior?

Does this introduce a breaking change?

Testing

Other information

github-actions bot commented Sep 29, 2022 • edited Loading

--strictNullChecks error report

reports and statistics

Unused exports report

alicewriteswrongs commented Oct 4, 2022

alicewriteswrongs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alicewriteswrongs left a comment

Choose a reason for hiding this comment

rwaskiewicz commented Oct 5, 2022

jgroth commented Oct 25, 2022

rwaskiewicz commented Sep 29, 2022 •

edited

Loading

github-actions bot commented Sep 29, 2022 •

edited

Loading

`--strictNullChecks` error report