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

chore: move 'utils/rules.ts' to 'rules/index.ts' #439

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

Foxeye-Rinx
Copy link
Contributor

@Foxeye-Rinx Foxeye-Rinx commented Oct 26, 2024

  • The lib/load-rules.ts file is confusing because it behaves like an index file for the src/rules folder, so adding a comment helps clarify its purpose.
  • Rename tools/update-rules.ts to tools/update-rules-index.ts.
  • Move utils/rules.ts to rules/index.ts

Motivation:

  • The first time I saw utils/rules.ts, it was a bit confusing because its behavior is more like an index file for src/rules than a utility.
  • lib/load-rules.ts same as above.
  • Making it an index file and placing it in src/rules makes its purpose clearer.

Potential enhancement (later):

  • Write the original design to the doc under Contributing guidelines section

Need help to review:

  • I don't understand why there is a js import here, the file is a ts file, so I don't know if this change breaks it or not
  • I tried npm run test and it went well
image

- The `lib/load-rules.ts` file is confusing because it behaves like an index file for the src/rules folder, so adding a comment helps clarify its purpose.

- Rename `tools/update-rules.ts` to `tools/update-rules-index.ts`.
- Move `utils/rules.ts` to `rules/index.ts`
Copy link

changeset-bot bot commented Oct 26, 2024

⚠️ No Changeset found

Latest commit: 388e65a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Owner

@ota-meshi ota-meshi left a comment

Choose a reason for hiding this comment

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

The changes in this PR are LGTM! Thank you!

@ota-meshi ota-meshi merged commit 8d9e0a2 into ota-meshi:main Oct 27, 2024
8 checks passed
@Foxeye-Rinx Foxeye-Rinx deleted the unify-rules branch October 27, 2024 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants