Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
### This is a fork of the original project [openapi-codegen](https://github.com/fabien0102/openapi-codegen) by Fabien BERNARD.

<br>
<br>
<br>
Expand Down Expand Up @@ -33,7 +35,7 @@
1. **Initialize the generator**

```bash
npx @openapi-codegen/cli init
npx @sschw/openapi-codegen-cli init
```

<img style="max-width: 400px" src="https://user-images.githubusercontent.com/271912/194000679-5a4501b8-5fc0-430c-9217-028bf91a5dcd.gif">
Expand Down Expand Up @@ -167,11 +169,11 @@ Everything is typed and self-documented, but just in case, you can find here exa

```ts
// openapi-codegen.config.ts
import { defineConfig } from "@openapi-codegen/cli";
import { defineConfig } from "@sschw/openapi-codegen-cli";
import {
generateSchemaTypes,
generateReactQueryComponents,
} from "@openapi-codegen/typescript";
} from "@sschw/openapi-codegen-typescript";

export default defineConfig({
example: {
Expand Down Expand Up @@ -207,7 +209,7 @@ export default defineConfig({

### Plugins

the `@openapi-codegen/cli` supports these generator plugins:
the `@sschw/openapi-codegen-cli` supports these generator plugins:

#### **generateSchemaTypes** (frontend/backend)

Expand Down
6 changes: 4 additions & 2 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
### This is a fork of the original project [openapi-codegen](https://github.com/fabien0102/openapi-codegen) by Fabien BERNARD.

# OpenAPI Codegen

## Getting started
Expand All @@ -6,11 +8,11 @@

```ts
// openapi-codegen.config.ts
import { defineConfig } from "@openapi-codegen/cli";
import { defineConfig } from "@sschw/openapi-codegen-cli";
import {
generateSchemaTypes,
generateReactQueryComponents,
} from "@openapi-codegen/typescript";
} from "@sschw/openapi-codegen-typescript";

export default defineConfig({
example: {
Expand Down
5 changes: 3 additions & 2 deletions cli/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@openapi-codegen/cli",
"name": "@sschw/openapi-codegen-cli",
"version": "3.0.1",
"description": "OpenAPI Codegen cli",
"main": "lib/index.js",
Expand All @@ -9,7 +9,8 @@
"openapi-codegen": "lib/cli.js"
},
"repository": {
"url": "https://github.com/fabien0102/openapi-codegen",
"type": "git",
"url": "git+https://github.com/sschw/openapi-codegen.git",
"directory": "cli"
},
"publishConfig": {
Expand Down
14 changes: 7 additions & 7 deletions cli/src/commands/InitCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export class InitCommand extends Command {
return {
isExistingConfig: false,
sourceFile,
importModules: ["@openapi-codegen/cli"],
importModules: ["@sschw/openapi-codegen-cli"],
};
}

Expand Down Expand Up @@ -236,22 +236,22 @@ export class InitCommand extends Command {
path.join(process.cwd(), "package.json")
);
const hasCli = this.hasDependencyInstalled(
"@openapi-codegen/cli",
"@sschw/openapi-codegen-cli",
packageJson
);
const hasTsPlugin = this.hasDependencyInstalled(
"@openapi-codegen/typescript",
"@sschw/openapi-codegen-typescript",
packageJson
);
if (!hasCli && !hasTsPlugin) {
nextSteps.push("npm install -D @openapi-codegen/{cli,typescript}");
nextSteps.push("npm install -D @sschw/openapi-codegen-{cli,typescript}");
} else if (!hasCli) {
nextSteps.push("npm install -D @openapi-codegen/cli");
nextSteps.push("npm install -D @sschw/openapi-codegen-cli");
} else if (!hasTsPlugin) {
nextSteps.push("npm install -D @openapi-codegen/typescript");
nextSteps.push("npm install -D @sschw/openapi-codegen-typescript");
}
} catch {
nextSteps.push("npm install -D @openapi-codegen/{cli,typescript}");
nextSteps.push("npm install -D @sschw/openapi-codegen-{cli,typescript}");
}
nextSteps.push(`npx openapi-codegen gen ${namespace}`);

Expand Down
6 changes: 3 additions & 3 deletions cli/src/core/generateConfigProperty.ts
Original file line number Diff line number Diff line change
Expand Up @@ -295,21 +295,21 @@ export function getImports(plugin: Plugin): Import[] {
case "typescript/fetch":
return [
{
module: "@openapi-codegen/typescript",
module: "@sschw/openapi-codegen-typescript",
namedImports: ["generateSchemaTypes", "generateFetchers"],
},
];
case "typescript/types-only":
return [
{
module: "@openapi-codegen/typescript",
module: "@sschw/openapi-codegen-typescript",
namedImports: ["generateSchemaTypes"],
},
];
case "typescript/react-query":
return [
{
module: "@openapi-codegen/typescript",
module: "@sschw/openapi-codegen-typescript",
namedImports: ["generateSchemaTypes", "generateReactQueryComponents"],
},
];
Expand Down
40 changes: 23 additions & 17 deletions cli/src/core/updateConfig.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ describe("updateConfig", () => {
);

it("should add import statement if not already existing", () => {
const sourceText = `import { defineConfig } from "@openapi-codegen/cli";
const sourceText = `import { defineConfig } from "@sschw/openapi-codegen-cli";

// This comment should stay
export default defineConfig({})`;
Expand All @@ -20,19 +20,19 @@ describe("updateConfig", () => {

const transformedSourceFile = updateConfig({
sourceFile,
existingImports: ["@openapi-codegen/cli"],
existingImports: ["@sschw/openapi-codegen-cli"],
importsToInsert: [
{
namedImports: ["generateReactQueryComponents", "generateSchemaTypes"],
module: "@openapi-codegen/typescript",
module: "@sschw/openapi-codegen-typescript",
},
],
configProperty,
});

expect(printer.printFile(transformedSourceFile)).toMatchInlineSnapshot(`
"import { generateReactQueryComponents, generateSchemaTypes } from "@openapi-codegen/typescript";
import { defineConfig } from "@openapi-codegen/cli";
"import { generateReactQueryComponents, generateSchemaTypes } from "@sschw/openapi-codegen-typescript";
import { defineConfig } from "@sschw/openapi-codegen-cli";
// This comment should stay
export default defineConfig({
test: {}
Expand All @@ -42,8 +42,8 @@ describe("updateConfig", () => {
});

it("should update import statement if already existing", () => {
const sourceText = `import { defineConfig } from "@openapi-codegen/cli";
import { renameComponent } from "@openapi-codegen/typescript";
const sourceText = `import { defineConfig } from "@sschw/openapi-codegen-cli";
import { renameComponent } from "@sschw/openapi-codegen-typescript";

export default defineConfig({
plop: {}
Expand All @@ -56,19 +56,22 @@ describe("updateConfig", () => {

const transformedSourceFile = updateConfig({
sourceFile,
existingImports: ["@openapi-codegen/cli", "@openapi-codegen/typescript"],
existingImports: [
"@sschw/openapi-codegen-cli",
"@sschw/openapi-codegen-typescript",
],
importsToInsert: [
{
namedImports: ["generateReactQueryComponents", "generateSchemaTypes"],
module: "@openapi-codegen/typescript",
module: "@sschw/openapi-codegen-typescript",
},
],
configProperty,
});

expect(printer.printFile(transformedSourceFile)).toMatchInlineSnapshot(`
"import { defineConfig } from "@openapi-codegen/cli";
import { renameComponent, generateReactQueryComponents, generateSchemaTypes } from "@openapi-codegen/typescript";
"import { defineConfig } from "@sschw/openapi-codegen-cli";
import { renameComponent, generateReactQueryComponents, generateSchemaTypes } from "@sschw/openapi-codegen-typescript";
export default defineConfig({
plop: {},
test: {}
Expand All @@ -78,8 +81,8 @@ describe("updateConfig", () => {
});

it("should not create duplicates imports", () => {
const sourceText = `import { defineConfig } from "@openapi-codegen/cli";
import { renameComponent, generateReactQueryComponents } from "@openapi-codegen/typescript";
const sourceText = `import { defineConfig } from "@sschw/openapi-codegen-cli";
import { renameComponent, generateReactQueryComponents } from "@sschw/openapi-codegen-typescript";

export default defineConfig({})`;
const sourceFile = ts.createSourceFile(
Expand All @@ -90,19 +93,22 @@ describe("updateConfig", () => {

const transformedSourceFile = updateConfig({
sourceFile,
existingImports: ["@openapi-codegen/cli", "@openapi-codegen/typescript"],
existingImports: [
"@sschw/openapi-codegen-cli",
"@sschw/openapi-codegen-typescript",
],
importsToInsert: [
{
namedImports: ["generateReactQueryComponents", "generateSchemaTypes"],
module: "@openapi-codegen/typescript",
module: "@sschw/openapi-codegen-typescript",
},
],
configProperty,
});

expect(printer.printFile(transformedSourceFile)).toMatchInlineSnapshot(`
"import { defineConfig } from "@openapi-codegen/cli";
import { renameComponent, generateReactQueryComponents, generateSchemaTypes } from "@openapi-codegen/typescript";
"import { defineConfig } from "@sschw/openapi-codegen-cli";
import { renameComponent, generateReactQueryComponents, generateSchemaTypes } from "@sschw/openapi-codegen-typescript";
export default defineConfig({
test: {}
});
Expand Down
2 changes: 1 addition & 1 deletion cli/src/templates/emptyConfig.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export default `import { defineConfig } from "@openapi-codegen/cli";
export default `import { defineConfig } from "@sschw/openapi-codegen-cli";

export default defineConfig({});`;
4 changes: 2 additions & 2 deletions examples/frontend/openapi-codegen.config.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import {
generateSchemaTypes,
generateReactQueryComponents,
} from "@openapi-codegen/typescript";
import { defineConfig } from "@openapi-codegen/cli";
} from "@sschw/openapi-codegen-typescript";
import { defineConfig } from "@sschw/openapi-codegen-cli";

export default defineConfig({
github: {
Expand Down
20 changes: 10 additions & 10 deletions examples/frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions examples/frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"react-dom": "^18.0.0"
},
"devDependencies": {
"@openapi-codegen/cli": "^1.5.2",
"@openapi-codegen/typescript": "^5.1.0",
"@sschw/openapi-codegen-cli": "^1.5.2",
"@sschw/openapi-codegen-typescript": "^5.1.0",
"@types/react": "^18.0.0",
"@types/react-dom": "^18.0.0",
"@vitejs/plugin-react": "^1.3.0",
Expand Down
2 changes: 1 addition & 1 deletion examples/frontend/src/github/githubComponents.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Generated by @openapi-codegen
* Generated by @sschw/openapi-codegen
*
* @version 1.1.4
*/
Expand Down
2 changes: 1 addition & 1 deletion examples/frontend/src/github/githubParameters.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Generated by @openapi-codegen
* Generated by @sschw/openapi-codegen
*
* @version 1.1.4
*/
Expand Down
2 changes: 1 addition & 1 deletion examples/frontend/src/github/githubResponses.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Generated by @openapi-codegen
* Generated by @sschw/openapi-codegen
*
* @version 1.1.4
*/
Expand Down
2 changes: 1 addition & 1 deletion examples/frontend/src/github/githubSchemas.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Generated by @openapi-codegen
* Generated by @sschw/openapi-codegen
*
* @version 1.1.4
*/
Expand Down
Loading