Adding in the docs

Author: jaysin586

docs/.gitignore

@@ -0,0 +1,25 @@
+test-results
+node_modules
+
+# Output
+.output
+.vercel
+/.svelte-kit
+/build
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+
+# Sentry Config File
+.env.sentry-build-plugin

docs/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

docs/.prettierignore

@@ -0,0 +1,4 @@
+# Package Managers
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

docs/.prettierrc

@@ -0,0 +1,21 @@
+{
+    "useTabs": false,
+    "trailingComma": "none",
+    "printWidth": 100,
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": true,
+    "plugins": [
+        "prettier-plugin-svelte",
+        "prettier-plugin-organize-imports",
+        "prettier-plugin-tailwindcss"
+    ],
+    "overrides": [
+        {
+            "files": "*.svelte",
+            "options": {
+                "parser": "svelte"
+            }
+        }
+    ]
+}

docs/README.md

@@ -0,0 +1,38 @@
+# sv
+
+Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+
+## Creating a project
+
+If you're seeing this, you've probably already done this step. Congrats!
+
+```bash
+# create a new project in the current directory
+npx sv create
+
+# create a new project in my-app
+npx sv create my-app
+```
+
+## Developing
+
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+
+```bash
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+## Building
+
+To create a production version of your app:
+
+```bash
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.

docs/components.json

@@ -0,0 +1,17 @@
+{
+    "$schema": "https://next.shadcn-svelte.com/schema.json",
+    "style": "default",
+    "tailwind": {
+        "config": "tailwind.config.ts",
+        "css": "src/app.css",
+        "baseColor": "zinc"
+    },
+    "aliases": {
+        "components": "$lib/shadcn/components",
+        "utils": "$lib/shadcn/utils",
+        "ui": "$lib/shadcn/components/ui",
+        "hooks": "$lib/shadcn/hooks"
+    },
+    "typescript": true,
+    "registry": "https://next.shadcn-svelte.com/registry"
+}

docs/e2e/demo.test.ts

@@ -0,0 +1,6 @@
+import { expect, test } from '@playwright/test'
+
+test('home page has expected h1', async ({ page }) => {
+    await page.goto('/')
+    await expect(page.locator('h1')).toBeVisible()
+})

docs/eslint.config.mjs

@@ -0,0 +1,112 @@
+import { includeIgnoreFile } from '@eslint/compat'
+import js from '@eslint/js'
+import prettier from 'eslint-config-prettier'
+import svelte from 'eslint-plugin-svelte'
+import globals from 'globals'
+import { fileURLToPath } from 'node:url'
+import ts from 'typescript-eslint'
+const gitignorePath = fileURLToPath(new URL('./.gitignore', import.meta.url))
+
+export default [
+    includeIgnoreFile(gitignorePath),
+    {
+        ignores: [
+            '**/.DS_Store',
+            '**/node_modules',
+            'postcss.config.cjs',
+            '**/build',
+            '.svelte-kit',
+            'package',
+            '**/.env',
+            '**/.env.*',
+            '!**/.env.example',
+            '**/pnpm-lock.yaml',
+            '**/package-lock.json',
+            '**/yarn.lock',
+            'src/routes/poc',
+            '**/dist',
+            'vite.config.ts.*'
+        ]
+    },
+    js.configs.recommended,
+    ...ts.configs.recommended,
+    ...svelte.configs['flat/recommended'],
+    prettier,
+    ...svelte.configs['flat/prettier'],
+    {
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+                ...globals.node
+            }
+        },
+
+        rules: {
+            semi: ['warn', 'never'],
+            quotes: ['error', 'single'],
+            'dot-location': ['warn', 'property'],
+            'guard-for-in': ['warn'],
+            'no-multi-spaces': ['warn'],
+            yoda: ['warn', 'never'],
+            camelcase: ['error'],
+            'comma-style': ['warn'],
+            'comma-dangle': ['off', 'always-multiline'],
+            'block-spacing': ['warn'],
+            'keyword-spacing': ['warn'],
+            'no-trailing-spaces': ['warn'],
+            'no-unneeded-ternary': ['warn'],
+            'no-whitespace-before-property': ['warn'],
+            'object-curly-spacing': ['warn', 'always'],
+            'space-before-blocks': ['warn'],
+            'space-in-parens': ['warn'],
+            'arrow-spacing': ['warn'],
+            'no-duplicate-imports': ['error'],
+            'no-var': ['error'],
+            'prefer-const': ['error'],
+
+            'no-unused-vars': [
+                'warn',
+                {
+                    argsIgnorePattern: '^_',
+                    ignoreRestSiblings: true
+                }
+            ],
+            '@typescript-eslint/no-unused-expressions': [
+                'error',
+                {
+                    allowShortCircuit: true,
+                    allowTernary: true,
+                    allowTaggedTemplates: true
+                }
+            ]
+        }
+    },
+    {
+        files: ['**/*.svelte'],
+        languageOptions: {
+            parserOptions: {
+                parser: ts.parser
+            }
+        }
+    },
+    {
+        /* location of your components where you would like to apply these rules  */
+        files: ['**/shadcn/components/ui/**/*.svelte', '**/shadcn/components/ui/**/*.ts'],
+        languageOptions: {
+            parserOptions: {
+                parser: ts.parser
+            }
+        },
+        rules: {
+            '@typescript-eslint/no-unused-vars': [
+                'warn',
+                {
+                    argsIgnorePattern: '^_',
+                    varsIgnorePattern: '^\\$\\$(Props|Events|Slots|Generic)$'
+                }
+            ],
+            'prefer-const': ['off'],
+            'no-unused-vars': ['off']
+        }
+    }
+]