DEVELOPING.md

Development

• npm test to run cypher builder tests
• npm run build to compile cypher builder library
• npm run docs to generate the API reference docs

Link Cypher Builder locally with yarn

In the Cypher Builder folder run:

• yarn link
• yarn build

In the root of the package run:

• yarn link -p [path-to-local-cypher-builder]

To unlink, in the project using cypher-builder:

• yarn unlink @neo4j/cypher-builder

TSDoc references

Each public element of the library should have a TSDoc comment compatible with TypeDoc. The comments should follow these conventions:

• Brief description
• @group - This should be the Cypher concept related to this interface. Cypher Functions, Clauses, Operators, Procedures, Other Expressions.
• @see Cypher Documentation - A link to the element in the Cypher documentation
• @internal - If used by the library and not exposed
• @example - example of usage and resulting Cypher

* @example
* ```ts
* new Cypher.Match(new Node({labels: ["Movie"]})).optional();
* ```
* _Cypher:_
* ```cypher
* OPTIONAL MATCH (this:Movie)
* ```

Files

• tsdoc.json Defines the tsdoc shcema
• typedoc.json Configures the tool typedoc