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.

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

refactor(open api gateway): improve project structure #42

Merged

Conversation

cogwirrel
Copy link
Member

  • Move the spec dir into src
  • Remove projen project files from spec "project" (unfortunately this needed to be a project so I could make use of SampleFile and synth components early, so I did a bit of a hack to remove the default project files)
  • Rename default parsed spec to .parsed-spec.json
  • BREAKING CHANGE: Combined specDir and specFileName into a single specFile parameter

This gives the following overall structure:

|_ src/
    |_ index.ts
    |_ spec/
        |_ spec.yaml
        |_ .parsed-spec.json
    |_ api/
        |_ index.ts
        |_ api.ts
        |_ sample-api.ts
        |_ sample-api.say-hello.ts
|_ generated/
    |_ typescript/

* Rename `parsed-spec.json` to `.parsed-spec.json` to indicate it doesn't need to be edited (it's
already readonly)
* Move `spec` folder into the source directory alongside `api` source code

BREAKING CHANGE: Combined `specDir` and `specFileName` into a single `specFile` parameter
@nx-cloud
Copy link

nx-cloud bot commented Jun 18, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit a039198. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@agdimech agdimech merged commit 1fda02b into aws:mainline Jun 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants