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.

Sign up for GitHub

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

Add raw codeFrame and fix JSONError type #37

Merged
merged 7 commits into from
Sep 1, 2023
Merged

Add raw codeFrame and fix JSONError type #37

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f1983cd
fix error type
crondinini Aug 30, 2023
b745b23
expose rawCodeFrame property
crondinini Aug 30, 2023
f6e1fc8
fix linting issues
crondinini Aug 30, 2023
2692e4b
review: use t.is
crondinini Aug 31, 2023
a5760d2
review: add to readme & index
crondinini Aug 31, 2023
3be0ab3
Update index.d.ts
sindresorhus Sep 1, 2023
f1e1a19
Update readme.md
sindresorhus Sep 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type {JsonObject} from 'type-fest';
/**
Exposed for `instanceof` checking.
*/
export type JSONError = Error & { // eslint-disable-line @typescript-eslint/naming-convention
export class JSONError extends Error { // eslint-disable-line @typescript-eslint/naming-convention
/**
The filename displayed in the error message, if any.
*/
Expand All @@ -13,7 +13,7 @@ export type JSONError = Error & { // eslint-disable-line @typescript-eslint/nami
The printable section of the JSON which produces the error.
*/
readonly codeFrame: string;
};
}

// Get 'reviver' parameter from JSON.parse()
type ReviverFn = Parameters<typeof JSON['parse']>['1'];
Expand Down
7 changes: 4 additions & 3 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,14 @@ export default function parseJson(string, reviver, filename) {
const index = Number(indexMatch[1]);
const location = lines.locationForIndex(index);

const codeFrame = codeFrameColumns(
const generateCodeFrame = ({highlightCode}) => codeFrameColumns(
string,
{start: {line: location.line + 1, column: location.column + 1}},
{highlightCode: true},
{highlightCode},
);

jsonError.codeFrame = codeFrame;
jsonError.codeFrame = generateCodeFrame({highlightCode: true});
jsonError.rawCodeFrame = generateCodeFrame({highlightCode: false});
}

throw jsonError;
Expand Down
9 changes: 9 additions & 0 deletions test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,12 @@ test('throws exported error error', t => {
instanceOf: JSONError,
});
});

test('has error frame properties', t => {
try {
parseJson('{\n\t"foo": true,\n}', 'foo.json');
} catch (error) {
t.assert(error.codeFrame);
t.true(error.rawCodeFrame === ' 1 | {\n 2 | \t"foo": true,\n> 3 | }\n | ^');
Copy link
Owner

Choose a reason for hiding this comment

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

Use t.is()

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

}
});