Thanks for the PR, @bradzacher!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

Codecov Report

Merging #2911 (a5f8933) into master (209f6d0) will decrease coverage by 0.00%.
The diff coverage is 44.44%.

@@            Coverage Diff             @@
##           master    #2911      +/-   ##
==========================================
- Coverage   92.86%   92.85%   -0.01%     
==========================================
  Files         318      318              
  Lines       11048    11048              
  Branches     3129     3128       -1     
==========================================
- Hits        10260    10259       -1     
- Misses        350      352       +2     
+ Partials      438      437       -1     

Flags with carried forward coverage won't be shown. Click here to find out more.

few notes:

1. jsx should be in its own group, and not a "special"
2. there should be separate group for Declarations and Statements -> Declarations are Statements

we could actually follow a lead of typescript or estree on this eg,
https://github.com/estree/estree/blob/390a050fd2d6a7b69688f1434e0929d7c7455d05/es5.md#statements

generally i like this idea, but i feel like this is a little to granular, maybe if we group them a little better we can have set of files that can contain multiple definition

jsx should be in its own group, and not a "special"

sounds like a good idea

there should be separate group for Declarations and Statements -> Declarations are Statements
we could actually follow a lead of typescript or estree on this

This "grouping" was based on the union types we had declared in the old mega file.
We didn't have a "declaration" union type - only DeclarationStatement (which didn't include variable declarations, hence I marked it for removal - it felt like a useless union)

We can nest/organise however we like!

maybe if we group them a little better we can have set of files that can contain multiple definition

Could you provide an example of what you mean by this?

but i feel like this is a little to granular

I wanted each node to have its own folder so that everything is isolated.

Eventually I want to move all the fixtures into this folder as well, and orgnaise them appropriately (even duplicate them as necessary).

The idea is that this "package" will document the types a node adheres to, and includes the examples that can generate each type.

Ideally even going as far as attempting to do every combination for a child.
EG if a property on a node has type "Expression", we should have one fixture which validates each expression type is valid.

It'll be verbose AF, but it ensures our spec is correct, and it provides clear documentation for consumers (and provides great examples for people to borrow and test against).

there is one more thing that bothers me, new package, why do we need it, why not just merge it with types, as thats what this is, types

why not just merge it with types, as thats what this is, types

For the moment, this is just types.

But as mentioned - I want to move the fixtures here, and I want to add markdown docs to describe what a node is and what it represents.

I plan on this being a private package, and using a build step to keep the published types in the types package.

moving fixtures is not really good idea, as we should not ask everyone who wants to use this package to include them in their build

this package is included in types

To clarify.

This PR should result in no actual change in the external API(s).

ast-spec would be a private package that is not published to NPM.
It will contain the following:

• types for the AST (this PR)
• markdown docs explaining the AST
• fixtures

types will contain the types.
via a build step, we will bundle the types from ast-spec and copy them into the types package.
This way the fixtures, documentation, and folder structure are kept private and not published, and that way we don't need to publish another package for no reason.

@armano2 - if you wanted to take another eyeball - this is in a good state to merge as is.
We can follow up with adding docs and fixtures in future PRs.