Renaming of modules for next Major release (v5.0)

[DenisCarriere]

Renaming modules proposal (v5.0)

This issue is used for tracking the renaming of modules in the next major release (v5.0):

• point-on-surface => point-on-feature -> technically Points and Lines do not have a surface
• linestring-to-polygon => line-to-polygon -> to keep it consistent with the other "line" modules
• polygon-to-linestring => polygon-to-line
• @turf/inside => @turf/boolean-point-in-polygon Renaming of modules for next Major release (v5.0) #860 (comment)
• @turf/within => @turf/points-within-polygon Renaming of modules for next Major release (v5.0) #860 (comment)
• @turf/bezier => @turf/bezier-spline Issue New module proposal for @turf/bezier-curve #661
• @turf/nearest => @turf/nearest-point Initial commit of booleanPointOnLine #858 (comment)
• @turf/point-on-line => @turf/nearest-point-on-line Initial commit of booleanPointOnLine #858 (comment)
• @turf/lineDistance => @turf/length Renaming of modules for next Major release (v5.0) #860 (comment)
• @turf/helpers
  • radians2degrees => radiansToDegrees
  • degrees2radians => degreesToRadians
  • distanceToDegrees => lengthToDegrees
  • distanceToRadians => lengthToRadians
  • radiansToDistance => radiansToLength
  • bearingToAngle => bearingToAzimuth
  • convertDistance => convertLength

[rowanwins]

Great idea!

radians2degrees should change to radiansToDegrees
degrees2radians should change to degreesToRadians
within should change to something... perhaps pointsWithinPolygon
inside should change to booleanPointInPolygon (if we were to follow the pattern that is unfolding, although Im not 100% set on it)
lineDistance could change to perimeterDistance

Possibles

explode could be featureVerticesToPoints
combine could be singlePartToMultiPart
flatten could be multiPartToSinglePart
kinks could be selfIntersections

[stebogit]

I'd suggest
lineDistance => length (buddy of area)
combine => toMultiFeature
explode => getVertices; even though I like explode and I would rather improve it adding a parameter like output =vertices|segments to return, obviously, a FeatureCollection of Points or LineStrings
flatten => I think we should keep the name, cause it match with flattenEach and flattenReduce, a known "function"
inside => booleanPointInPolygon 👍
within => pointsWithinPolygon 👍

Based on #684, I'd add these:
distanceToDegrees => lengthToDegrees
distanceToRadians => lengthToRadians
radiansToDistance => radiansToLength

[DenisCarriere]

I've updated my #860 (comment) with the modules that should be changed, a few of the proposed renaming were a bit too explicit, in my opinion having short & concise names is better for a module.

even though I like explode and I would rather improve it adding a parameter like output =vertices|segments to return, obviously, a FeatureCollection of Points or LineStrings

👍 I like having the idea of having explode return Points or Segments, should be relatively easy to implement with an extra parameter.

As for within & inside... Let's just leave those unchanged for now, until we have the full set of DE-9IM modules 100% tested and working, we can discuss those boolean modules at a later time.

[stebogit]

@DenisCarriere I added also the renaming of @turf/bezier (see #661)

[stebogit]

I'd add

• bearingToAngle => bearingToAzimuth

See azimuth definition

[DenisCarriere]

What about this one too?

• convertDistance => convertLength

[stebogit]

👍 @DenisCarriere

[stebogit]

@DenisCarriere maybe also

• point-on-surface => point-on-feature -> technically Points and Lines do not have a surface
• linestring-to-polygon => line-to-polygon -> to keep it consistent with the other "line" modules

[DenisCarriere]

👍 I like those two as well, i'll do those now.

[DenisCarriere]

also the reverse:

• polygon-to-linestring => polygon-to-line

[DenisCarriere]

Also dropping the string part of those modules makes it less confusion to add a Capital S or lowercase s.

lineStringToPolygon vs. linestringToPolygon

[stebogit]

All done with #1064