elsoul / skeet-firestore Goto Github PK

Details of Improvement

• The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in ".eslintrc.json".

Details

ESLint: 8.27.0

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/workspaces/skeet-dev/skeet-firestore".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

    npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in ".eslintrc.json".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Details of Improvement

• I want to add a test for the method because there is no test written for this plugin.

Expected behavior

• Using Firebase Emulator Suit in a local environment.
• Testing is possible even in a CI environment.

Reference link

• https://firebase.google.com/docs/rules/unit-tests
• https://github.com/firebase/quickstart-testing/tree/master/unit-test-security-rules-v9

Details of Improvement

• I want to adds test method (Add, Query, Update, Delete).

Reference Issue

#9

Expected behavior

implements tests below

• Adds Collection Items
• Get Collection Item
• Query Collection Items
• Update Collection Item
• Delete Collection Item

Details of Improvement

• I want to use type QueryCondition because don't export .
  

  skeet-firestore/src/lib/queryCollectionItems.ts

  Line 7 in a480d47

  type QueryCondition = {

Screenshot

Expected behavior

• can use QueryCondition call at queryCollectionItems.

https://firebase.google.com/docs/firestore/manage-data/add-data?hl=ja#server_timestamp

Maybe now the records from the same function have the same timestamp (function-triggered time), and it may cause some problems.

For example addStreamUserChatRoomMessage. If the record have the same timestamp, we can't show the messages as the correct order.

I think the server timestamp can make the timestamp for saved time but not function-triggered time.

Details of Improvement

I want to prevent the coding style from being different in the developer's environment when committing the source code.
I committed without formatting in #18, Reviewer had to format it again.

Expected behavior

• Use the pre-commit hook to automatically run prettier before committing so everyone commits with the same code style.

Reference

• https://prettier.io/docs/en/precommit.html

Details of Improvement

In v2.3.2, the alias of deleteCollectionItem has been changed to remove, but the README description has not been updated and still says delete.

ScreenShot

Expected behavior

• The README description should be updated correctly.

以下のように、documentのhtmlで改行なしに1行で書いているのは意図してのことでしょうか?

今のprettierの設定だと、強制的に改行してしまうので、この書き方を保つのならばformatさせないように .prettierignore に含めたほうが良いと思います。

• yarn format だと.prettierignoreにないのでhtmlもフォーマットされてしまう。

.next
out
dist
build
src/__generated__
src/schema.graphql

• lint-stagedによるコミット時のhookにはhtmlは含まれないのでフォーマットされない。

  "lint-staged": {
    "*.{ts,css,md}": "prettier --write"
  }

READMEにある advancedConditionsの条件で ageとnameの複合条件の例示がありますが
テストの中のコメントと一致していないと思います。

README

テスト内のコメント

クライアント側からアクセス可能なプラグインがあると嬉しい

Details of Improvement

このプラグインは、Admin SDKを用いて実装されているため FirestoreのSecurty Ruleを無視してアクセスすることが可能になっています。

バックエンドで行う想定のプラグインだとは思いますが、クライアント APIを使用すれば、クライアントからSecurity Ruleで制御された安全なアクセスが可能になります。

Reference, Snapshotをチェーンして必要なデータを取得するのはAdmin SDKと同じように煩雑な操作があり毎回書くのは面倒と感じます。

Expected behavior

• 現在のインタフェースと同様な（Firestore Converter、型安全）クライアントAPIを用いてSecurity Ruleによって制御されているプラグインが提供されると嬉しい

Reference

https://firebase.google.com/docs/reference/js/firestore_?hl=ja