8000 docs: fleshed out dedicated Architecture section by JoshuaKGoldberg · Pull Request #4124 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]

Skip to content

docs: fleshed out dedicated Architecture section #4124

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

Merged

Conversation

JoshuaKGoldberg
Copy link
Member
@JoshuaKGoldberg JoshuaKGoldberg commented Nov 11, 2021

PR Checklist

Overview

Creates a Development section with sub-sections for Architecture and Custom Rules.

A few organizational touchups:

  • Flattens the sidebar a level by removing the Guides shorthand section (since everything there is a guide at the moment)
  • Replaced the root README.md's packages info with a link to the more fleshed out docs
  • Moved ASTs into Development > Architecture

Was there anything else we should cover for third-party folks writing their own plugins?

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

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.

@netlify
Copy link
netlify bot commented Nov 11, 2021

✔️ Deploy Preview for typescript-eslint ready!

🔨 Explore the source changes: 26d20b0

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/61906420e40c610007885e2b

😎 Browse the preview: https://deploy-preview-4124--typescript-eslint.netlify.app

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review November 11, 2021 22:33
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Nov 12, 2021
create(context) {
return {
TSInterfaceDeclaration(node) {
if (/\p{Lu}/.test(node.id.name[0])) {
Copy link
Member

Choose a reason for hiding this comment

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

Wait - what is this regex style? Shouldn't it be /[a-z]/?

Copy link
Member Author

Choose a reason for hiding this comment

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

https://unicode.org/reports/tr18/#General_Category_Property

...except, I'm finding it to not be working in my dev tools, so I'll just go ahead and switch.

Copy link
Member

Choose a reason for hiding this comment

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

TIL - i'd never seen it before!
I never mess with unicode though heh

Copy link
Member
@bradzacher bradzacher Nov 14, 2021

Choose a reason for hiding this comment

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

another way to do this which would let it work independent of latin characters is

if (node.id.name[0].toUpperCase() === node.id.name[0]) {

But it's a bit more obtuse for people to understand in a tutorial...!

bradzacher
bradzacher previously approved these changes Nov 14, 2021
Copy link
Member
@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

great work dude! it all is looking good to me!

@bradzacher
Copy link
Member
   5/1037 ./docs/development/architecture/PACKAGES.md 69.17ms X
/home/runner/work/typescript-eslint/typescript-eslint/docs/development/architecture/PACKAGES.md:30:11 - Unknown word (unoptimized)

come on dictionary - it was added to oxford in 2018 - https://english.stackexchange.com/a/246562
SO RUDE honestly.

@bradzacher bradzacher enabled auto-merge (squash) November 14, 2021 01:19
@bradzacher bradzacher disabled auto-merge November 14, 2021 02:35
@bradzacher bradzacher merged commit ebaf947 into typescript-eslint:master Nov 14, 2021
@JoshuaKGoldberg JoshuaKGoldberg deleted the architecture-docs branch November 14, 2021 04:53
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs on using type information in rules Provide documentation for writing eslint rules in typescript
3 participants
0