@rljson/rljson 0.0.8 → 0.0.10

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.
@@ -17,14 +17,16 @@
17
17
  - [Install GitHub CLI](#install-github-cli)
18
18
  - [Develop](#develop)
19
19
  - [Read architecture doc](#read-architecture-doc)
20
- - [Checkout main](#checkout-main)
21
- - [Create a branch](#create-a-branch)
22
20
  - [Debug](#debug)
23
21
  - [Update goldens](#update-goldens)
24
22
  - [Test and Build](#test-and-build)
23
+ - [Workflow](#workflow)
24
+ - [Checkout main](#checkout-main)
25
+ - [Create a branch](#create-a-branch)
25
26
  - [Commit](#commit)
26
27
  - [Update dependencies](#update-dependencies)
27
28
  - [Increase version](#increase-version)
29
+ - [Push the branch](#push-the-branch)
28
30
  - [Create a pull request](#create-a-pull-request)
29
31
  - [Wait until PR is merged](#wait-until-pr-is-merged)
30
32
  - [Delete feature branch](#delete-feature-branch)
@@ -108,25 +110,6 @@ gh auth login
108
110
  Read [README.architecture.md](./README.architecture.md) to get an overview
109
111
  of the package's architecture.
110
112
 
111
- ### Checkout main
112
-
113
- ```bash
114
- git checkout main && \
115
- git fetch && \
116
- git pull
117
- ```
118
-
119
- ### Create a branch
120
-
121
- Please replace `Commit Message` in the next command by your commit message.
122
- It will also used for branch name and pull request
123
-
124
- ```bash
125
- export MESSAGE="Add more examples" && \
126
- export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
127
- git checkout -b $BRANCH
128
- ```
129
-
130
113
  ### Debug
131
114
 
132
115
  In Vscode: At the `left side bar` click on the `Test tube` icon to open the `Test explorer`.
@@ -157,6 +140,29 @@ pnpm test &&\
157
140
  pnpm build
158
141
  ```
159
142
 
143
+ <!-- ........................................................................-->
144
+
145
+ ## Workflow
146
+
147
+ ### Checkout main
148
+
149
+ ```bash
150
+ git checkout main && \
151
+ git fetch && \
152
+ git pull
153
+ ```
154
+
155
+ ### Create a branch
156
+
157
+ Please replace `Commit Message` in the next command by your commit message.
158
+ It will also used for branch name and pull request
159
+
160
+ ```bash
161
+ export MESSAGE="Add multi row example" && \
162
+ export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
163
+ git checkout -b $BRANCH
164
+ ```
165
+
160
166
  ### Commit
161
167
 
162
168
  Develop your feature
@@ -166,16 +172,16 @@ Commit your changes
166
172
  If you only have one thing, execute
167
173
 
168
174
  ```bash
169
- git commit -am"$MESSAGE"
175
+ git add . && git commit -m "$MESSAGE"
170
176
  ```
171
177
 
172
178
  ### Update dependencies
173
179
 
174
- We aim to work with the latest versions of our dependencies.
180
+ We aim to work with the latest versions of our dependencies
175
181
 
176
182
  ```bash
177
183
  pnpm update --latest &&\
178
- git commit -am"Update dependencies"
184
+ git commit -m"Update dependencies"
179
185
  ```
180
186
 
181
187
  ### Increase version
@@ -185,13 +191,19 @@ pnpm version patch --no-git-tag-version && \
185
191
  git commit -am"Increase version"
186
192
  ```
187
193
 
194
+ ### Push the branch
195
+
196
+ Use your ID or this git command to push the branch
197
+
198
+ ```bash
199
+ git push -u origin $BRANCH
200
+ ```
201
+
188
202
  ### Create a pull request
189
203
 
190
204
  ```bash
191
- git push -u origin $BRANCH && \
192
205
  gh pr create --base main --title "$MESSAGE" --body "" && \
193
206
  gh pr merge --auto --squash
194
-
195
207
  ```
196
208
 
197
209
  ### Wait until PR is merged
@@ -17,14 +17,16 @@
17
17
  - [Install GitHub CLI](#install-github-cli)
18
18
  - [Develop](#develop)
19
19
  - [Read architecture doc](#read-architecture-doc)
20
- - [Checkout main](#checkout-main)
21
- - [Create a branch](#create-a-branch)
22
20
  - [Debug](#debug)
23
21
  - [Update goldens](#update-goldens)
24
22
  - [Test and Build](#test-and-build)
23
+ - [Workflow](#workflow)
24
+ - [Checkout main](#checkout-main)
25
+ - [Create a branch](#create-a-branch)
25
26
  - [Commit](#commit)
26
27
  - [Update dependencies](#update-dependencies)
27
28
  - [Increase version](#increase-version)
29
+ - [Push the branch](#push-the-branch)
28
30
  - [Create a pull request](#create-a-pull-request)
29
31
  - [Wait until PR is merged](#wait-until-pr-is-merged)
30
32
  - [Delete feature branch](#delete-feature-branch)
@@ -108,25 +110,6 @@ gh auth login
108
110
  Read [README.architecture.md](./README.architecture.md) to get an overview
109
111
  of the package's architecture.
110
112
 
111
- ### Checkout main
112
-
113
- ```bash
114
- git checkout main && \
115
- git fetch && \
116
- git pull
117
- ```
118
-
119
- ### Create a branch
120
-
121
- Please replace `Commit Message` in the next command by your commit message.
122
- It will also used for branch name and pull request
123
-
124
- ```bash
125
- export MESSAGE="Add more examples" && \
126
- export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
127
- git checkout -b $BRANCH
128
- ```
129
-
130
113
  ### Debug
131
114
 
132
115
  In Vscode: At the `left side bar` click on the `Test tube` icon to open the `Test explorer`.
@@ -157,6 +140,29 @@ pnpm test &&\
157
140
  pnpm build
158
141
  ```
159
142
 
143
+ <!-- ........................................................................-->
144
+
145
+ ## Workflow
146
+
147
+ ### Checkout main
148
+
149
+ ```bash
150
+ git checkout main && \
151
+ git fetch && \
152
+ git pull
153
+ ```
154
+
155
+ ### Create a branch
156
+
157
+ Please replace `Commit Message` in the next command by your commit message.
158
+ It will also used for branch name and pull request
159
+
160
+ ```bash
161
+ export MESSAGE="Add multi row example" && \
162
+ export BRANCH=`echo "$MESSAGE" | tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9_]/_/g'` &&\
163
+ git checkout -b $BRANCH
164
+ ```
165
+
160
166
  ### Commit
161
167
 
162
168
  Develop your feature
@@ -166,16 +172,16 @@ Commit your changes
166
172
  If you only have one thing, execute
167
173
 
168
174
  ```bash
169
- git commit -am"$MESSAGE"
175
+ git add . && git commit -m "$MESSAGE"
170
176
  ```
171
177
 
172
178
  ### Update dependencies
173
179
 
174
- We aim to work with the latest versions of our dependencies.
180
+ We aim to work with the latest versions of our dependencies
175
181
 
176
182
  ```bash
177
183
  pnpm update --latest &&\
178
- git commit -am"Update dependencies"
184
+ git commit -m"Update dependencies"
179
185
  ```
180
186
 
181
187
  ### Increase version
@@ -185,13 +191,19 @@ pnpm version patch --no-git-tag-version && \
185
191
  git commit -am"Increase version"
186
192
  ```
187
193
 
194
+ ### Push the branch
195
+
196
+ Use your ID or this git command to push the branch
197
+
198
+ ```bash
199
+ git push -u origin $BRANCH
200
+ ```
201
+
188
202
  ### Create a pull request
189
203
 
190
204
  ```bash
191
- git push -u origin $BRANCH && \
192
205
  gh pr create --base main --title "$MESSAGE" --body "" && \
193
206
  gh pr merge --auto --squash
194
-
195
207
  ```
196
208
 
197
209
  ### Wait until PR is merged
package/dist/rljson.d.ts CHANGED
@@ -168,3 +168,4 @@ export interface Rljson extends Json {
168
168
  export declare const exampleRljson: () => Rljson;
169
169
  export declare const exampleRljsonEmpty: () => Rljson;
170
170
  export declare const exampleRljsonWithErrors: () => Rljson;
171
+ export declare const exampleRljsonWithMultipleRows: () => Rljson;
package/dist/rljson.js CHANGED
@@ -13,8 +13,37 @@ const exampleRljsonWithErrors = () => ({
13
13
  _data: []
14
14
  }
15
15
  });
16
+ const exampleRljsonWithMultipleRows = () => ({
17
+ table: {
18
+ _type: "properties",
19
+ _data: [
20
+ {
21
+ string: "str0",
22
+ boolean: true,
23
+ number: 1,
24
+ array: [1, "str0", true, { a: { b: "c" } }],
25
+ object: { a: { b: "c" } }
26
+ },
27
+ {
28
+ string: "str1",
29
+ boolean: true,
30
+ number: 1,
31
+ array: [1, "str1", true, { a: { b: "c" } }],
32
+ object: { a: { b: "c" } }
33
+ },
34
+ {
35
+ string: "str2",
36
+ boolean: false,
37
+ number: 1,
38
+ array: [1, "str1", true, { a: { b: "c" } }],
39
+ object: { d: { e: "f" } }
40
+ }
41
+ ]
42
+ }
43
+ });
16
44
  export {
17
45
  exampleRljson,
18
46
  exampleRljsonEmpty,
19
- exampleRljsonWithErrors
47
+ exampleRljsonWithErrors,
48
+ exampleRljsonWithMultipleRows
20
49
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rljson/rljson",
3
- "version": "0.0.8",
3
+ "version": "0.0.10",
4
4
  "packageManager": "pnpm@10.6.2",
5
5
  "description": "The RLJSON data format specification",
6
6
  "homepage": "https://github.com/rljson/rljson",
@@ -14,7 +14,7 @@
14
14
  "type": "git",
15
15
  "url": "git+https://github.com/rljson/rljson.git"
16
16
  },
17
- "main": "dist/index.js",
17
+ "main": "dist/rljson.js",
18
18
  "types": "dist/index.d.ts",
19
19
  "files": [
20
20
  "dist"
@@ -39,6 +39,7 @@
39
39
  "eslint-plugin-tsdoc": "^0.4.0",
40
40
  "globals": "^16.0.0",
41
41
  "jsdoc": "^4.0.4",
42
+ "read-pkg": "^9.0.1",
42
43
  "typescript": "~5.8.2",
43
44
  "typescript-eslint": "^8.26.1",
44
45
  "vite": "^6.2.1",