From 737e6f1c25c583e0c1099134b21b375c1900657b Mon Sep 17 00:00:00 2001 From: Pascal Date: Thu, 19 Mar 2020 15:38:02 +0100 Subject: [PATCH 1/3] feat: added firebase plugin --- plugins/firebase/README.md | 45 ++++++++++++++++++++++++++++ plugins/firebase/firebase.plugin.zsh | 33 ++++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 plugins/firebase/README.md create mode 100644 plugins/firebase/firebase.plugin.zsh diff --git a/plugins/firebase/README.md b/plugins/firebase/README.md new file mode 100644 index 000000000..792af12a2 --- /dev/null +++ b/plugins/firebase/README.md @@ -0,0 +1,45 @@ +## Firebase plugin + +The Firebase plugin provides useful aliases for the [Firebase CLI](https://firebase.google.com/docs/cli). + +To use it, add firebase to the plugins array of your zshrc file: + +``` +plugins=(... firebase) +``` + +## Aliases + +Reference: https://firebase.google.com/docs/cli#admin-commands +(Only implemented often used commands.) + +```zsh +### INIT (FBI) - https://firebase.google.com/docs/cli#initialize_a_firebase_project +alias fbi="firebase init" # Initialize a Firebase project + +# USE (FBU) - https://firebase.google.com/docs/cli#add_alias +alias fbu="firebase use" # Use a firebase project +alias fbua="firebase use -add" # Add and use a firebase project + +# SERVE (FBS) - https://firebase.google.com/docs/cli#test-locally +alias fbs="firebase serve" # Serve a Firebase project locally +alias fbs0="firebase serve --host 0.0.0.0" # Serve a Firebase projeczt on 0.0.0.0 +alias fbsh="firebase serve --only hosting" # Serve a Firebase project locally () +alias fbsf="firebase serve --only functions" # Serve a Firebase project locally () + +# DEPLOY (FBD) - https://firebase.google.com/docs/cli#partial_deploys +alias fbd="firebase deploy" # Deploy Firebase (Complete) +alias fbdh="firebase deploy --only hosting" # Deploy Firebase Hosting +alias fbdd="firebase deploy --only database" # Deploy Firebase Realtime Database +alias fbds="firebase deploy --only storage" # Deploy Firebase Storage +alias fbdfs="firebase deploy --only firestore" # Deploy Firebase Firestore +alias fbdfsr="firebase deploy --only firestore:rules" # Deploy Firebase Firestore (only Rules) +alias fbdfsi="firebase deploy --only firestore:indexes" # Deploy Firebase Firestore (only Indexes) +alias fbdfu="firebase deploy --only functions" # Deploy Firebase Functions + +# FUNCTIONS (FBF) - https://firebase.google.com/docs/cli#delete_functions +alias fbfd="firebase functions:delete" # Delete Firebase Function + +# MISC (FBx) +alias fbp="firebase projects:list" # List all projects +``` \ No newline at end of file diff --git a/plugins/firebase/firebase.plugin.zsh b/plugins/firebase/firebase.plugin.zsh new file mode 100644 index 000000000..3535ff85d --- /dev/null +++ b/plugins/firebase/firebase.plugin.zsh @@ -0,0 +1,33 @@ +## Aliases + +# https://firebase.google.com/docs/cli#admin-commands +# Only implemented often used commands. + +# INIT (FBI) - https://firebase.google.com/docs/cli#initialize_a_firebase_project +alias fbi="firebase init" # Initialize a Firebase project + +# USE (FBU) - https://firebase.google.com/docs/cli#add_alias +alias fbu="firebase use" # Use a firebase project +alias fbua="firebase use -add" # Add and use a firebase project + +# SERVE (FBS) - https://firebase.google.com/docs/cli#test-locally +alias fbs="firebase serve" # Serve a Firebase project locally +alias fbs0="firebase serve --host 0.0.0.0" # Serve a Firebase projeczt on 0.0.0.0 +alias fbsh="firebase serve --only hosting" # Serve a Firebase project locally () +alias fbsf="firebase serve --only functions" # Serve a Firebase project locally () + +# DEPLOY (FBD) - https://firebase.google.com/docs/cli#partial_deploys +alias fbd="firebase deploy" # Deploy Firebase (Complete) +alias fbdh="firebase deploy --only hosting" # Deploy Firebase Hosting +alias fbdd="firebase deploy --only database" # Deploy Firebase Realtime Database +alias fbds="firebase deploy --only storage" # Deploy Firebase Storage +alias fbdfs="firebase deploy --only firestore" # Deploy Firebase Firestore +alias fbdfsr="firebase deploy --only firestore:rules" # Deploy Firebase Firestore (only Rules) +alias fbdfsi="firebase deploy --only firestore:indexes" # Deploy Firebase Firestore (only Indexes) +alias fbdfu="firebase deploy --only functions" # Deploy Firebase Functions + +# FUNCTIONS (FBF) - https://firebase.google.com/docs/cli#delete_functions +alias fbfd="firebase functions:delete" # Delete Firebase Function + +# MISC (FBx) +alias fbp="firebase projects:list" # List all projects \ No newline at end of file From 12dd539e68db305d55fa34d7b3142c357e285c62 Mon Sep 17 00:00:00 2001 From: Pascal Date: Thu, 19 Mar 2020 15:50:49 +0100 Subject: [PATCH 2/3] chore: updated comments --- plugins/firebase/firebase.plugin.zsh | 46 ++++++++++++++-------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/plugins/firebase/firebase.plugin.zsh b/plugins/firebase/firebase.plugin.zsh index 3535ff85d..02cf83196 100644 --- a/plugins/firebase/firebase.plugin.zsh +++ b/plugins/firebase/firebase.plugin.zsh @@ -3,31 +3,31 @@ # https://firebase.google.com/docs/cli#admin-commands # Only implemented often used commands. -# INIT (FBI) - https://firebase.google.com/docs/cli#initialize_a_firebase_project -alias fbi="firebase init" # Initialize a Firebase project +# INIT (fbi) - https://firebase.google.com/docs/cli#initialize_a_firebase_project +alias fbi="firebase init" -# USE (FBU) - https://firebase.google.com/docs/cli#add_alias -alias fbu="firebase use" # Use a firebase project -alias fbua="firebase use -add" # Add and use a firebase project +# USE (fbu) - https://firebase.google.com/docs/cli#add_alias +alias fbu="firebase use" +alias fbua="firebase use -add" -# SERVE (FBS) - https://firebase.google.com/docs/cli#test-locally -alias fbs="firebase serve" # Serve a Firebase project locally -alias fbs0="firebase serve --host 0.0.0.0" # Serve a Firebase projeczt on 0.0.0.0 -alias fbsh="firebase serve --only hosting" # Serve a Firebase project locally () -alias fbsf="firebase serve --only functions" # Serve a Firebase project locally () +# SERVE (fbs) - https://firebase.google.com/docs/cli#test-locally +alias fbs="firebase serve" +alias fbs0="firebase serve --host 0.0.0.0" +alias fbsh="firebase serve --only hosting" +alias fbsf="firebase serve --only functions" -# DEPLOY (FBD) - https://firebase.google.com/docs/cli#partial_deploys -alias fbd="firebase deploy" # Deploy Firebase (Complete) -alias fbdh="firebase deploy --only hosting" # Deploy Firebase Hosting -alias fbdd="firebase deploy --only database" # Deploy Firebase Realtime Database -alias fbds="firebase deploy --only storage" # Deploy Firebase Storage -alias fbdfs="firebase deploy --only firestore" # Deploy Firebase Firestore -alias fbdfsr="firebase deploy --only firestore:rules" # Deploy Firebase Firestore (only Rules) -alias fbdfsi="firebase deploy --only firestore:indexes" # Deploy Firebase Firestore (only Indexes) -alias fbdfu="firebase deploy --only functions" # Deploy Firebase Functions +# DEPLOY (gbd) - https://firebase.google.com/docs/cli#partial_deploys +alias fbd="firebase deploy" +alias fbdh="firebase deploy --only hosting" +alias fbdd="firebase deploy --only database" +alias fbds="firebase deploy --only storage" +alias fbdfs="firebase deploy --only firestore" +alias fbdfsr="firebase deploy --only firestore:rules" +alias fbdfsi="firebase deploy --only firestore:indexes" +alias fbdfu="firebase deploy --only functions" -# FUNCTIONS (FBF) - https://firebase.google.com/docs/cli#delete_functions -alias fbfd="firebase functions:delete" # Delete Firebase Function +# FUNCTIONS (fbf) - https://firebase.google.com/docs/cli#delete_functions +alias fbfd="firebase functions:delete" -# MISC (FBx) -alias fbp="firebase projects:list" # List all projects \ No newline at end of file +# MISC (fb..) +alias fbp="firebase projects:list" \ No newline at end of file From 145fa7b95bb7b9828ce6aa8d3c24f27cfa0c5546 Mon Sep 17 00:00:00 2001 From: Pascal Date: Thu, 19 Mar 2020 16:04:41 +0100 Subject: [PATCH 3/3] docs: updated aliases --- plugins/firebase/README.md | 69 ++++++++++++++++++++++++-------------- 1 file changed, 43 insertions(+), 26 deletions(-) diff --git a/plugins/firebase/README.md b/plugins/firebase/README.md index 792af12a2..8b6a4d1a7 100644 --- a/plugins/firebase/README.md +++ b/plugins/firebase/README.md @@ -11,35 +11,52 @@ plugins=(... firebase) ## Aliases Reference: https://firebase.google.com/docs/cli#admin-commands -(Only implemented often used commands.) -```zsh -### INIT (FBI) - https://firebase.google.com/docs/cli#initialize_a_firebase_project -alias fbi="firebase init" # Initialize a Firebase project +### fbi: [firebase init](https://firebase.google.com/docs/cli#initialize_a_firebase_project) -# USE (FBU) - https://firebase.google.com/docs/cli#add_alias -alias fbu="firebase use" # Use a firebase project -alias fbua="firebase use -add" # Add and use a firebase project -# SERVE (FBS) - https://firebase.google.com/docs/cli#test-locally -alias fbs="firebase serve" # Serve a Firebase project locally -alias fbs0="firebase serve --host 0.0.0.0" # Serve a Firebase projeczt on 0.0.0.0 -alias fbsh="firebase serve --only hosting" # Serve a Firebase project locally () -alias fbsf="firebase serve --only functions" # Serve a Firebase project locally () -# DEPLOY (FBD) - https://firebase.google.com/docs/cli#partial_deploys -alias fbd="firebase deploy" # Deploy Firebase (Complete) -alias fbdh="firebase deploy --only hosting" # Deploy Firebase Hosting -alias fbdd="firebase deploy --only database" # Deploy Firebase Realtime Database -alias fbds="firebase deploy --only storage" # Deploy Firebase Storage -alias fbdfs="firebase deploy --only firestore" # Deploy Firebase Firestore -alias fbdfsr="firebase deploy --only firestore:rules" # Deploy Firebase Firestore (only Rules) -alias fbdfsi="firebase deploy --only firestore:indexes" # Deploy Firebase Firestore (only Indexes) -alias fbdfu="firebase deploy --only functions" # Deploy Firebase Functions +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbi | `firebase init` | Initialize a Firebase project | -# FUNCTIONS (FBF) - https://firebase.google.com/docs/cli#delete_functions -alias fbfd="firebase functions:delete" # Delete Firebase Function +### fbi: [firebase use](https://firebase.google.com/docs/cli#add_alias) -# MISC (FBx) -alias fbp="firebase projects:list" # List all projects -``` \ No newline at end of file +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbu | `firebase use` | Use a firebase project | +| fbua | `firebase use -add` | Add and use a firebase project | + +### fbs: [firebase serve](https://firebase.google.com/docs/cli#test-locally) + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbs | `firebase serve` | Serve a Firebase project locally | +| fbs0 | `firebase serve --host 0.0.0.0` | Serve a Firebase projeczt on 0.0.0.0 | +| fbsh | `firebase serve --only hosting` | Serve a Firebase project locally (Only Hosting) | +| fbsf | `firebase serve --only functions` | Serve a Firebase project locally (only Functions) | + +#### fbd [firebase deploy](https://firebase.google.com/docs/cli#partial_deploys) + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbd | `firebase deploy` | Deploy Firebase (Complete) | +| fbdh | `firebase deploy --only hosting` | Deploy Firebase Hosting | +| fbdd | `firebase deploy --only database` | Deploy Firebase Realtime Database | +| fbds | `firebase deploy --only storage` | Deploy Firebase Storage | +| fbdfs | `firebase deploy --only firestore` | Deploy Firebase Firestore | +| fbdfsr | `firebase deploy --only firestore:rules` | Deploy Firebase Firestore (only Rules) | +| fbdfsi | `firebase deploy --only firestore:indexes` | Deploy Firebase Firestore (only Indexes) | +| fbdfu | `firebase deploy --only functions` | Deploy Firebase Functions | + +#### fbf - [firebase functions](https://firebase.google.com/docs/cli#delete_functions) + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbfd | `firebase functions:delete` | Delete Firebase Function | + +#### fb... - Misc + +| Alias | Command | Description | +| :---- | :----------------------------------------- | :--------------------------- | +| fbp | `firebase projects:list` | List all projects | \ No newline at end of file