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

Add TypeScript guide and recipes #37

Merged

Conversation

ChristianMurphy
Copy link
Member

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

This is based on #36 and specifically aims to address #36 (comment) allowing the single guide version and guide and recipes version to be compared.

This provides:

  • a guide introducing and showing how to import the typings for unist, mdast, hast, and xast
  • a recipe for type safe tree traversal in TypeScript
  • a recipe for node type narrowing in TypeScript
  • a recipe for building a syntax tree in TypeScript

@ChristianMurphy ChristianMurphy added ☂️ area/types This affects typings 📚 area/docs This affects documentation labels Jul 12, 2021
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

this is getting great!

doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/node-type-narrowing-in-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/tree-traversal-typescript.md Show resolved Hide resolved
@ChristianMurphy ChristianMurphy requested a review from a team July 13, 2021 19:08
Co-authored-by: Titus <tituswormer@gmail.com>
doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/build-a-syntax-tree-typescript.md Outdated Show resolved Hide resolved
doc/learn/node-type-narrowing-in-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Outdated Show resolved Hide resolved
doc/learn/syntax-trees-with-typescript.md Show resolved Hide resolved
@wooorm
Copy link
Member

wooorm commented Jul 15, 2021

@ChristianMurphy just a ping, no rush, but would love to have this published!

@ChristianMurphy
Copy link
Member Author

Thanks for the feedback! Updated the documentation

@ChristianMurphy ChristianMurphy requested review from wooorm and a team July 15, 2021 23:37
@wooorm wooorm changed the title docs: typescript guide and recipes Add TypeScript guide and recipes Jul 16, 2021
@wooorm wooorm merged commit 333db3e into unifiedjs:main Jul 16, 2021
@wooorm wooorm added the 💪 phase/solved Post is done label Jul 16, 2021
@ChristianMurphy ChristianMurphy deleted the docs/typescript-guide-and-recipes branch July 16, 2021 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation ☂️ area/types This affects typings 💪 phase/solved Post is done
Development

Successfully merging this pull request may close these issues.

2 participants