refactor: convert to TypeScript #7
Merged
Conversation
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
- Add SourceRange, SourcePosition, SourceLocation as types - Remove SourceLocation and SourcePosition class. It becomes just object - Make `source.indice` private
azu
commented
Jan 8, 2023
README.md
Outdated
| const StructuredSource = require('structured-source'); | ||
| import { StructuredSource } from "structured-source"; |
There was a problem hiding this comment.
This is Breaking Change.
User need to use named import.
- import StructuredSource from "structured-source";
+ import { StructuredSource } from "structured-source";This will improve compatibility between transpiler and native ESM.
Comment on lines
-34
to
36
| export class SourceLocation { | ||
| constructor(start, end) { | ||
| this.start = start; | ||
| this.end = end; | ||
| } | ||
| export type SourceLocation = { | ||
| readonly end: SourcePosition, | ||
| readonly start: SourcePosition, | ||
| } |
There was a problem hiding this comment.
Previously, SourceLocation was Class.
However, I read tests and these test treat SourceLocation as JSON.
I think that we can represent SourceLocation as types.
So, I change SourceLocation class to SourceLocation type.
There was a problem hiding this comment.
Previous implementaion fail next test.
const src = new StructuredSource('');
assert.deepStrictEqual(src.locationToRange({ // strict equal does not equal JSON and Class
start: { line: 1, column: 0 },
end: { line: 1, column: 2 }
}), [0, 2]);| */ | ||
| export default class StructuredSource { | ||
| export class StructuredSource { | ||
| private readonly indice: number[]; |
There was a problem hiding this comment.
Make indice private.
Probably, this property is not useful. It is for testing.
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.
Breaking Changes
SourceRange,SourcePosition,SourceLocationas typesSourceLocationandSourcePositionclass. It becomes just objectsource.indiceprivateFeatures
@types/structured-sourcefix #5