add cli directory support (using globs) #238

Ethan-Arrowood · 2019-06-18T20:11:19Z

I'm working on adding cli support for glob patterns and directories of JSON files. This probably isn't complete just yet but I thought I'd share my work so I could get some initial feedback.

Ref #16

I need to familiarize myself with the library more, but it seems like there is need to add this to the programmatic side too (https://github.com/eweap/json-schema-to-typescript/blob/97f91e758317ef3ea5be3b9a1dfdd162051e3a48/src/index.ts#L68-L92). I'll try and use that as a reference

Ethan-Arrowood · 2019-06-19T02:41:42Z

FWIW this may also be better implemented in another library. Something that wraps this one. I'll let the maintainers decide what they'd like best

bcherny

Looks great, thanks for the contribution! What do you think is a good way to unit test this?

src/cli.ts

Ethan-Arrowood · 2019-07-15T17:32:17Z

Okay made changes; working on testing now

Ethan-Arrowood · 2019-07-15T18:42:38Z

Haha testing was a bit of a challenge but I got something working! Let me know what else you'd like for this new feature :)

bcherny

Almost there -- sending this back to your queue.

.vscode/settings.json

src/cli.ts

test/testCLI.ts

src/cli.ts

Ethan-Arrowood · 2019-07-22T01:26:04Z

Thank you for the review; will work on these recommendations soon and push changes!

Ethan-Arrowood · 2019-08-08T17:57:45Z

sorry it has been a little while, got swept up with final projects (yay for still being in college).

Ethan-Arrowood · 2019-08-12T02:12:19Z

The test suite is passing but I'm getting unhandelled promise rejection errors in the console. Trying to track it down now.

Ethan-Arrowood · 2019-11-28T19:16:43Z

@bcherny hey! I'd like to try and complete this PR. I tried rebasing on master and I seem to have messed up the snapshots. Can you advise how I can fix this?

Ethan-Arrowood · 2019-12-17T19:03:25Z

For those looking for directory access I've now published another npm module that implements such https://www.npmjs.com/package/compile-schemas-to-typescript (only api no cli right now)

bcherny · 2019-12-23T20:59:17Z

@Ethan-Arrowood Hey! Missed your comment.

You want to re-generate the snapshots:

git rebase origin/master
yarn test -u

Ethan-Arrowood · 2019-12-28T15:56:31Z

Okay rebased and updated but there is some dep issue? Not sure whats wrong there

bcherny

Getting closer, but this still needs a bit more cleanup and thinking about edge cases. Sending this back to your queue.

Also:

It may be worth defensively running the testCLI.ts tests serially, so they don't step on each others' toes when concurrently interacting with the filesystem. Here's how to do that.
Looking at the error output in CircleCI, the issue is that we're running tests on an old version of NodeJS:

yarn install v1.3.2
...
error @typescript-eslint/[email protected]: The engine "node" is incompatible with this module. Expected version "^8.10.0 || ^10.13.0 || >=11.10.1".
error Found incompatible module
...

To fix that, I just bumped the version of NodeJS we use on CircleCI. If you rebase on the latest master, build should work. :)

src/cli.ts

test/testCLI.ts

Ethan-Arrowood · 2019-12-30T18:59:27Z

Working on adding support for nested directory output now

src/cli.ts

Ethan-Arrowood · 2020-01-02T02:50:46Z

Fixing tests and adding the single output error catch now 😄

Ethan-Arrowood · 2020-01-02T04:53:33Z

So I added the error check, but struggled to write a test for it. execSync isn't processing the error correctly for ava .throws() to catch

Ethan-Arrowood · 2020-01-02T05:04:50Z

@bcherny can you confirm what version of node this library is supposed to support? The package.json says 4.5 but I'm having issues with the @types/node version being so out of date. My latest commit bumps it to latest let me know if I should revert that and use old-style node code instead

Ethan-Arrowood · 2020-01-21T15:21:27Z

Bumping - what are my next steps to get this completed?

bcherny

Looking good -- we're almost there. Sending this back to your queue for one last set of revisions, then we can merge this and publish out a beta for people to try it out.

package.json

src/cli.ts

Ethan-Arrowood · 2020-02-27T21:28:48Z

Sorry for being MIA - will get to this asap (work has picked up significantly)

bcherny · 2020-03-08T20:38:11Z

Want to push the commit? Happy to pull it to help debug.

Ethan-Arrowood · 2020-03-08T20:39:06Z

Yep! Here it is: 5c1e875

bcherny · 2020-03-08T21:24:02Z

@Ethan-Arrowood So you want to pull your pathTransform function into utils.ts, and make a new test file for it -- testUtils.ts. Otherwise, when you import pathTransform from cli.ts, you're accidentally triggering main() in cli.ts, which is throwing your error.

bcherny

Looking good. Ready to merge? Anything else you want to change before we go for it?

Ethan-Arrowood · 2020-03-09T04:21:12Z

I think its ready to go!

bcherny · 2020-03-09T05:51:14Z

@Ethan-Arrowood Mind rebasing?

Ethan-Arrowood · 2020-03-09T19:50:22Z

rebased :D

bcherny

Final couple of comments (sorry, thought we were done). Also, want to do the honors of updating the README?

src/cli.ts

Ethan-Arrowood · 2020-03-11T13:29:45Z

And yes I can update the README!

bcherny

Thanks for the contribution @Ethan-Arrowood -- this is a long time coming!

bcherny · 2020-03-14T18:23:15Z

Published 8.2.0.

Ethan-Arrowood · 2020-03-15T03:10:51Z

Wooo so happy this got merged! I'll be sure to contribute more in the future 😄

Ethan-Arrowood mentioned this pull request Jun 18, 2019

TypeScript Schema Example Documentation fastify/fastify#1668

Closed

bcherny requested changes Jul 14, 2019

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

bcherny requested changes Jul 21, 2019

View reviewed changes

.vscode/settings.json Outdated Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

test/testCLI.ts Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

Ethan-Arrowood force-pushed the feature/glob-support branch from 6c60b63 to ca9d682 Compare August 12, 2019 02:11

Ethan-Arrowood force-pushed the feature/glob-support branch from 1287712 to a496af0 Compare November 28, 2019 19:11

Ethan-Arrowood force-pushed the feature/glob-support branch from a496af0 to 108a099 Compare November 28, 2019 19:29

Ethan-Arrowood force-pushed the feature/glob-support branch 2 times, most recently from 66bf06b to 7f2c9c8 Compare December 28, 2019 15:53

bcherny requested changes Dec 28, 2019

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

src/cli.ts Outdated Show resolved Hide resolved

test/testCLI.ts Outdated Show resolved Hide resolved

test/testCLI.ts Show resolved Hide resolved

Ethan-Arrowood force-pushed the feature/glob-support branch from e2bd33e to 8b42de2 Compare December 30, 2019 18:58

bcherny reviewed Dec 31, 2019

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

Ethan-Arrowood mentioned this pull request Jan 2, 2020

[Feature] Add single file output for multi file input #272

Open

edzis reviewed Jan 2, 2020

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

bcherny requested changes Jan 25, 2020

View reviewed changes

bcherny reviewed Mar 9, 2020

View reviewed changes

Ethan-Arrowood added 13 commits March 9, 2020 15:46

Add directory support

da673c0

updates

92ee8f9

reset vscode settings

4a10f71

fixes on fixes

f8367c9

complete glob and dir support

a8af323

add error check

b276a4b

remove ?.

16df973

use old node friendly methods

f0e4de7

bump @types/node

9b8e2bd

actually add the package.json this time

943f84e

resolve pr comments

350314b

add pathTransform test

2633598

fix util test

8fe487c

Ethan-Arrowood force-pushed the feature/glob-support branch from d6546a9 to 8fe487c Compare March 9, 2020 19:49

bcherny reviewed Mar 11, 2020

View reviewed changes

src/cli.ts Show resolved Hide resolved

src/cli.ts Show resolved Hide resolved

src/cli.ts Show resolved Hide resolved

remove return and add documentation

500528f

Ethan-Arrowood requested a review from bcherny March 11, 2020 19:42

bcherny approved these changes Mar 14, 2020

View reviewed changes

bcherny merged commit a0257d8 into bcherny:master Mar 14, 2020

Ethan-Arrowood mentioned this pull request May 26, 2020

Archive the repo fastify/compile-schemas-to-typescript#8

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add cli directory support (using globs) #238

add cli directory support (using globs) #238

Ethan-Arrowood commented Jun 18, 2019 •

edited

Loading

Ethan-Arrowood commented Jun 19, 2019

bcherny left a comment

Ethan-Arrowood commented Jul 15, 2019

Ethan-Arrowood commented Jul 15, 2019

bcherny left a comment

Ethan-Arrowood commented Jul 22, 2019

Ethan-Arrowood commented Aug 8, 2019

Ethan-Arrowood commented Aug 12, 2019

Ethan-Arrowood commented Nov 28, 2019

Ethan-Arrowood commented Dec 17, 2019

bcherny commented Dec 23, 2019 •

edited

Loading

Ethan-Arrowood commented Dec 28, 2019

bcherny left a comment •

edited

Loading

Ethan-Arrowood commented Dec 30, 2019

Ethan-Arrowood commented Jan 2, 2020

Ethan-Arrowood commented Jan 2, 2020

Ethan-Arrowood commented Jan 2, 2020

Ethan-Arrowood commented Jan 21, 2020

bcherny left a comment

Ethan-Arrowood commented Feb 27, 2020

bcherny commented Mar 8, 2020

Ethan-Arrowood commented Mar 8, 2020

bcherny commented Mar 8, 2020

bcherny left a comment

Ethan-Arrowood commented Mar 9, 2020

bcherny commented Mar 9, 2020

Ethan-Arrowood commented Mar 9, 2020

bcherny left a comment

Ethan-Arrowood commented Mar 11, 2020

bcherny left a comment

bcherny commented Mar 14, 2020

Ethan-Arrowood commented Mar 15, 2020

add cli directory support (using globs) #238

add cli directory support (using globs) #238

Conversation

Ethan-Arrowood commented Jun 18, 2019 • edited Loading

Ethan-Arrowood commented Jun 19, 2019

bcherny left a comment

Choose a reason for hiding this comment

Ethan-Arrowood commented Jul 15, 2019

Ethan-Arrowood commented Jul 15, 2019

bcherny left a comment

Choose a reason for hiding this comment

Ethan-Arrowood commented Jul 22, 2019

Ethan-Arrowood commented Aug 8, 2019

Ethan-Arrowood commented Aug 12, 2019

Ethan-Arrowood commented Nov 28, 2019

Ethan-Arrowood commented Dec 17, 2019

bcherny commented Dec 23, 2019 • edited Loading

Ethan-Arrowood commented Dec 28, 2019

bcherny left a comment • edited Loading

Choose a reason for hiding this comment

Ethan-Arrowood commented Dec 30, 2019

Ethan-Arrowood commented Jan 2, 2020

Ethan-Arrowood commented Jan 2, 2020

Ethan-Arrowood commented Jan 2, 2020

Ethan-Arrowood commented Jan 21, 2020

bcherny left a comment

Choose a reason for hiding this comment

Ethan-Arrowood commented Feb 27, 2020

bcherny commented Mar 8, 2020

Ethan-Arrowood commented Mar 8, 2020

bcherny commented Mar 8, 2020

bcherny left a comment

Choose a reason for hiding this comment

Ethan-Arrowood commented Mar 9, 2020

bcherny commented Mar 9, 2020

Ethan-Arrowood commented Mar 9, 2020

bcherny left a comment

Choose a reason for hiding this comment

Ethan-Arrowood commented Mar 11, 2020

bcherny left a comment

Choose a reason for hiding this comment

bcherny commented Mar 14, 2020

Ethan-Arrowood commented Mar 15, 2020

Ethan-Arrowood commented Jun 18, 2019 •

edited

Loading

bcherny commented Dec 23, 2019 •

edited

Loading

bcherny left a comment •

edited

Loading