Skip to content

[typescript-axios] / #12828: Add ESM support to typescript-axios client #13586

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

Merged
macjohnny merged 4 commits into from
Oct 7, 2022
Merged

[typescript-axios] / #12828: Add ESM support to typescript-axios client #13586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
973f392
add ESM support to typescript-axios client
miniengineer Oct 4, 2022
a558fa0
add module path to the package json template
miniengineer Oct 5, 2022
2e47ac0
module must be commonjs
miniengineer Oct 5, 2022
2840e67
generate samples
miniengineer Oct 6, 2022
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
4 changes: 4 additions & 0 deletions ...erator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,10 @@ private void addNpmPackageGeneration() {
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
supportingFiles.add(new SupportingFile("package.mustache", "", "package.json"));
supportingFiles.add(new SupportingFile("tsconfig.mustache", "", "tsconfig.json"));
// in case ECMAScript 6 is supported add another tsconfig for an ESM (ECMAScript Module)
if (supportsES6) {
supportingFiles.add(new SupportingFile("tsconfig.esm.mustache", "", "tsconfig.esm.json"));
}
}

@Override
Expand Down
6 changes: 5 additions & 1 deletion modules/openapi-generator/src/main/resources/typescript-axios/package.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@
"license": "Unlicense",
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
{{#supportsES6}}
"module": "./dist/esm/index.js",
"sideEffects": false,
{{/supportsES6}}
"scripts": {
"build": "tsc --outDir dist/",
"build": "tsc {{#supportsES6}}&& tsc -p tsconfig.esm.json{{/supportsES6}}",
Comment thread
macjohnny marked this conversation as resolved.
"prepare": "npm run build"
},
"dependencies": {
Expand Down
7 changes: 7 additions & 0 deletions modules/openapi-generator/src/main/resources/typescript-axios/tsconfig.esm.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"module": "esnext",
"outDir": "dist/esm"
}
}
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/typescript-axios/tsconfig.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"compilerOptions": {
"declaration": true,
"target": "{{#supportsES6}}ES6{{/supportsES6}}{{^supportsES6}}ES5{{/supportsES6}}",
"module": "{{#supportsES6}}ES6{{/supportsES6}}{{^supportsES6}}CommonJS{{/supportsES6}}",
"module": "commonjs",
"noImplicitAny": true,
"outDir": "dist",
"rootDir": ".",
Expand Down
31 changes: 31 additions & 0 deletions ...test/java/org/openapitools/codegen/typescript/axios/TypeScriptAxiosClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
package org.openapitools.codegen.typescript.axios;

import org.openapitools.codegen.CodegenConstants;
import org.openapitools.codegen.SupportingFile;
import org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen;
import org.openapitools.codegen.typescript.TypeScriptGroups;
import org.testng.annotations.Test;

import static org.testng.Assert.assertEquals;
import static org.assertj.core.api.Assertions.assertThat;

@Test(groups = {TypeScriptGroups.TYPESCRIPT, TypeScriptGroups.TYPESCRIPT_AXIOS})
public class TypeScriptAxiosClientCodegenTest {
Expand Down Expand Up @@ -80,4 +82,33 @@ public void testToEnumVarNameUpperCaseNamingType() {
assertEquals(codegen.toEnumVarName("b", "string"), "B");
}

@Test
public void containsESMTSConfigFileInCaseOfES6AndNPM() {
TypeScriptAxiosClientCodegen codegen = new TypeScriptAxiosClientCodegen();

codegen.additionalProperties().put("npmName", "@openapi/typescript-axios-petstore");
codegen.additionalProperties().put("snapshot", false);
codegen.additionalProperties().put("npmVersion", "1.0.0-SNAPSHOT");
codegen.setSupportsES6(true);

codegen.processOpts();

assertThat(codegen.supportingFiles()).contains(new SupportingFile("tsconfig.mustache", "", "tsconfig.json"));
assertThat(codegen.supportingFiles()).contains(new SupportingFile("tsconfig.esm.mustache", "", "tsconfig.esm.json"));
}

@Test
public void doesNotContainESMTSConfigFileInCaseOfES5AndNPM() {
TypeScriptAxiosClientCodegen codegen = new TypeScriptAxiosClientCodegen();

codegen.additionalProperties().put("npmName", "@openapi/typescript-axios-petstore");
codegen.additionalProperties().put("snapshot", false);
codegen.additionalProperties().put("npmVersion", "1.0.0-SNAPSHOT");
codegen.setSupportsES6(false);

codegen.processOpts();

assertThat(codegen.supportingFiles()).contains(new SupportingFile("tsconfig.mustache", "", "tsconfig.json"));
assertThat(codegen.supportingFiles()).doesNotContain(new SupportingFile("tsconfig.esm.mustache", "", "tsconfig.esm.json"));
}
}
1 change: 1 addition & 0 deletions samples/client/petstore/typescript-axios/builds/es6-target/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ configuration.ts
git_push.sh
index.ts
package.json
tsconfig.esm.json
tsconfig.json
4 changes: 3 additions & 1 deletion samples/client/petstore/typescript-axios/builds/es6-target/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
"license": "Unlicense",
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
"module": "./dist/esm/index.js",
"sideEffects": false,
"scripts": {
"build": "tsc --outDir dist/",
"build": "tsc && tsc -p tsconfig.esm.json",
"prepare": "npm run build"
},
"dependencies": {
Expand Down
7 changes: 7 additions & 0 deletions samples/client/petstore/typescript-axios/builds/es6-target/tsconfig.esm.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"module": "esnext",
"outDir": "dist/esm"
}
}
2 changes: 1 addition & 1 deletion samples/client/petstore/typescript-axios/builds/es6-target/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"compilerOptions": {
"declaration": true,
"target": "ES6",
"module": "ES6",
"module": "commonjs",
"noImplicitAny": true,
"outDir": "dist",
"rootDir": ".",
Expand Down
2 changes: 1 addition & 1 deletion ...etstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
"scripts": {
"build": "tsc --outDir dist/",
"build": "tsc ",
"prepare": "npm run build"
},
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion ...tstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"compilerOptions": {
"declaration": true,
"target": "ES5",
"module": "CommonJS",
"module": "commonjs",
"noImplicitAny": true,
"outDir": "dist",
"rootDir": ".",
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/typescript-axios/builds/with-npm-version/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"main": "./dist/index.js",
"typings": "./dist/index.d.ts",
"scripts": {
"build": "tsc --outDir dist/",
"build": "tsc ",
"prepare": "npm run build"
},
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/typescript-axios/builds/with-npm-version/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"compilerOptions": {
"declaration": true,
"target": "ES5",
"module": "CommonJS",
"module": "commonjs",
"noImplicitAny": true,
"outDir": "dist",
"rootDir": ".",
Expand Down