Test @example in TurfJS core

[DenisCarriere]

Test @example in TurfJS core

Going to start testing the @example directly in TurfJS core, that way we don't have switch back and forth between turf-www & turf. Used/updated the existing code that was being used in turf-www/test/build.js.

How to use

$ cd turf/packages/turf
$ npm test
$ node test.example.js

To-Do

• Fix @example errors

Quite a few already - can use this PR #857

• Include addToMap validation tests - Publishing updates to TurfJS website turf-www#113 (comment)
• Add node test.example in package.json => scripts => posttest

once all the errors are fixed

• Add DocumentationJS linting

same as turf-www => lintAPI

• Drop this testing in turf-www

the turf-www repo will only focus on building the website and not be used for validation or linting

This was suppose to be a PR and not pushed directly to master "Commit 46756c2" (thought I disabled that - guess not 😝)

CC: @stebogit @rowanwins @tmcw @morganherlocker

[stebogit]

the turf-www repo will only focus on building the website and not be used for validation or linting

👍 👍 @DenisCarriere

[stebogit]

• Add DocumentationJS linting

@DenisCarriere should I just add

"test": "npm run lint && lerna bootstrap && tap packages/*/test.js && npm run types && npm run lintAPI",
"lintAPI": "documentation lint turf/packages/turf-*/index.js",

turf/package.json?

EDIT: I tryed and it works only if ran directly (npm run lintAPI); otherwise it is not executed. Is it ok adding it at the end of the other tests?
BTW the unkink complex.json test fails, might that be a reason why the lintAPI test is not executed when run npm test?

[DenisCarriere]

👍 We should include this documentation linting.

@stebogit we can also use the post/pre to run our scripts, this will chain the npm scripts.

"lint": "eslint packages",
"postlint": "documentation lint packages/turf-*/index.js",

I'm getting warnings (which = as errors in TravisCI), but these seem pretty easy to fix.

$ npm run lint

> @4.0.0 lint /Users/mac/Github/turf
> eslint packages


> @4.0.0 postlint /Users/mac/Github/turf
> documentation lint packages/turf-*/index.js

/Users/mac/Github/turf/packages/turf-bbox-polygon/index.js
        9:1  warning  unknown tag @addToMap

/Users/mac/Github/turf/packages/turf-boolean-contains/index.js
      220:1  warning  type Boolean found, boolean is standard

/Users/mac/Github/turf/packages/turf-boolean-crosses/index.js
      146:1  warning  type Boolean found, boolean is standard

/Users/mac/Github/turf/packages/turf-boolean-point-on-line/index.js
       38:1  warning  type String found, string is standard

/Users/mac/Github/turf/packages/turf-meta/index.js
      468:1  warning  type object found, Object is standard
      741:1  warning  unknown tag @turf
      760:1  warning  unknown tag @turf

/Users/mac/Github/turf/packages/turf-square/index.js
       10:1  warning  unknown tag @addToMap

⚠ 8 warnings

[DenisCarriere]

Finally dropped all tests & linting from turf-www since it's implemented directly in TurfJS.