Skip to content

Commit 10882ff

Browse files
nzakasnzakas
authoredMar 14, 2025··
fix: Update types and apply to all rules (#86)
* fix: Update types and apply to all rules * Remove momoa * Fix rule types
·
json-v0.11.0
1 parent d9eab9e commit 10882ff

7 files changed

+120
-16
lines changed
 

‎src/rules/no-duplicate-keys.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
//-----------------------------------------------------------------------------
1717

1818
/** @type {NoDuplicateKeysRuleDefinition} */
19-
export default {
19+
const rule = {
2020
meta: {
2121
type: "problem",
2222

@@ -66,3 +66,5 @@ export default {
6666
};
6767
},
6868
};
69+
70+
export default rule;

‎src/rules/no-empty-keys.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
//-----------------------------------------------------------------------------
1616

1717
/** @type {NoEmptyKeysRuleDefinition} */
18-
export default {
18+
const rule = {
1919
meta: {
2020
type: "problem",
2121

@@ -46,3 +46,5 @@ export default {
4646
};
4747
},
4848
};
49+
50+
export default rule;

‎src/rules/no-unnormalized-keys.js

+21-6
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,21 @@
33
* @author Bradley Meck Farias
44
*/
55

6-
export default {
6+
//-----------------------------------------------------------------------------
7+
// Type Definitions
8+
//-----------------------------------------------------------------------------
9+
10+
/** @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds */
11+
/** @typedef {import("../types.ts").JSONRuleDefinition<[{form:string}], NoUnnormalizedKeysMessageIds>} NoUnnormalizedKeysRuleDefinition */
12+
13+
//-----------------------------------------------------------------------------
14+
// Rule Definition
15+
//-----------------------------------------------------------------------------
16+
17+
/** @type {NoUnnormalizedKeysRuleDefinition} */
18+
const rule = {
719
meta: {
8-
type: /** @type {const} */ ("problem"),
20+
type: "problem",
921

1022
docs: {
1123
description: "Disallow JSON keys that are not normalized",
@@ -29,17 +41,18 @@ export default {
2941
},
3042

3143
create(context) {
32-
const normalization = context.options.length
33-
? text => text.normalize(context.options[0].form)
34-
: text => text.normalize();
44+
const form = context.options.length
45+
? context.options[0].form
46+
: undefined;
47+
3548
return {
3649
Member(node) {
3750
const key =
3851
node.name.type === "String"
3952
? node.name.value
4053
: node.name.name;
4154

42-
if (normalization(key) !== key) {
55+
if (key.normalize(form) !== key) {
4356
context.report({
4457
loc: node.name.loc,
4558
messageId: "unnormalizedKey",
@@ -52,3 +65,5 @@ export default {
5265
};
5366
},
5467
};
68+
69+
export default rule;

‎src/rules/no-unsafe-values.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const NON_ZERO = /[1-9]/u;
3030
//-----------------------------------------------------------------------------
3131

3232
/** @type {NoUnsafeValuesRuleDefinition} */
33-
export default {
33+
const rule = {
3434
meta: {
3535
type: "problem",
3636

@@ -145,3 +145,5 @@ export default {
145145
};
146146
},
147147
};
148+
149+
export default rule;

‎src/rules/sort-keys.js

+64-5
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,99 @@
11
/**
2-
* @fileoverview Rule to require JSON object keys to be sorted. Copied largely from https://github.com/eslint/eslint/blob/main/lib/rules/sort-keys.js
2+
* @fileoverview Rule to require JSON object keys to be sorted.
3+
* Copied largely from https://github.com/eslint/eslint/blob/main/lib/rules/sort-keys.js
34
* @author Robin Thomas
45
*/
56

7+
//-----------------------------------------------------------------------------
8+
// Imports
9+
//-----------------------------------------------------------------------------
10+
611
import naturalCompare from "natural-compare";
712

13+
//-----------------------------------------------------------------------------
14+
// Type Definitions
15+
//-----------------------------------------------------------------------------
16+
17+
/** @typedef {"sortKeys"} SortKeysMessageIds */
18+
19+
/**
20+
* @typedef {Object} SortOptions
21+
* @property {boolean} caseSensitive
22+
* @property {boolean} natural
23+
* @property {number} minKeys
24+
* @property {boolean} allowLineSeparatedGroups
25+
*/
26+
27+
/** @typedef {"asc"|"desc"} SortDirection */
28+
/** @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions */
29+
/** @typedef {import("../types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>} SortKeysRuleDefinition */
30+
/** @typedef {(a:string,b:string) => boolean} Comparator */
31+
/** @typedef {import("@humanwhocodes/momoa").MemberNode} MemberNode */
32+
33+
//-----------------------------------------------------------------------------
34+
// Helpers
35+
//-----------------------------------------------------------------------------
36+
837
const hasNonWhitespace = /\S/u;
938

1039
const comparators = {
1140
ascending: {
1241
alphanumeric: {
42+
/** @type {Comparator} */
1343
sensitive: (a, b) => a <= b,
44+
45+
/** @type {Comparator} */
1446
insensitive: (a, b) => a.toLowerCase() <= b.toLowerCase(),
1547
},
1648
natural: {
49+
/** @type {Comparator} */
1750
sensitive: (a, b) => naturalCompare(a, b) <= 0,
51+
52+
/** @type {Comparator} */
1853
insensitive: (a, b) =>
1954
naturalCompare(a.toLowerCase(), b.toLowerCase()) <= 0,
2055
},
2156
},
2257
descending: {
2358
alphanumeric: {
59+
/** @type {Comparator} */
2460
sensitive: (a, b) =>
2561
comparators.ascending.alphanumeric.sensitive(b, a),
62+
63+
/** @type {Comparator} */
2664
insensitive: (a, b) =>
2765
comparators.ascending.alphanumeric.insensitive(b, a),
2866
},
2967
natural: {
68+
/** @type {Comparator} */
3069
sensitive: (a, b) => comparators.ascending.natural.sensitive(b, a),
70+
71+
/** @type {Comparator} */
3172
insensitive: (a, b) =>
3273
comparators.ascending.natural.insensitive(b, a),
3374
},
3475
},
3576
};
3677

78+
/**
79+
* Gets the MemberNode's string key value.
80+
* @param {MemberNode} member
81+
* @return {string}
82+
*/
3783
function getKey(member) {
38-
return member.name.type === `Identifier`
84+
return member.name.type === "Identifier"
3985
? member.name.name
4086
: member.name.value;
4187
}
4288

43-
export default {
89+
//-----------------------------------------------------------------------------
90+
// Rule Definition
91+
//-----------------------------------------------------------------------------
92+
93+
/** @type {SortKeysRuleDefinition} */
94+
const rule = {
4495
meta: {
45-
type: /** @type {const} */ ("suggestion"),
96+
type: "suggestion",
4697

4798
defaultOptions: [
4899
"asc",
@@ -112,8 +163,14 @@ export default {
112163
}
113164
}
114165

115-
// Note that there can be comments *inside* members, e.g. `{"foo: /* comment *\/ "bar"}`, but these are ignored when calculating line-separated groups
166+
/**
167+
* Checks if two members are line-separated.
168+
* @param {MemberNode} prevMember The previous member.
169+
* @param {MemberNode} member The current member.
170+
* @return {boolean}
171+
*/
116172
function isLineSeparated(prevMember, member) {
173+
// Note that there can be comments *inside* members, e.g. `{"foo: /* comment *\/ "bar"}`, but these are ignored when calculating line-separated groups
117174
const prevMemberEndLine = prevMember.loc.end.line;
118175
const thisStartLine = member.loc.start.line;
119176
if (thisStartLine - prevMemberEndLine < 2) {
@@ -176,3 +233,5 @@ export default {
176233
};
177234
},
178235
};
236+
237+
export default rule;

‎src/rules/top-level-interop.js

+16-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,21 @@
33
* @author Joe Hildebrand
44
*/
55

6-
export default {
6+
//-----------------------------------------------------------------------------
7+
// Type Definitions
8+
//-----------------------------------------------------------------------------
9+
10+
/** @typedef {"topLevel"} TopLevelInteropMessageIds */
11+
/** @typedef {import("../types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>} TopLevelInteropRuleDefinition */
12+
13+
//-----------------------------------------------------------------------------
14+
// Rule Definition
15+
//-----------------------------------------------------------------------------
16+
17+
/** @type {TopLevelInteropRuleDefinition} */
18+
const rule = {
719
meta: {
8-
type: /** @type {const} */ ("problem"),
20+
type: "problem",
921

1022
docs: {
1123
description:
@@ -33,3 +45,5 @@ export default {
3345
};
3446
},
3547
};
48+
49+
export default rule;

‎src/types.ts

+10
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,16 @@ export interface IJSONSourceCode
105105
beforeCount?: number,
106106
afterCount?: number,
107107
): string;
108+
109+
/**
110+
* Any comments found in a JSONC or JSON5 file.
111+
*/
112+
comments: Array<Token> | undefined;
113+
114+
/**
115+
* The lines of text found in the file.
116+
*/
117+
lines: Array<string>;
108118
}
109119

110120
export type IJSONLanguage = Language<{

0 commit comments

Comments
 (0)
Please sign in to comment.