Feature/support generate swagge for typescript (#608) #641

yazaldefilimone · 2023-07-21T16:48:32Z

Checklist

run npm run test and npm run benchmark
tests and/or benchmarks are included
documentation is changed or added
commit message and code follows the Developer's Certification of Origin
and the Code of conduct

…hen using --watch #558

… arguments that change the environment variable

yazaldefilimone · 2023-07-21T16:53:30Z

#608

mcollina

Thanks for sending a PR! I don't think we should add ts-node as a dependency :(, as it's too opinionated and subjected to TypeScript semver rules.
Note that the generator does not use ts-node either.

I would recommend you try a different approach:

load tsconfig.json and check the outDir folder
load the application from there
if outDir is not built, error telling the user to build the folder
adjust the typescript template to add a "swagger" script

There seems to be quite a few linting issues that are spurious. Did you enable prettier format-on-save for all files in VSCode?

mcollina · 2023-07-24T07:59:32Z

util.js

+  requireFastifyForModule,
+  showHelpForCommand,
+  requireServerPluginFromPath
+}


why this change?

mcollina · 2023-07-24T07:59:37Z

util.js

    fs.existsSync('/run/secrets/kubernetes.io/serviceaccount/token')
+  )


why this change?

mcollina · 2023-07-24T07:59:39Z

util.js

@@ -94,14 +118,23 @@ function showHelpForCommand (commandName) {
    console.log(fs.readFileSync(helpFilePath, 'utf8'))
    exit()
  } catch (e) {
-    exit(`unable to get help for command "${commandName}"`)
+    exit(`unable to get help for command '${commandName}'`)


why this change?

mcollina · 2023-07-24T07:59:48Z

util.js

+    throw new Error(
+      'Async/Await plugin function should contain 2 arguments. ' +
+      'Refer to documentation for more information.'
+    )


why this change?

mcollina · 2023-07-24T07:59:53Z

util.js

-      throw new Error(`fastify-cli cannot import plugin at '${resolvedModulePath}'. Your version of node does not support ES modules. To fix this error upgrade to Node 14 or use CommonJS syntax.`)
+      throw new Error(
+        `fastify-cli cannot import plugin at '${resolvedModulePath}'. Your version of node does not support ES modules. To fix this error upgrade to Node 14 or use CommonJS syntax.`
+      )


why this change?

mcollina · 2023-07-24T08:00:02Z

util.js

-    throw new Error(`${resolvedModulePath} doesn't exist within ${process.cwd()}`)
+    throw new Error(
+      `${resolvedModulePath} doesn't exist within ${process.cwd()}`
+    )


why this change?

mcollina · 2023-07-24T08:00:08Z

util.js

+      ? 'module'
+      : commonjsPattern.test(fname)
+        ? 'commonjs'
+        : packageType) || 'commonjs'


why this change?

mcollina · 2023-07-24T08:00:12Z

util.js

+const moduleSupport = semver.satisfies(
+  process.version,
+  '>= 14 || >= 12.17.0 < 13.0.0'
+)


why this change?

…t swagger in templete

yazaldefilimone · 2023-07-24T11:31:47Z

Thanks for sending a PR! I don't think we should add ts-node as a dependency :(, as it's too opinionated and subjected to TypeScript semver rules. Note that the generator does not use ts-node either.

I would recommend you try a different approach:

load tsconfig.json and check the outDir folder

load the application from there

if outDir is not built, error telling the user to build the folder

adjust the typescript template to add a "swagger" script

There seems to be quite a few linting issues that are spurious. Did you enable prettier format-on-save for all files in VSCode?

Thanks for the feedback! I appreciate your guidance, and I've already implemented the suggested, regarding the linting issues, I've taken care of them.
I'm glad to contribute to the project's improvement, I hope I can still bring great contributions!

mcollina · 2023-07-24T12:50:54Z

Code LGTM, a test is missing.

yazaldefilimone · 2023-08-07T16:26:47Z

Hello, sorry for make you await, but you can tell me, how test it, i think test is about confirm if genereta ts incluede swagger script

mcollina · 2023-08-08T08:10:39Z

Hello, sorry for make you await, but you can tell me, how test it, i think test is about confirm if genereta ts incluede swagger script

Yes.

I think you should add the required logic in https://github.com/fastify/fastify-cli/blob/master/test/generate-typescript.test.js.

I would recommend adding a test similar to

fastify-cli/test/generate-typescript.test.js

Line 103 in a444cd8

test('should finish successfully with typescript template', async (t) => {

that verifies that the file is generated for the TS app.

yazaldefilimone · 2023-08-10T18:00:10Z

Hello, sorry for make you await, but you can tell me, how test it, i think test is about confirm if genereta ts incluede swagger script

Yes.

I think you should add the required logic in https://github.com/fastify/fastify-cli/blob/master/test/generate-typescript.test.js.

I would recommend adding a test similar to

fastify-cli/test/generate-typescript.test.js

Line 103 in a444cd8

test('should finish successfully with typescript template', async (t) => {

that verifies that the file is generated for the TS app.

Done it, thanks for explain me!

mcollina · 2023-08-11T07:52:26Z

The test is still missing. You would want to add a new test that calls that new command that you added.

yazaldefilimone added 6 commits November 7, 2022 14:39

fix: prevented .env values from overwriting existing env values w…

2a6092c

…hen using --watch #558

fix: prevented .env values from overwriting existing env values w…

591a701

…hen using --watch #558

test: world because when making a restart the server still passes the…

ea3f814

… arguments that change the environment variable

Merge branch 'fastify:master' into master

aae3516

Merge branch 'fastify:master' into master

fdf941e

feat(util): support generating Swagger in TypeScript files

2a9e49f

yazaldefilimone mentioned this pull request Jul 21, 2023

generate-swagger doesn't work with typescript code #608

Open

2 tasks

fix(lint): to automatically fix some problems

05f0167

mcollina requested changes Jul 24, 2023

View reviewed changes

yazaldefilimone added 2 commits July 24, 2023 12:56

refactor: remove ts swagger generate

0e476fc

feat(swagger-generate): support ts file without ts-node and add scrip…

69a78aa

…t swagger in templete

fix: lint formatted

05be969

test: ensure generate typescript templete with swagger script

670e2a4

yazaldefilimone closed this by deleting the head repository Mar 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/support generate swagge for typescript (#608) #641

Feature/support generate swagge for typescript (#608) #641

yazaldefilimone commented Jul 21, 2023

yazaldefilimone commented Jul 21, 2023

mcollina left a comment •

edited

Loading

mcollina Jul 24, 2023

mcollina Jul 24, 2023

mcollina Jul 24, 2023

mcollina Jul 24, 2023

mcollina Jul 24, 2023

mcollina Jul 24, 2023

mcollina Jul 24, 2023

mcollina Jul 24, 2023

yazaldefilimone commented Jul 24, 2023

mcollina commented Jul 24, 2023

yazaldefilimone commented Aug 7, 2023

mcollina commented Aug 8, 2023

yazaldefilimone commented Aug 10, 2023

mcollina commented Aug 11, 2023

		fs.existsSync('/run/secrets/kubernetes.io/serviceaccount/token')
		)

Feature/support generate swagge for typescript (#608) #641

Feature/support generate swagge for typescript (#608) #641

Conversation

yazaldefilimone commented Jul 21, 2023

Checklist

yazaldefilimone commented Jul 21, 2023

mcollina left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yazaldefilimone commented Jul 24, 2023

mcollina commented Jul 24, 2023

yazaldefilimone commented Aug 7, 2023

mcollina commented Aug 8, 2023

yazaldefilimone commented Aug 10, 2023

mcollina commented Aug 11, 2023

mcollina left a comment •

edited

Loading