caseparser 1.1.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.editorconfig +12 -0
- package/.nvmrc +1 -0
- package/.prettierrc +8 -0
- package/CHANGELOG.md +13 -0
- package/README.md +93 -174
- package/dist/index.d.ts +43 -0
- package/dist/index.js +387 -0
- package/dist/index.mjs +371 -0
- package/package.json +43 -15
- package/playground.ts +9 -0
- package/.vscode/launch.json +0 -14
- package/index.js +0 -7
- package/lib/caseparser.js +0 -413
- package/test-camel-case.js +0 -365
- package/test-dash-case.js +0 -365
- package/test-pascal-case.js +0 -365
- package/test-snake-case.js +0 -365
- package/test-upper-dash-case.js +0 -365
- package/test-upper-snake-case.js +0 -365
- package/test.js +0 -31
package/.editorconfig
ADDED
package/.nvmrc
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
v18.15.0
|
package/.prettierrc
ADDED
package/CHANGELOG.md
ADDED
package/README.md
CHANGED
|
@@ -1,152 +1,131 @@
|
|
|
1
|
-
# [CaseParser](https://github.com/NandoMB/caseparser)
|
|
1
|
+
# [CaseParser](https://github.com/NandoMB/caseparser) Version 2.x.x
|
|
2
|
+
Convert **Strings** and **JSON (Object Keys)** from a ```case type``` to another one.
|
|
2
3
|
|
|
3
|
-
Convert **Strings**/**Arrays**/**Objects** from a type of case to another one.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
###### Notes:
|
|
6
|
+
> This is the version 2.x.x that supports Typescript. If you're looking for 1.x.x version, [here](https://github.com/NandoMB/caseparser/tree/v1.x.x) is the docs.
|
|
6
7
|
|
|
7
|
-
### Suported case types convertions:
|
|
8
|
-
- **camelCase**
|
|
9
|
-
- **snake_case**
|
|
10
|
-
- **dash-case**
|
|
11
|
-
- **PascalCase**
|
|
12
|
-
- **UPPER_SNAKE_CASE**
|
|
13
|
-
- **UPPER-DASH-CASE**
|
|
14
8
|
|
|
15
|
-
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
16
11
|
```sh
|
|
17
|
-
$
|
|
18
|
-
```
|
|
12
|
+
$ yarn add caseparser
|
|
19
13
|
|
|
20
|
-
#
|
|
21
|
-
##### caseparser.snakeToCamel(data)
|
|
22
|
-
The variable data represents a string, an array or an object.
|
|
14
|
+
# or
|
|
23
15
|
|
|
24
|
-
|
|
25
|
-
var caseparser = require('caseparser');
|
|
16
|
+
$ npm add caseparser
|
|
26
17
|
|
|
27
|
-
|
|
28
|
-
{
|
|
29
|
-
id: 1,
|
|
30
|
-
first_name: "Timothee",
|
|
31
|
-
last_name: "Clausner",
|
|
32
|
-
email: "tclausner0@economist.com",
|
|
33
|
-
addresses: [
|
|
34
|
-
{
|
|
35
|
-
country: "United States",
|
|
36
|
-
state: "Illinois",
|
|
37
|
-
city: "Rockford",
|
|
38
|
-
postal_code: "61105",
|
|
39
|
-
street: {
|
|
40
|
-
street_name: "41 Forest Run Circle",
|
|
41
|
-
street_number: "539"
|
|
42
|
-
}
|
|
43
|
-
},
|
|
44
|
-
{
|
|
45
|
-
country: "United States",
|
|
46
|
-
state: "California",
|
|
47
|
-
city: "Inglewood",
|
|
48
|
-
postal_code: "90305",
|
|
49
|
-
street: {
|
|
50
|
-
street_name: "456 Brown Center",
|
|
51
|
-
street_number: "550"
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
]
|
|
55
|
-
}
|
|
56
|
-
];
|
|
18
|
+
# or
|
|
57
19
|
|
|
58
|
-
|
|
59
|
-
console.log(JSON.stringify(result, null, 2));
|
|
20
|
+
$ pnpm add caseparser
|
|
60
21
|
```
|
|
61
22
|
|
|
62
|
-
|
|
23
|
+
## Supported conversion types
|
|
63
24
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
25
|
+
##### Converts from camelCase to ...
|
|
26
|
+
```js
|
|
27
|
+
caseparser.camelToDash(data);
|
|
28
|
+
caseparser.camelToPascal(data);
|
|
29
|
+
caseparser.camelToSnake(data);
|
|
30
|
+
caseparser.camelToUpperDash(data);
|
|
31
|
+
caseparser.camelToUpperSnake(data);
|
|
32
|
+
```
|
|
33
|
+
##### Converts from snakeCase to ...
|
|
34
|
+
```js
|
|
35
|
+
caseparser.snakeToCamel(data);
|
|
36
|
+
caseparser.snakeToDash(data);
|
|
37
|
+
caseparser.snakeToPascal(data);
|
|
38
|
+
caseparser.snakeToUpperDash(data);
|
|
39
|
+
caseparser.snakeToUpperSnake(data);
|
|
40
|
+
```
|
|
41
|
+
##### Converts from dashCase to ...
|
|
42
|
+
```js
|
|
43
|
+
caseparser.dashToCamel(data);
|
|
44
|
+
caseparser.dashToPascal(data);
|
|
45
|
+
caseparser.dashToSnake(data);
|
|
46
|
+
caseparser.dashToUpperDash(data);
|
|
47
|
+
caseparser.dashToUpperSnake(data);
|
|
48
|
+
```
|
|
49
|
+
##### Converts from pascalCase to ...
|
|
50
|
+
```js
|
|
51
|
+
caseparser.pascalToCamel(data);
|
|
52
|
+
caseparser.pascalToDash(data);
|
|
53
|
+
caseparser.pascalToSnake(data);
|
|
54
|
+
caseparser.pascalToUpperDash(data);
|
|
55
|
+
caseparser.pascalToUpperSnake(data);
|
|
56
|
+
```
|
|
57
|
+
##### Converts from upperSnakeCase to ...
|
|
58
|
+
```js
|
|
59
|
+
caseparser.upperSnakeToCamel(data);
|
|
60
|
+
caseparser.upperSnakeToDash(data);
|
|
61
|
+
caseparser.upperSnakeToPascal(data);
|
|
62
|
+
caseparser.upperSnakeToSnake(data);
|
|
63
|
+
caseparser.upperSnakeToUpperDash(data);
|
|
95
64
|
```
|
|
65
|
+
##### Converts from upperDashCase to ...
|
|
66
|
+
```js
|
|
67
|
+
caseparser.upperDashToCamel(data);
|
|
68
|
+
caseparser.upperDashToDash(data);
|
|
69
|
+
caseparser.upperDashToPascal(data);
|
|
70
|
+
caseparser.upperDashToSnake(data);
|
|
71
|
+
caseparser.upperDashToUpperSnake(data);
|
|
72
|
+
```
|
|
73
|
+
|
|
96
74
|
|
|
97
|
-
##### caseparser.camelToSnake(data)
|
|
98
|
-
The variable data represents a string, an array or an object.
|
|
99
75
|
|
|
76
|
+
## How to use
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
##### Example 1
|
|
80
|
+
Passing **String** as parameter:
|
|
81
|
+
```ts
|
|
82
|
+
import caseparser from 'caseparser';
|
|
83
|
+
|
|
84
|
+
caseparser.camelToSnake('loremIpsumIsSimplyDummyTextOfThePrintingAndTypesettingIndustry');
|
|
85
|
+
```
|
|
86
|
+
Will result:
|
|
87
|
+
```json
|
|
88
|
+
'lorem_ipsum_is_simply_dummy_text_of_the_printing_and_typesetting_industry'
|
|
89
|
+
```
|
|
90
|
+
---
|
|
91
|
+
#### Example 2
|
|
92
|
+
Passing **JSON** as parameter:
|
|
100
93
|
```js
|
|
101
|
-
|
|
94
|
+
import caseparser from 'caseparser';
|
|
102
95
|
|
|
103
|
-
|
|
96
|
+
const data = [
|
|
104
97
|
{
|
|
105
98
|
id: 1,
|
|
106
|
-
firstName:
|
|
107
|
-
lastName:
|
|
108
|
-
email:
|
|
99
|
+
firstName: 'John',
|
|
100
|
+
lastName: 'Doe',
|
|
101
|
+
email: 'john.doe@example.com',
|
|
109
102
|
addresses: [
|
|
110
103
|
{
|
|
111
|
-
country:
|
|
112
|
-
state:
|
|
113
|
-
city:
|
|
114
|
-
postalCode:
|
|
115
|
-
street: {
|
|
116
|
-
streetName: "41 Forest Run Circle",
|
|
117
|
-
streetNumber: "539"
|
|
118
|
-
}
|
|
119
|
-
},
|
|
120
|
-
{
|
|
121
|
-
country: "United States",
|
|
122
|
-
state: "California",
|
|
123
|
-
city: "Inglewood",
|
|
124
|
-
postalCode: "90305",
|
|
104
|
+
country: 'United States',
|
|
105
|
+
state: 'Illinois',
|
|
106
|
+
city: 'Rockford',
|
|
107
|
+
postalCode: '61105',
|
|
125
108
|
street: {
|
|
126
|
-
streetName:
|
|
127
|
-
streetNumber:
|
|
109
|
+
streetName: '41 Forest Run Circle',
|
|
110
|
+
streetNumber: '539'
|
|
128
111
|
}
|
|
129
112
|
}
|
|
130
113
|
]
|
|
131
114
|
}
|
|
132
115
|
];
|
|
133
|
-
|
|
134
|
-
var result = caseparser.camelToSnake(data);
|
|
135
|
-
console.log(JSON.stringify(result, null, 2));
|
|
116
|
+
const result = caseparser.camelToSnake(data);
|
|
136
117
|
```
|
|
137
|
-
|
|
138
118
|
Result:
|
|
139
|
-
|
|
140
119
|
```json
|
|
141
120
|
[
|
|
142
121
|
{
|
|
143
122
|
"id": 1,
|
|
144
|
-
"first_name": "
|
|
145
|
-
"last_name": "
|
|
146
|
-
"email": "
|
|
123
|
+
"first_name": "John",
|
|
124
|
+
"last_name": "Doe",
|
|
125
|
+
"email": "john.doe@example.com",
|
|
147
126
|
"addresses": [
|
|
148
127
|
{
|
|
149
|
-
"country": "
|
|
128
|
+
"country": "United States",
|
|
150
129
|
"state": "Illinois",
|
|
151
130
|
"city": "Rockford",
|
|
152
131
|
"postal_code": "61105",
|
|
@@ -154,72 +133,12 @@ Result:
|
|
|
154
133
|
"street_name": "41 Forest Run Circle",
|
|
155
134
|
"street_number": "539"
|
|
156
135
|
}
|
|
157
|
-
},
|
|
158
|
-
{
|
|
159
|
-
"country": "United States",
|
|
160
|
-
"state": "California",
|
|
161
|
-
"city": "Inglewood",
|
|
162
|
-
"postal_code": "90305",
|
|
163
|
-
"street": {
|
|
164
|
-
"street_name": "456 Brown Center",
|
|
165
|
-
"street_number": "550"
|
|
166
|
-
}
|
|
167
136
|
}
|
|
168
137
|
]
|
|
169
138
|
}
|
|
170
139
|
]
|
|
171
140
|
```
|
|
172
141
|
|
|
173
|
-
# Methods:
|
|
174
|
-
#### Converts from camelCase to ...
|
|
175
|
-
```js
|
|
176
|
-
caseparser.camelToSnake(data);
|
|
177
|
-
caseparser.camelToDash(data);
|
|
178
|
-
caseparser.camelToPascal(data);
|
|
179
|
-
caseparser.camelToUpperSnake(data);
|
|
180
|
-
caseparser.camelToUpperDash(data);
|
|
181
|
-
```
|
|
182
|
-
#### Converts from snakeCase to ...
|
|
183
|
-
```js
|
|
184
|
-
caseparser.snakeToCamel(data);
|
|
185
|
-
caseparser.snakeToDash(data);
|
|
186
|
-
caseparser.snakeToPascal(data);
|
|
187
|
-
caseparser.snakeToUpperSnake(data);
|
|
188
|
-
caseparser.snakeToUpperDash(data);
|
|
189
|
-
```
|
|
190
|
-
#### Converts from dashCase to ...
|
|
191
|
-
```js
|
|
192
|
-
caseparser.dashToCamel(data);
|
|
193
|
-
caseparser.dashToSnake(data);
|
|
194
|
-
caseparser.dashToPascal(data);
|
|
195
|
-
caseparser.dashToUpperSnake(data);
|
|
196
|
-
caseparser.dashToUpperDash(data);
|
|
197
|
-
```
|
|
198
|
-
#### Converts from pascalCase to ...
|
|
199
|
-
```js
|
|
200
|
-
caseparser.pascalToCamel(data);
|
|
201
|
-
caseparser.pascalToSnake(data);
|
|
202
|
-
caseparser.pascalToDash(data);
|
|
203
|
-
caseparser.pascalToUpperSnake(data);
|
|
204
|
-
caseparser.pascalToUpperDash(data);
|
|
205
|
-
```
|
|
206
|
-
#### Converts from upperSnakeCase to ...
|
|
207
|
-
```js
|
|
208
|
-
caseparser.upperSnakeToCamel(data);
|
|
209
|
-
caseparser.upperSnakeToSnake(data);
|
|
210
|
-
caseparser.upperSnakeToDash(data);
|
|
211
|
-
caseparser.upperSnakeToPascal(data);
|
|
212
|
-
caseparser.upperSnakeToUpperDash(data);
|
|
213
|
-
```
|
|
214
|
-
#### Converts from upperDashCase to ...
|
|
215
|
-
```js
|
|
216
|
-
caseparser.upperDashToCamel(data);
|
|
217
|
-
caseparser.upperDashToSnake(data);
|
|
218
|
-
caseparser.upperDashToDash(data);
|
|
219
|
-
caseparser.upperDashToPascal(data);
|
|
220
|
-
caseparser.upperDashToUpperSnake(data);
|
|
221
|
-
```
|
|
222
|
-
|
|
223
142
|
## License
|
|
224
143
|
The MIT License (MIT)
|
|
225
144
|
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
type JsonValue = boolean | number | string | null | JsonObject | JsonArray;
|
|
2
|
+
type JsonObject = {
|
|
3
|
+
[key: string]: JsonValue;
|
|
4
|
+
};
|
|
5
|
+
type JsonArray = JsonValue[];
|
|
6
|
+
type Json = JsonObject | JsonArray;
|
|
7
|
+
type CaseParserInput = string | Json;
|
|
8
|
+
type CaseParserOutput = string | Json;
|
|
9
|
+
|
|
10
|
+
declare const _default: {
|
|
11
|
+
upperSnakeToCamel(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
12
|
+
upperSnakeToSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
13
|
+
upperSnakeToDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
14
|
+
upperSnakeToPascal(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
15
|
+
upperSnakeToUpperDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
16
|
+
upperDashToCamel(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
17
|
+
upperDashToSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
18
|
+
upperDashToDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
19
|
+
upperDashToPascal(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
20
|
+
upperDashToUpperSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
21
|
+
snakeToCamel(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
22
|
+
snakeToDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
23
|
+
snakeToPascal(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
24
|
+
snakeToUpperSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
25
|
+
snakeToUpperDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
26
|
+
pascalToCamel(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
27
|
+
pascalToSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
28
|
+
pascalToDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
29
|
+
pascalToUpperSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
30
|
+
pascalToUpperDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
31
|
+
dashToSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
32
|
+
dashToCamel(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
33
|
+
dashToPascal(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
34
|
+
dashToUpperSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
35
|
+
dashToUpperDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
36
|
+
camelToDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
37
|
+
camelToSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
38
|
+
camelToPascal(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
39
|
+
camelToUpperSnake(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
40
|
+
camelToUpperDash(input: CaseParserInput): string | JsonObject | JsonArray | null;
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
export { CaseParserInput, CaseParserOutput, _default as default };
|