Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

chore: exclude docs/ directory from eslint-plugin package#11251

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
roottool wants to merge2 commits intotypescript-eslint:main
base:main
Choose a base branch
Loading
fromroottool:exclude-docs-in-eslint-plgin-package

Conversation

roottool
Copy link

PR Checklist

Overview

This PR excludesdocs/ directory from the published@typescript-eslint/eslint-plugin package.

I converted fromREADME.md to./README.md infiles ofpackage.json. This is becausedocs/rules/README.md is included in the eslint-plugin package afterdocs/ directory is excluded. I checked it withyarn pack --dry-run.

As an aside, I think thatREADME.md infiles can be deleted.README is always included in thisfiles config.

Certain files are always included, regardless of settings:

  • package.json
  • README
  • LICENSE /LICENCE
  • The file in the "main" field
  • The file(s) in the "bin" field

files - package.json | npm Docs

@typescript-eslint
Copy link
Contributor

Thanks for the PR,@roottool!

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 onhttps://opencollective.com/typescript-eslint.

@netlifyNetlify
Copy link

netlifybot commentedMay 28, 2025
edited
Loading

Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commitdb9e2c5
🔍 Latest deploy loghttps://app.netlify.com/projects/typescript-eslint/deploys/6837380b566afb0008b24ac7
😎 Deploy Previewhttps://deploy-preview-11251--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 99 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify project configuration.

@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedMay 28, 2025
edited
Loading

View yourCI Pipeline Execution ↗ for commitdb9e2c5.

CommandStatusDurationResult
nx typecheck ast-spec✅ Succeeded<1sView ↗
nx run-many -t build --exclude website website-...✅ Succeeded4sView ↗
nx run-many -t clean --parallel=20✅ Succeeded13sView ↗

☁️Nx Cloud last updated this comment at2025-05-28 16:33:54 UTC

Copy link
Member

@kirkwaiblingerkirkwaiblinger left a comment

Choose a reason for hiding this comment

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

Looks good to me! Nice eagle eyes on thedocs/rules/README.md inclusion.

roottool reacted with laugh emoji
@kirkwaiblinger
Copy link
Member

As an aside, I think thatREADME.md infiles can be deleted.README is always included in thisfiles config.

Certain files are always included, regardless of settings:

  • package.json
  • README
  • LICENSE /LICENCE
  • The file in the "main" field
  • The file(s) in the "bin" field

files - package.json | npm Docs

Looks like the yarn equivalent of this also includeschangelog.*, interestingly, explaining howCHANGELOG.md gets in there 🤷‍♂️. Seeyarn docs onfiles field ->their inclusion list.

I'm happy for us to omit explicit README and LICENSE from thefiles array but don't feel strongly. Feel free to update that before this gets merged if you prefer 👍

roottool reacted with eyes emoji

@kirkwaiblingerkirkwaiblinger added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labelMay 29, 2025
@roottool
Copy link
Author

Thank you for reviewing!

I'm happy for us to omit explicit README and LICENSE from the files array but don't feel strongly. Feel free to update that before this gets merged if you prefer 👍

I decided not to omit them. I thought it was odd that./ was only in the README when I looked at it without understanding the background. However, it's no strong reason to omit the files with me.

kirkwaiblinger reacted with thumbs up emoji

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@kirkwaiblingerkirkwaiblingerkirkwaiblinger approved these changes

Assignees
No one assigned
Labels
1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Performance: [eslint-plugin] Stop publishing docs/ directory to npm
2 participants
@roottool@kirkwaiblinger

[8]ページ先頭

©2009-2025 Movatter.jp