Use the standard src/tests paths, move package.json to the root.

[dblock]

Description

In #286 I am adding tests and things are getting messy having to deal with relative paths for tooling (for example, I'd like to lint .js files in tests that are dredd hooks). This PR adopts a more standard layout of tools and tests and moves package.json to the root, making it easier for developers to work in the repo.

A nice side-effect is that we can stop using relative paths in imports in tests by adding baseUrl into tsconfig.json and moduleDirectories: ['node_modules', 'tools'] into jest.config.js.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

API specs implemented for 299/649 (46%) APIs.

[github-actions]

API specs implemented for 299/649 (46%) APIs.

[nhtruong]

Is this specific to dredd? As in can't it be placed in tools folder?

[github-actions]

API specs implemented for 299/649 (46%) APIs.

[dblock]

Is this specific to dredd? As in can't it be placed in tools folder?

It's not. I think working in this repo is unnecessary cumbersome because you have to use relative paths for includes, and having to always remember to cd tools to run them. Tools then have to default to paths above tools (e.g. default output).

When adding spec tests (dredd) we run into an additional problem. Dredd has files such as hooks.js and we will place them into tests/spec (since these are tests for the spec that lives at the root). So now we want to run a linter on those files, but the package.json for the linter lives in ... tools, which is weird.

I could move tools into src/tools/ instead of just src, and still move package.json to the root, but that seems unnecessary.

[dblock]

@nhtruong if your issue is the name src, I renamed it back to tools, but still moved package.json to the root. LMK what you think.

[github-actions]

API specs implemented for 299/649 (46%) APIs.

[nhtruong]

Is this specific to dredd? As in can't it be placed in tools folder?

It's not. I think working in this repo is unnecessary cumbersome because you have to use relative paths for includes, and having to always remember to cd tools to run them. Tools then have to default to paths above tools (e.g. default output).

When adding spec tests (dredd) we run into an additional problem. Dredd has files such as hooks.js and we will place them into tests/spec (since these are tests for the spec that lives at the root). So now we want to run a linter on those files, but the package.json for the linter lives in ... tools, which is weird.

I could move tools into src/tools/ instead of just src, and still move package.json to the root, but that seems unnecessary.

I see. That makes sense. I'm in!

[dblock]

I see. That makes sense. I'm in!

Before merging. Do you prefer tools/... or src/...?

Option A

src/merger, linter
tests/merger, linter

Option B

tools/merger, linter
tests/merger, linter

Option C

tools/merger, linter
tools/tests/merger, linter

[nhtruong]

This is not a nodes.js repo so I prefer tools over src as it tells us that applications in the folder are tools for the repo, not the focal point of the repo.

[dblock]

This is not a nodes.js repo so I prefer tools over src as it tells us that applications in the folder are tools for the repo, not the focal point of the repo.

Ok, and where do you want the tests for tools? B or C?

[nhtruong]

Tests for the tools should be in tools. Test for the spec itself should be at the root of the repo. (So C-ish if that tests folder only refers to the tests for tools)

[nhtruong]

Btw I hope your IDE gives you a hand with renaming/moving files because all of these changes would be very painful without!

[github-actions]

API specs implemented for 299/649 (46%) APIs.

[github-actions]

API specs implemented for 299/649 (46%) APIs.

[dblock]

Tests for the tools should be in tools. Test for the spec itself should be at the root of the repo. (So C-ish if that tests folder only refers to the tests for tools)

Ok. Here's what I did:

1. Moved package.json to root.
2. Moved tools/linter and tools/merger to tools/src, otherwise tools/test looks like a tool.
3. Moved tools/test to tools/tests.
4. No more relative includes.

@nhtruong