From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Wed, 7 Jun 2023 10:06:51 +0000 (+0200)
Subject: docs: add vscode snippets
X-Git-Tag: pinia@2.1.4~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9511b6809b4b21ce154c90969fc02eada2fdae09;p=thirdparty%2Fvuejs%2Fpinia.git

docs: add vscode snippets
---

diff --git a/packages/docs/.vitepress/config/en.ts b/packages/docs/.vitepress/config/en.ts
index 13e55dcb..f6ac8759 100644
--- a/packages/docs/.vitepress/config/en.ts
+++ b/packages/docs/.vitepress/config/en.ts
@@ -104,7 +104,6 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
         },
         {
           text: 'Cookbook',
-          collapsible: true,
           collapsed: false,
           items: [
             {
@@ -131,6 +130,14 @@ export const enConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
               text: 'Composing Stores',
               link: '/cookbook/composing-stores.html',
             },
+            {
+              text: 'VSCode Snippets',
+              link: '/cookbook/vscode-snippets.html',
+            },
+            {
+              text: 'Migration from Vuex',
+              link: '/cookbook/migration-vuex.html',
+            },
             {
               text: 'Migration from v0/v1 to v2',
               link: '/cookbook/migration-v1-v2.html',
diff --git a/packages/docs/.vitepress/config/zh.ts b/packages/docs/.vitepress/config/zh.ts
index aa9ddaf5..e456e2ef 100644
--- a/packages/docs/.vitepress/config/zh.ts
+++ b/packages/docs/.vitepress/config/zh.ts
@@ -112,7 +112,6 @@ export const zhConfig: LocaleSpecificConfig<DefaultTheme.Config> = {
         },
         {
           text: '手册',
-          collapsible: true,
           collapsed: false,
           items: [
             {
diff --git a/packages/docs/.vitepress/theme/styles/vars.css b/packages/docs/.vitepress/theme/styles/vars.css
index 082cd485..212e7a45 100644
--- a/packages/docs/.vitepress/theme/styles/vars.css
+++ b/packages/docs/.vitepress/theme/styles/vars.css
@@ -87,6 +87,7 @@ html.dark:root {
 
   --vp-c-bg: var(--vp-c-black);
   --vp-c-bg-soft: var(--vp-c-black-light);
+  --vp-c-bg-soft-up: var(--vp-c-black-lighter);
   --vp-c-bg-mute: var(--vp-c-black-light);
   --vp-c-bg-soft-mute: var(--vp-c-black-lighter);
   --vp-c-bg-alt: #0d121b;
diff --git a/packages/docs/cookbook/vscode-snippets.md b/packages/docs/cookbook/vscode-snippets.md
new file mode 100644
index 00000000..cdd714df
--- /dev/null
+++ b/packages/docs/cookbook/vscode-snippets.md
@@ -0,0 +1,49 @@
+# VSCode Snippets
+
+These are some snippets that I use in VSCode to make my life easier.
+
+Manage user snippets with <kbd>⇧</kbd> <kbd>⌘</kbd> <kbd>P</kbd> / <kbd>Ctrl</kbd> <kbd>⇧</kbd> <kbd>P</kbd> and then `Snippets: Configure User Snippets`.
+
+```json
+{
+  "Pinia Options Store Boilerplate": {
+    "scope": "javascript,typescript",
+    "prefix": "pinia-options",
+    "body": [
+      "import { defineStore, acceptHMRUpdate } from 'pinia'",
+      "",
+      "export const use${TM_FILENAME_BASE/^(.*)$/${1:/pascalcase}/}Store = defineStore('$TM_FILENAME_BASE', {",
+      " state: () => ({",
+      "   $0",
+      " }),",
+      " getters: {},",
+      " actions: {},",
+      "})",
+      "",
+      "if (import.meta.hot) {",
+      " import.meta.hot.accept(acceptHMRUpdate(use${TM_FILENAME_BASE/^(.*)$/${1:/pascalcase}/}Store, import.meta.hot))",
+      "}",
+      ""
+    ],
+    "description": "Bootstrap the code needed for a Vue.js Pinia Options Store file"
+  },
+  "Pinia Setup Store Boilerplate": {
+    "scope": "javascript,typescript",
+    "prefix": "pinia-setup",
+    "body": [
+      "import { defineStore, acceptHMRUpdate } from 'pinia'",
+      "",
+      "export const use${TM_FILENAME_BASE/^(.*)$/${1:/pascalcase}/}Store = defineStore('$TM_FILENAME_BASE', () => {",
+      " $0",
+      " return {}",
+      "})",
+      "",
+      "if (import.meta.hot) {",
+      " import.meta.hot.accept(acceptHMRUpdate(use${TM_FILENAME_BASE/^(.*)$/${1:/pascalcase}/}Store, import.meta.hot))",
+      "}",
+      ""
+    ],
+    "description": "Bootstrap the code needed for a Vue.js Pinia Setup Store file"
+  }
+}
+```