visgl / deck.gl-community Goto Github PK

Blocked on #10 #11 and setting up the npm org.

• we have a docusaurus website running locally
• and somehow even the jest tests are “working” when we run yarn test node,
• however we get silent failure on browser tests:
• when we comment out all modules, it starts but browser doesn’t find index.html on the specified port.

Determine best names for what are current graph-gl and react-graph-gl, maybe it should be something to reflect a core, layers, and the react component?

Background

nebula.gl has become stale and it is not possible to migrate it to deck.gl v9 easily. A number of project depend on it, in particular the EditableGeojsonLayer. In order to move forward, the code will be moved into this repo and published under a new npm package

Tasks

• Add EditableGeojsonLayer & related code from nebula.g repo #37 @ibgreen
• Publish deck.gl-community website @ibgreen
• Update rest of repo to v9 (tracker) @donmccurdy
• Apply the fixes needed for v9 EditableGeojsonLayer @donmccurdy
• Decide on package naming convention
• Publish package to npm
• Migrate tests to modern tooling @donmccurdy
• Make all nebula.gl examples build again
  • editor-core/editor
  • editor-core/advanced
  • editor-core/editable-h3-cluster-layer
  • editor-core/sf (⚠️ renders, but throws errors)
  • editor-core/overlays
  • editor-core/no-map
  • editor-core/getting-started
  • editor-core/codesandbox
• Modernize nebula.gl examples (React 18, functional components, etc)
• Add nebula examples to website.

Im not able to run the examples. Steps I performed

git clone <repo>
npm i
npm run build # build works

I am not able to run the tests, getting below error

TSError: ⨯ Unable to compile TypeScript:
error TS6046: Argument for '--module' option must be: 'none', 'commonjs', 'amd', 'system', 'umd', 'es6', 'es2015', 'es2020', 'es2022', 'esnext', 'node12', 'nodenext'.

I am using
node v18.16.1 and tried with v16

If you can you update the Readme or add steps to run different modules, examples and the website that will be great. Thanks

For testing the graph layer, I just copied required jsx files into my project and tested it out.

Port examples from old website for graphgl.

Publish new website somewhere.

Forking old repositories into this repo is just the first step. We need to review the APIs and make sure they are will consistent.

• editable-layers
  • MeshLayer - is it still needed? Docs says it should be replaced
• graph-layers
  • MarkerLayer seems very generic, including icon packing script
• react-editable-layers (goal: remove entire module)
  • Strip out non-graph specific react functionality
  • Create new react module
  • Move overlays to new react module
  • Move EditorModal to new react module
  • ExportModal - is this still needed? can we just move into examples?
  • Toolbox component - is this needed? In that case shouldn't it be React independent? Could it be a widget?
• deckgl-react-graph-layers
  • Move button, viewport to generic react module
  • GraphGL component / hook is quite big - if so much helper code is needed, port to pureJS? Could it be a widget?

v9

• Update modules/* to build against deck.gl v9
• Get all unit tests passing (with Jest-style syntax, Deck v9, and TypeScript)
• Get all examples passing and migrated to TypeScript
  • #15
  • #38
  • fix 'graph-layers' examples
  • add 'layers' examples
  • Add @deck.gl-community/editable-layers to example dependencies after it's published
    #63
• Migrate modules/* to TypeScript
  • #14
• Update modules/*/test/* to Jest-style tests
  • Could use Jest, Vitest, or Bun as the test runner. Consider options and make a decision. Vitest seems more batteries-included and ESM-friendly than Jest, where ESM is experimental. No opinion on Bun yet.
  • #41
  • #42
  • #45
  • #46
• Fix ESLint and TSC errors and warnings as practical
  • #53
  • #54
  • #55
  • #64