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

Relocate geojson-rbush module into turf monorepo for easier maintenance #2523

Merged

Conversation

smallsaucepan
Copy link
Member

PR to bring the currently standalone geojson-rbush repo in to the Turf monorepo. Per the standalone project it's not meant to be used outside of Turf, so might as well make it part of the overall project for ease of integration and maintenance.

Not sure if it's been kept separate due to some project history. Did make attempts to find out though wasn't able to establish anything concrete.

This PR would be part one of a two step process. Once this PR is merged and the module published (presumably as part of 7.0.0-alpha.3) packages that depend on geojson-rbush can be switched over to use @turf/rbush for alpha.4

Please fill in this template.

  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Have read How To Contribute.
  • Run npm test at the sub modules where changes have occurred.
  • Run npm run lint to ensure code style at the turf module level.

Submitting a new TurfJS Module.

Sort of? This is essentially an existing module. Retained README, etc as best as possible from standalone repo. Can revise if need be.

Copy link
Collaborator

@mfedderly mfedderly left a comment

Choose a reason for hiding this comment

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

I didn't review the code files too closely, since I assume they're copy/paste. If you want me to be more thorough let me know. I'd be happy to merge this after changing the package name to @turf/geojson-rbush

packages/turf-rbush/package.json Outdated Show resolved Hide resolved
packages/turf-rbush/LICENSE.geojson-rbush Outdated Show resolved Hide resolved
packages/turf-rbush/README.md Outdated Show resolved Hide resolved
packages/turf/test.js Show resolved Hide resolved
…he turf monorepo for easier maintenance. Not building yet. Only establishing a clear snapshot for handover between the repos.
…ment - in case we need to add a vanilla rbush module one day.
… changes to readme for now as it should eventually be generated automatically from the code. Will work on JSDocs at the same time as we start using this module from other places within the monorepo.
@smallsaucepan smallsaucepan merged commit c11f76b into Turfjs:master Nov 3, 2023
3 checks passed
smallsaucepan added a commit to smallsaucepan/turf that referenced this pull request Nov 3, 2023
smallsaucepan added a commit that referenced this pull request Nov 3, 2023
… and regenerate all readmes (#2528)

* Fix generate-docs to work with tsx (add extension, fix a few TS errors). monorepolint rule changed to reflect ts file extension. Add node to eslint env config so editors can find definitions of node variables (such as __dirname) used in scripts.

* Change project root docs target to use tsx and generate-docs.ts. Tighten up gnerates-docs.ts folder globbing - was inadvertently matching when my working parent directory was named something like ~/code/turf-docs-test/... interpreting docs-test as a package name. Reworded readme postfix content to be clearer on the different ways of installing. Updated a few links from http to https.

* Result of running yarn docs from the project root with the previously committed changes.

* Applying recently merged changes (from PR #2523) to this new module.
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.

2 participants