Skip to content

Commit f05b9ac

Browse files
Adjust docs, upgrade Prettier and adjust paths
1 parent ad3de67 commit f05b9ac

File tree

7 files changed

+20
-56
lines changed

7 files changed

+20
-56
lines changed

.lintstagedrc.fix.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"src/**/*.{js,ts,tsx,md}": "eslint --fix",
3-
"{src/**/*.{js,ts,tsx,md,json}, .eslintrc.json, .prettierrc, babel.config.js}": "prettier --write"
3+
"**/*.{js,mjs,ts,mts,jsx,tsx,md,json,yml}": "prettier --write"
44
}

.lintstagedrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"src/**/*.{js,ts,tsx,md}": "eslint --max-warnings 0",
3-
"{src/**/*.{js,ts,tsx,md,json}, .eslintrc.json, .prettierrc, babel.config.js}": "prettier --list-different",
3+
"**/*.{js,mjs,ts,mts,jsx,tsx,md,json,yml}": "prettier --list-different",
44
"src/i18n/*.json": "yarn run validate-translations"
55
}

.prettierignore

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
node_modules
2-
/.cache/
3-
/public/static/styles.js
4-
examples/*/src/serviceWorker.js
5-
src/stream-emoji.json
6-
/dist/
7-
/lib/
8-
/bin/
9-
/include/
10-
/build/
11-
build
12-
*.md
13-
src/components/docs/
1+
node_modules/
2+
CHANGELOG.md
3+
examples/**/serviceWorker.ts
4+
./dist/

developers/BRANCHES.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,12 @@
11
# Branches
2-
We have 2 protected (base) branches:
32

4-
- `develop`
5-
- `master`
3+
We have one (base) branch, `master`. If you want to implement a solution, you are required to create branches from `master` or its derivatives. The `master` branch serves for release and should receive updates only through squash-merging feature branches - each of these squashed-commits should be up to date with `master` branch and should be passing CI requirements.
64

7-
If you want to implement a solution, you are required to create branches from `develop` or its derivatives.
8-
9-
The `develop` branch serves as a reservoir of bug fixes and new features waiting to be released.
10-
11-
The `master` branch serves for release and should receive updates only from the `develop` branch.
12-
13-
So the branch architecture in this repository is as follows:
5+
The branch architecture in this repository is as follows:
146

157
```shell
16-
NPM <--- master <--- develop <--- branch_solution_x
17-
<--- branch_solution_y
18-
<--- branch_solution_x
19-
...
8+
NPM <--- master <--- branch_solution_x
9+
<--- branch_solution_y
10+
<--- branch_solution_x
11+
...
2012
```

developers/DOCUMENTATION.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
11
# Documenting the SDK
22

3-
If you are introducing changes impacting the API or behavior of the SDK parts, you should document these. Our documentation is generated with [docusaurus](https://docusaurus.io/docs). We have our own cli tool [stream-chat-docusaurus-cli](https://github.com/GetStream/stream-chat-docusaurus-cli#installation-and-using-the-cli) to run the documentation server locally, so that you can inspect your adjustments.
4-
5-
## Run the documentation server locally
6-
7-
1. **Install [stream-chat-docusaurus-cli](https://github.com/GetStream/stream-chat-docusaurus-cli#installation-and-using-the-cli)**
8-
(You will need it to serve the documentation locally)
9-
2. **Run the documentation server**
10-
11-
12-
```bash
13-
yarn docs:run
14-
```
15-
16-
## Documentation patterns
17-
18-
To keep the documentation consistent we would like you to adhere to the following recommendations:
19-
20-
1. todo
3+
If you are introducing changes impacting the API or behavior of the SDK parts, you should document these, see [GetStream/docs](https://github.com/GetStream/docs) repository for more information.

package.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@
235235
"jsdom": "^24.1.1",
236236
"lint-staged": "^15.2.1",
237237
"moment-timezone": "^0.5.43",
238-
"prettier": "^3.4.2",
238+
"prettier": "^3.5.3",
239239
"react": "^19.0.0",
240240
"react-dom": "^19.0.0",
241241
"semantic-release": "^24.2.3",
@@ -253,7 +253,7 @@
253253
"lint-fix": "yarn prettier-fix && yarn eslint-fix",
254254
"eslint": "eslint --max-warnings 0",
255255
"eslint-fix": "eslint --fix",
256-
"prettier": "prettier 'src/**/*.{js,ts,jsx,tsx,md,json}' .prettierrc babel.config.js eslint.config.mjs",
256+
"prettier": "prettier '**/*.{js,mjs,ts,mts,jsx,tsx,md,json,yml}'",
257257
"prettier-fix": "yarn prettier --write",
258258
"fix-staged": "lint-staged --config .lintstagedrc.fix.json --concurrent 1",
259259
"start": "tsc --watch --sourceMap --declarationMap",
@@ -268,8 +268,6 @@
268268
"e2e": "playwright test",
269269
"e2e-fixtures": "node e2e/fixtures/fixtures.mjs",
270270
"e2e-container": "./e2e/scripts/run_in_container.sh",
271-
"docs:copy-css-docs": "scripts/merge-stream-chat-css-docs.sh node_modules/@stream-io/stream-chat-css/docs",
272-
"docs:run": "yarn docs:copy-css-docs && stream-chat-docusaurus -s",
273271
"prepack": "yarn build"
274272
},
275273
"resolutions": {
@@ -282,4 +280,4 @@
282280
"not op_mini all"
283281
],
284282
"packageManager": "[email protected]+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
285-
}
283+
}

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10700,10 +10700,10 @@ prelude-ls@^1.2.1:
1070010700
resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396"
1070110701
integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==
1070210702

10703-
prettier@^3.4.2:
10704-
version "3.4.2"
10705-
resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.4.2.tgz#a5ce1fb522a588bf2b78ca44c6e6fe5aa5a2b13f"
10706-
integrity sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ==
10703+
prettier@^3.5.3:
10704+
version "3.5.3"
10705+
resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.5.3.tgz#4fc2ce0d657e7a02e602549f053b239cb7dfe1b5"
10706+
integrity sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==
1070710707

1070810708
pretty-format@^27.0.2:
1070910709
version "27.5.1"

0 commit comments

Comments
 (0)