@lit-labs/gen-wrapper-react/index.js

Code generator for React wrapper for Lit components

/**
 * @license
 * Copyright 2022 Google LLC
 * SPDX-License-Identifier: BSD-3-Clause
 */
import * as path from 'path';
import { getImportsStringForReferences, } from '@lit-labs/analyzer';
import { javascript, kabobToOnEvent } from '@lit-labs/gen-utils/lib/str-utils.js';
/**
 * Our command for the Lit CLI.
 *
 * See ../../cli/src/lib/generate/generate.ts
 */
export const getCommand = () => {
    return {
        name: 'react',
        description: 'Generate React wrapper components from Lit elements',
        kind: 'resolved',
        async generate(options) {
            return await generateReactWrapper(options.package);
        },
    };
};
export const generateReactWrapper = async (pkg) => {
    const litModules = pkg.getLitElementModules();
    if (litModules.length > 0) {
        // Base the generated package folder name off the analyzed package folder
        // name, not the npm package name, since that might have an npm org in it
        const reactPkgFolder = packageNameToReactPackageName(path.basename(pkg.rootDir));
        return {
            [reactPkgFolder]: {
                '.gitignore': gitIgnoreTemplate(litModules),
                'package.json': packageJsonTemplate(pkg.packageJson, litModules),
                'tsconfig.json': tsconfigTemplate(),
                ...wrapperFiles(pkg.packageJson, litModules),
            },
        };
    }
    else {
        throw new Error('No Lit components were found in this package.');
    }
};
const wrapperFiles = (packageJson, litModules) => {
    const wrapperFiles = {};
    for (const { module, declarations } of litModules) {
        const { sourcePath, jsPath } = module;
        wrapperFiles[sourcePath] = wrapperModuleTemplate(packageJson, jsPath, declarations);
    }
    return wrapperFiles;
};
const packageJsonTemplate = (pkgJson, litModules) => {
    // Refinement of package.json generation ala the TODOs below tracked in
    // https://github.com/lit/lit/issues/2855
    // TODO(kschaaf): spread in/adapt other relevant fields from source
    // package.json (description, license, keywords, etc.)
    return JSON.stringify({
        name: packageNameToReactPackageName(pkgJson.name),
        type: 'module',
        scripts: {
            build: 'tsc',
            'build:watch': 'tsc --watch',
        },
        // TODO(kschaaf): Version in lock-step with source?
        version: pkgJson.version,
        dependencies: {
            // TODO(kschaaf): make component version range configurable?
            [pkgJson.name]: '^' + pkgJson.version,
            // TODO(kschaaf): make @lit/react version configurable?
            '@lit/react': '^1.0.0',
        },
        peerDependencies: {
            // TODO(kschaaf): make react version(s) configurable?
            react: '^17 || ^18',
            '@types/react': '^17 || ^18',
        },
        devDependencies: {
            // Use typescript from source package, assuming it exists
            typescript: pkgJson?.devDependencies?.typescript ?? '~4.7.4',
        },
        files: [
            ...litModules.map(({ module }) => module.jsPath
                .replace(/\\/g, '/')
                .replace(/js$/, '{js,js.map,d.ts,d.ts.map}')),
        ],
    }, null, 2);
};
const gitIgnoreTemplate = (litModules) => {
    return litModules
        .map(({ module }) => module.jsPath.replace(/\\/g, '/'))
        .join('\n');
};
const tsconfigTemplate = () => {
    return JSON.stringify({
        compilerOptions: {
            target: 'es2021',
            module: 'es2015',
            lib: ['es2021', 'DOM', 'DOM.Iterable'],
            declaration: true,
            declarationMap: true,
            sourceMap: true,
            inlineSources: true,
            outDir: './',
            rootDir: './src',
            strict: true,
            noUnusedLocals: true,
            noUnusedParameters: true,
            noImplicitReturns: true,
            noFallthroughCasesInSwitch: true,
            noImplicitAny: true,
            noImplicitThis: true,
            moduleResolution: 'node',
            allowSyntheticDefaultImports: true,
            experimentalDecorators: true,
            noImplicitOverride: true,
        },
        include: ['src/**/*.ts'],
        exclude: [],
    }, null, 2);
};
const getTypeImports = (declarations) => {
    // We only need type imports for events.
    const refs = declarations.flatMap(({ events }) => Array.from(events.values()).flatMap((e) => e.type?.references ?? []));
    return getImportsStringForReferences(refs);
};
// TODO(sorvell): add support for getting exports in analyzer.
const getElementTypeExportsFromImports = (imports) => imports.replace(/(?:^import)/gm, 'export type');
const wrapperModuleTemplate = (packageJson, moduleJsPath, elements) => {
    const hasEvents = elements.filter(({ events }) => events.size).length > 0;
    const typeImports = getTypeImports(elements);
    const typeExports = getElementTypeExportsFromImports(typeImports);
    moduleJsPath = moduleJsPath.replace(/\\/g, '/');
    return javascript `
 import * as React from 'react';
 import {createComponent${hasEvents ? `, EventName` : ``}} from '@lit/react';
 ${elements.map((element) => javascript `
 import {${element.name} as ${element.name}Element} from '${packageJson.name}/${moduleJsPath}';
 ${typeImports}
 ${typeExports}
 `)}

 ${elements.map((element) => wrapperTemplate(element))}
 `;
};
// TODO(kschaaf): Should this be configurable?
const packageNameToReactPackageName = (pkgName) => `${pkgName}-react`;
const wrapperTemplate = ({ name, tagname, events }) => {
    return javascript `
 export const ${name} = createComponent({
   react: React,
   tagName: '${tagname}',
   elementClass: ${name}Element,
   events: {
     ${Array.from(events.values()).map((event) => {
        const { name, type } = event;
        return javascript `
     ${kabobToOnEvent(name)}: '${name}' as EventName<${type?.text || `CustomEvent<unknown>`}>,`;
    })}
   }
  });
 `;
};
//# sourceMappingURL=index.js.map