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

chore(repository): improve repository structure and naming #11

Merged
merged 6 commits into from
Nov 19, 2021

Conversation

shortcuts
Copy link
Member

Summary

Since we want to go for a monorepo I thought it was needed to improve its structure so we can iterate on our tooling/other API clients in parallel.

There should be no code changes, only some renaming/restructuring.

Test

See the proposed structure here: https://github.com/algolia/api-client-automation-experiment/tree/chore/repository or locally

README.md Show resolved Hide resolved
doc/contribution_addNewClient.md Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth keeping the utils folder with the outdated spec ?

@shortcuts
Copy link
Member Author

Is it worth keeping the utils folder with the outdated spec ?

I was also wondering if I should delete them or not, I guess we can keep them until we re-write the recommend specs

@millotp
Copy link
Collaborator

millotp commented Nov 18, 2021

Ah true the recommend is not in the specs yet

clients/README.md Show resolved Hide resolved
return url;
}

export function serializeQueryParameters(parameters: Readonly<Record<string, any>>): string {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not related to this PR: Is this function replacable with new UrlSearchParams?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is yes, some things are deprecated but I wanted to have the same behavior as the client at first.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair enough, we might want to investigate after we have some test in place

damcou
damcou previously approved these changes Nov 18, 2021
Copy link
Contributor

@damcou damcou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked directly with you both, I like the new structure, just make sure that the current issue on setup will be fixed once the tests are generated ;)

@millotp
Copy link
Collaborator

millotp commented Nov 18, 2021

Can you rename javascript-client-template in just javascript please ?

@shortcuts
Copy link
Member Author

Is it worth keeping the utils folder with the outdated spec ?

I've removed the old search_spec.yml file since we now have a more concrete one

package.json Show resolved Hide resolved
package.json Show resolved Hide resolved
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.

4 participants