rename testEmptyLine to isEmptyLine and change the signature + add wa… - #21
Merged
Conversation
…rning in README about stability
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames the testEmptyLine function to isEmptyLine and improves its API by changing the signature from accepting a union type parameter to using an options object. The version is bumped to 0.0.6, and a versioning policy section is added to the README.
- Renamed
testEmptyLinetoisEmptyLinefor better naming consistency - Changed function signature from
(s, skipEmptyLines?: 'greedy' | boolean)to(s, options?: { greedy?: boolean })for improved API extensibility - Added versioning policy section to README documenting breaking change expectations
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/utils.ts | Updated function name and signature with options object pattern |
| src/index.ts | Exported the renamed isEmptyLine function |
| src/options/delimiter.ts | Updated function call to use new isEmptyLine name |
| tests/utils.test.ts | Updated tests to use new function name and options object |
| tests/text.test.ts | Updated test cases to use new function name and options syntax |
| package.json | Bumped version from 0.0.5 to 0.0.6 |
| package-lock.json | Updated version reference to 0.0.6 |
| README.md | Added "Early version" section with versioning policy |
| CHANGELOG.md | Added entry for version 0.0.6 documenting the changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…rning in README about stability