Skip to content

Commit

Permalink
added instructions to developer file
Browse files Browse the repository at this point in the history
  • Loading branch information
avifenesh committed Feb 21, 2024
1 parent 30c0068 commit 14a70d8
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 6 deletions.
14 changes: 12 additions & 2 deletions .github/workflows/lint-ts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,17 @@ jobs:

- name: lint ts
run: |
npm install @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-tsdoc eslint typescript eslint-plugin-import@latest eslint-config-prettier prettier
npm install @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-tsdoc eslint typescript eslint-plugin-import@latest eslint-config-prettier
npm i
npx eslint .
npm run prettier:check:ci
- name: Iterate over folders and prettier
run: |
folders=("node" "benchmarks/node" "utilities")
for folder in "${folders[@]}"; do
echo "Linting ${folder}..."
cd "${folder}"
npm install
npm run prettier:check:ci
cd ..
done
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[github-actions-workflow]": {
"editor.defaultFormatter": "redhat.vscode-yaml"
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"yaml.schemas": {
"https://json.schemastore.org/github-workflow.json": [
Expand Down
4 changes: 3 additions & 1 deletion node/DEVELOPER.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,11 @@ Development on the Node wrapper may involve changes in either the TypeScript or
1. TypeScript
```bash
# Run from the `node` folder
npm install eslint-plugin-import@latest @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-tsdoc eslint typescript eslint-plugin-import@latest eslint-config-prettier
npm install eslint-plugin-import@latest @typescript-eslint/parser @typescript-eslint/eslint-plugin eslint-plugin-tsdoc eslint typescript eslint-plugin-import@latest eslint-config-prettier prettier
npm i
npx eslint . --max-warnings=0
npm run prettier:format
npm run prettier:check:ci
```
2. Rust
```bash
Expand Down
4 changes: 2 additions & 2 deletions node/src/Transaction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -414,9 +414,9 @@ export class BaseTransaction<T extends BaseTransaction<T>> {

/** Returns the number of fields contained in the hash stored at `key`.
* See https://redis.io/commands/hlen/ for more details.
*
*
* @param key - The key of the hash.
*
*
* Command Response - The number of fields in the hash, or 0 when the key does not exist.
*/
public hlen(key: string): T {
Expand Down

0 comments on commit 14a70d8

Please sign in to comment.