diff --git a/.github/styles/Vocab/HMSVocab/accept.txt b/.github/styles/Vocab/HMSVocab/accept.txt new file mode 100644 index 000000000..f2a8db832 --- /dev/null +++ b/.github/styles/Vocab/HMSVocab/accept.txt @@ -0,0 +1,173 @@ +__main__ +__name__ +100ms +access_key +account_id +app_access_key +app_secret +async +beam_id +boolean +config +const +created_at +datetime +error_type +hostname +html +iat +json +JSON +jti +jwtid +meeting_url +metadata_id +metadata_timestamp +msg +nbf +npm +peer_id +presigned_url +recording_hls_vod_playlist_location +recording_single_files +recording_thumbnails +room_id +session_id +session_started_at +started_at +state_message +state_name +state_timestamp +stopped_at +sys +template_id +user_data +user_id +user_name +UUID +WebSocket +jwt +JWT +APIs +SDKs +param +Params +subscribeParams +application/json +customer_id +joined_at +left_at +TL;DR +Wowza +bitrate +custom_role_url +startedAt +meetingURL +livestream +recording_info +app_id +setVolume +trackBy +framerate +params +unmounting +HMSPeer's +hms +HMS +RTMP +HLS +URL +SDK +useEffect +DevTools +Bluetooth +Bool +downlink +YouTube +WebRTC +management_token +_id +you've +we've +We've +You've +pixelated +screenshare +unmuted +unmute +capturer +teardown +enum +nullable +subview +stringified +ProGuard +errMsg +bundler +validator +viewport +unmount +hls.failure +hls.stopped.success +hls.started.success +hls.recording.success +hls_vod_recording_path +hls_vod_recording_presigned_url +session_duration +px +broadcasted +navbar +upload_info +serializable +rtmpDestinations +hlsDestinations +WebKit +Codesandbox +autoplay +bitcode +onwards +Podfile +CocoaPods +FFmpeg +telehealth +kbps +updated_at +recording_assets +started_by +stopped_by +presign_duration +single_file_per_layer +asset_types +audio_only +hls +large_room +max_duration_seconds +codec +rtmp +txt +srt +superset +presign +output_modes +custom_vocabulary +tooltip +unmuting +sdk +autofocus +skippable +nack +pli +ssrc +tldraw +keyof +unobserve +qp +rehype +num +url +answer_max_len +answer_min_len +userid +peerid +ios +android diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 000000000..83c1058d2 --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,26 @@ +name: Vale linter + +on: + workflow_dispatch: + pull_request: + branches: + - develop + - main + +permissions: + checks: write + contents: read + + +jobs: + vale: + name: runner / vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@reviewdog + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + with: + fail_on_error: true + filter_mode: diff_context diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 000000000..54b8ace59 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,16 @@ +StylesPath = .github/styles + +MinAlertLevel = error + +Vocab = HMSVocab + +Packages = Google + +[*] + +BasedOnStyles = Vale, Google + + +BlockIgnores = (?s) *(\x60\x60\x60[a-z]*\n[\s\S]*?\x60\x60\x60) + +TokenIgnores = [a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12} , r.M , (^[a-z]|[A-Z])[a-z]* , `{3}([\S]+)?\n([\s\S]+)\n`{3} , .*",