Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(typegen): banner comment option #179

Merged
merged 6 commits into from
Feb 29, 2024
Merged

feat(typegen): banner comment option #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7b63683
feat(typegen): banner optional for cli
pas-mike Dec 20, 2023
733a53c
refactor: changed banner options description
pas-mike Jan 29, 2024
9fcfc9d
Merge branch 'main' into typegen-banner-option
pas-mike Jan 29, 2024
93023de
Merge branch 'openapistack:main' into typegen-banner-option
pas-mike Feb 15, 2024
7425620
refactor(typegen): moved banner into generateTypesForDocument
pas-mike Feb 15, 2024
9834f68
refactor(typegen): removed console log if banner is not set
pas-mike Feb 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/typegen/src/typegen.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@ import { generateTypesForDocument } from './typegen';
const examplePetAPIYAML = path.join(__dirname, '__tests__', 'resources', 'example-pet-api.openapi.yml');

describe('typegen', () => {
let banner: string;
let imports: string;
let schemaTypes: string;
let operationTypings: string;

beforeAll(async () => {
const types = await generateTypesForDocument(examplePetAPIYAML, {
transformOperationName: (operationId: string) => operationId,
banner: '/* eslint-disable */',
disableOptionalPathParameters: true,
});
imports = types[0];
schemaTypes = types[1];
operationTypings = types[2];
banner = types[3];
});

test('generates type files from valid v3 specification', async () => {
Expand Down
18 changes: 16 additions & 2 deletions packages/typegen/src/typegen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { JSONSchema } from '@apidevtools/json-schema-ref-parser/dist/lib/types';
interface TypegenOptions {
transformOperationName?: (operation: string) => string;
disableOptionalPathParameters?: boolean;
banner?: string;
}

interface ExportedType {
Expand All @@ -37,6 +38,11 @@ export async function main() {
alias: 't',
type: 'string',
})
.option('banner', {
alias: 'b',
type: 'string',
description: 'Add banner to generated file',
})
.option('disableOptionalPathParameters', {
type: 'boolean',
description: 'Force all path parameters to be required',
Expand All @@ -49,6 +55,7 @@ export async function main() {

const opts: TypegenOptions = {
transformOperationName: (operation: string) => operation,
banner: argv.banner,
};

if (argv.transformOperationName) {
Expand All @@ -69,7 +76,12 @@ export async function main() {

opts.disableOptionalPathParameters = argv.disableOptionalPathParameters ?? true;

const [imports, schemaTypes, operationTypings] = await generateTypesForDocument(argv._[0] as string, opts);
const [imports, schemaTypes, operationTypings, banner] = await generateTypesForDocument(argv._[0] as string, opts);

if (banner?.length) {
console.log(banner, '\n');
}

console.log(imports, '\n');
console.log(schemaTypes);
console.log(operationTypings);
Expand All @@ -94,6 +106,8 @@ export async function generateTypesForDocument(definition: Document | string, op
await api.init();
const operationTypings = generateOperationMethodTypings(api, exportedTypes, opts);

const banner = opts.banner ?? '';

const imports = [
'import type {',
' OpenAPIClient,',
Expand All @@ -104,7 +118,7 @@ export async function generateTypesForDocument(definition: Document | string, op
`} from 'openapi-client-axios';`,
].join('\n');

return [imports, schemaTypes, operationTypings];
return [imports, schemaTypes, operationTypings, banner];
}

function generateMethodForOperation(
Expand Down