chore: align to linter

Author: David Enke

esbuild-plugin-add-declarations.ts

@@ -1,15 +1,15 @@
+import { dirname, join, relative, resolve } from 'node:path';
+
 import type { Plugin } from 'esbuild';
 import type { Program } from 'typescript';
 import ts from 'typescript';
 
-import { dirname, join, relative, resolve } from 'node:path';
-
-type PluginOptions = {
+interface PluginOptions {
   filter: RegExp;
   include: string[];
   sourceRoot: string;
   outdir: string;
-};
+}
 
 function reportDiagnostics(program: Program): string {
   return ts.formatDiagnostics(ts.getPreEmitDiagnostics(program), {

esbuild-plugin-add-package.ts

@@ -1,19 +1,20 @@
-import type { Plugin } from 'esbuild';
 import { existsSync } from 'node:fs';
 import { mkdir, readFile, writeFile } from 'node:fs/promises';
 import { basename, dirname, join, relative, resolve } from 'node:path';
 import { cwd } from 'node:process';
 
-import type { package as Package } from './package.d';
+import type { Plugin } from 'esbuild';
+
+import type { package as Package } from './package.d.js';
 
-type ReadmeTemplateContext = {
+interface ReadmeTemplateContext {
   name: string;
   basePath: string;
   path: string;
   rootPackage: Package;
-};
+}
 
-type PluginOptions = {
+interface PluginOptions {
   filter: RegExp;
   packageName: string;
 
@@ -23,14 +24,14 @@ type PluginOptions = {
 
   sourceRoot: string;
   outdir: string;
-};
+}
 
 async function generatePackage(
   path: string,
   packageName: string,
   rootPackage: Package,
   src: string,
-  dist: string
+  dist: string,
 ): Promise<void> {
   // resolve paths for package.json
   const baseFile = basename(path, '.ts');
@@ -71,7 +72,7 @@ async function generateReadme(
   readmeTemplate: PluginOptions['readmeTemplate'],
   rootPackage: Package,
   src: string,
-  dist: string
+  dist: string,
 ): Promise<void> {
   // resolve paths for readme
   const basePath = dirname(relative(src, path));

esbuild.config.ts

@@ -1,11 +1,11 @@
+import { readFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
 import { build } from 'esbuild';
 import glob from 'fast-glob';
 
-import { resolve } from 'node:path';
-import { readFile } from 'node:fs/promises';
-
-import { addDeclarations } from './esbuild-plugin-add-declarations';
-import { addPackageJson } from './esbuild-plugin-add-package';
+import { addDeclarations } from './esbuild-plugin-add-declarations.js';
+import { addPackageJson } from './esbuild-plugin-add-package.js';
 
 build({
   sourceRoot: 'src',

generate-package-types.ts

@@ -3,6 +3,7 @@
 import { writeFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { argv, cwd } from 'node:process';
+
 import { getJsonSchemaReader, getTypeScriptWriter, makeConverter } from 'typeconv';
 
 // store generated types in cwd
@@ -11,6 +12,7 @@ const dist = resolve(cwd(), path);
 
 // load schema
 const response = await fetch('https://json.schemastore.org/package.json');
+// eslint-disable-next-line @typescript-eslint/no-explicit-any -- we have no types here, but trust the schema to be correct
 const { $schema, title, definitions, ...schema } = (await response.json()) as any;
 
 // as typeconv only looks inside the definitions object, we

globals.d.ts

@@ -1,16 +1,17 @@
 declare module '@custom-elements-manifest/to-markdown' {
   import type { AnalyzePhaseParams } from '@custom-elements-manifest/analyzer';
-  export type Options = {
+
+  export interface Options {
     private: 'all' | 'details' | 'hidden';
     headingOffset: number;
     classNameFilter: string;
     omitSections: string[];
     omitDeclarations: string[];
-  };
+  }
   type ModuleDoc = AnalyzePhaseParams['moduleDoc'];
   export function customElementsManifestToMarkdown(
     manifest: { modules: ModuleDoc[] },
-    options?: Partial<Options>
+    options?: Partial<Options>,
   ): string;
 }
 
@@ -20,12 +21,13 @@ declare module '@custom-elements-manifest/analyzer/browser/index.js' {
   const create: (options: { modules: any[]; plugins: Plugin[]; context: { dev: boolean } }) => any;
   const ts: typeof import('typescript');
   const litPlugin: () => Plugin[];
-  export { create, ts, litPlugin };
+  export { create, litPlugin, ts };
 }
 
 declare module 'esbuild-copy-static-files' {
   import type { Plugin } from 'esbuild';
-  export type CopyStaticFilesOptions = {
+
+  export interface CopyStaticFilesOptions {
     src: string;
     dest: string;
     filter: (src: string, dest: string) => boolean;
@@ -35,7 +37,7 @@ declare module 'esbuild-copy-static-files' {
     force: boolean;
     preserveTimestamps: boolean;
     recursive: boolean;
-  };
+  }
   const copyStaticFiles: (options?: Partial<CopyStaticFilesOptions>) => Plugin;
   export default copyStaticFiles;
 }

src/cem-plugin-examples/index.spec.ts

@@ -1,11 +1,11 @@
 import { readFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
-import type { SourceFile } from 'typescript';
 
 // https://custom-elements-manifest.open-wc.org/analyzer/getting-started/#usage-in-the-browser
-import { ts, create, litPlugin } from '@custom-elements-manifest/analyzer/browser/index.js';
+import { create, litPlugin, ts } from '@custom-elements-manifest/analyzer/browser/index.js';
+import type { SourceFile } from 'typescript';
 
-import { customElementExamplesPlugin } from '.';
+import { customElementExamplesPlugin } from './index.js';
 
 describe('cem-plugin-examples', () => {
   let source: SourceFile;

src/cem-plugin-examples/index.ts

@@ -1,13 +1,15 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { dirname, resolve } from 'node:path';
+
 import type { Plugin } from '@custom-elements-manifest/analyzer';
-import { findDeclaration, hasJsDocComments } from '../utils/plugin.utils';
+
+import { findDeclaration, hasJsDocComments } from '../utils/plugin.utils.js';
 
 // as the plugin is create by factory function, we can provide some options
-type PluginOptions = {
+interface PluginOptions {
   // the markdown file name to look for
   exampleFileName?: string;
-};
+}
 
 function isExampleTag(tag: CemJsDocTag): boolean {
   return tag.tagName.escapedText === 'example';
@@ -20,7 +22,7 @@ function isExampleTag(tag: CemJsDocTag): boolean {
  * So each module with annotated or file based examples will receive an additional `examples`
  * property containing them as strings.
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 export function customElementExamplesPlugin(options?: Partial<PluginOptions>): Plugin {
   return {
     name: 'custom-element-examples',

src/cem-plugin-generate-readmes/index.spec.ts

@@ -1,12 +1,12 @@
 import { existsSync } from 'node:fs';
 import { readFile, rm, writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
-import type { SourceFile } from 'typescript';
 
 // https://custom-elements-manifest.open-wc.org/analyzer/getting-started/#usage-in-the-browser
-import { ts, create, litPlugin } from '@custom-elements-manifest/analyzer/browser/index.js';
+import { create, litPlugin, ts } from '@custom-elements-manifest/analyzer/browser/index.js';
+import type { SourceFile } from 'typescript';
 
-import { customElementGenerateReadmesPlugin } from '.';
+import { customElementGenerateReadmesPlugin } from './index.js';
 
 describe('cem-plugin-generate-readmes', () => {
   const target = join(__dirname, '.README.md');

src/cem-plugin-generate-readmes/index.ts

@@ -2,10 +2,11 @@ import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
 import { dirname, resolve } from 'node:path';
 
 import type { Plugin } from '@custom-elements-manifest/analyzer';
-import { type Options as CemOptions, customElementsManifestToMarkdown } from '@custom-elements-manifest/to-markdown';
+import type { Options as CemOptions } from '@custom-elements-manifest/to-markdown';
+import { customElementsManifestToMarkdown } from '@custom-elements-manifest/to-markdown';
 import { analyzeText, transformAnalyzerResult } from 'web-component-analyzer';
 
-import { findDeclaration } from '../utils/plugin.utils';
+import { findDeclaration } from '../utils/plugin.utils.js';
 
 // as the plugin is create by factory function, we can provide some options
 type PluginOptions = {

src/cem-plugin-grouping/index.spec.ts

@@ -2,9 +2,9 @@ import { readFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 
 // https://custom-elements-manifest.open-wc.org/analyzer/getting-started/#usage-in-the-browser
-import { ts, create, litPlugin } from '@custom-elements-manifest/analyzer/browser/index.js';
+import { create, litPlugin, ts } from '@custom-elements-manifest/analyzer/browser/index.js';
 
-import { customElementGroupingPlugin } from '.';
+import { customElementGroupingPlugin } from './index.js';
 
 describe('cem-plugin-grouping', () => {
   it('should add groups to manifest', async () => {