chore: add lint script to docs

ghostdevv · ghostdevv · commit 374c33610cba · 2025-10-10T01:54:00.000+02:00
diff --git a/packages/docs/.prettierignore b/packages/docs/.prettierignore
@@ -0,0 +1,4 @@
+dist
+.astro
+node_modules
+package.json
diff --git a/packages/docs/.prettierrc b/packages/docs/.prettierrc
@@ -1,14 +1,14 @@
 {
-    "singleQuote": true,
-    "quoteProps": "as-needed",
-    "trailingComma": "all",
-    "bracketSpacing": true,
-    "arrowParens": "always",
-    "semi": true,
-    "useTabs": true,
-    "tabWidth": 4,
-    "svelteSortOrder": "scripts-options-markup-styles",
-    "svelteAllowShorthand": true,
-    "svelteBracketNewLine": false,
-    "svelteIndentScriptAndStyle": true
-}
+	"singleQuote": true,
+	"quoteProps": "as-needed",
+	"trailingComma": "all",
+	"bracketSpacing": true,
+	"arrowParens": "always",
+	"semi": true,
+	"useTabs": true,
+	"tabWidth": 4,
+	"svelteSortOrder": "scripts-options-markup-styles",
+	"svelteAllowShorthand": true,
+	"svelteBracketNewLine": false,
+	"svelteIndentScriptAndStyle": true
+}
diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -8,7 +8,9 @@
     "build": "astro build",
     "preview": "astro preview",
     "astro": "astro",
-    "check": "astro check"
+    "check": "astro check",
+   	"lint": "prettier --check .",
+	"format": "prettier --write ."
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.4",
@@ -17,6 +19,9 @@
     "astro": "^4.16.12",
     "css-tree": "^3.0.1",
     "klona": "^2.0.6",
+    "prettier": "^3.3.3",
+    "prettier-plugin-astro": "^0.14.1",
+    "prettier-plugin-svelte": "^3.2.8",
     "sharp": "^0.33.5",
     "starlight-links-validator": "^0.13.2",
     "svelte": "^5.2.0",
diff --git a/packages/docs/src/content/docs/components/image/configuration.mdx b/packages/docs/src/content/docs/components/image/configuration.mdx
@@ -498,7 +498,7 @@ a background, or an object, which can take the following options:
 		{
 			prop: 'seed',
 			type: 'number',
-			example: () => (<code>3</code>),
+			example: () => <code>3</code>,
 		},
 	]}
 />
diff --git a/packages/docs/src/content/docs/guides/custom-domain.mdx b/packages/docs/src/content/docs/guides/custom-domain.mdx
@@ -1,12 +1,12 @@
 ---
-title: "Adding a Custom Domain"
+title: 'Adding a Custom Domain'
 ---
 
-Enhance the delivery of your media assets by integrating svelte-cloudinary with a [private CDN and/or custom domain](https://cloudinary.com/documentation/advanced_url_delivery_options#private_cdns_and_custom_delivery_hostnames_cnames).  
+Enhance the delivery of your media assets by integrating svelte-cloudinary with a [private CDN and/or custom domain](https://cloudinary.com/documentation/advanced_url_delivery_options#private_cdns_and_custom_delivery_hostnames_cnames).
 
 :::note  
 **Private CDN** and **Custom Domain** features are available exclusively on [Cloudinary's Advanced plan](https://cloudinary.com/pricing).  
-:::  
+:::
 
 ## Step-by-Step Configuration
 
@@ -23,10 +23,11 @@ npm install svelte-cloudinary
 Create a `.env` file in your project root (if it doesn't exist already) and add the following variables:
 
 ```bash
-VITE_CLOUDINARY_CLOUD_NAME="your_cloud_name"  
-VITE_CLOUDINARY_PRIVATE_CDN="true"  
-VITE_CLOUDINARY_SECURE_DISTRIBUTION="your-custom-domain.com"  
+VITE_CLOUDINARY_CLOUD_NAME="your_cloud_name"
+VITE_CLOUDINARY_PRIVATE_CDN="true"
+VITE_CLOUDINARY_SECURE_DISTRIBUTION="your-custom-domain.com"
 ```
+
 Replace your_cloud_name with your actual Cloudinary cloud name and your-custom-domain.com with your custom domain. Read more about [configuring svelte-cloudinary here](https://svelte.cloudinary.dev/config).
 
 :::caution
@@ -43,7 +44,7 @@ With the configuration in place, use the `<CldImage />` component to serve image
 </script>
 
 <CldImage
-  src="<Your Public ID>" 
+  src="<Your Public ID>"
   alt="Sample Image"
   width="800"
   height="600"
@@ -52,7 +53,7 @@ With the configuration in place, use the `<CldImage />` component to serve image
 
 This setup ensures that the image URL follows your custom domain structure:
 
-- **Before:** `https://res.cloudinary.com/your_cloud_name/image/upload/sample.jpg`
-- **After:** `https://your-custom-domain.com/image/upload/sample.jpg`
+-   **Before:** `https://res.cloudinary.com/your_cloud_name/image/upload/sample.jpg`
+-   **After:** `https://your-custom-domain.com/image/upload/sample.jpg`
 
-Learn more about setting up CNAME records on the [Cloudinary docs](https://cloudinary.com/documentation/advanced_url_delivery_options#private_cdns_and_custom_delivery_hostnames_cnames).
+Learn more about setting up CNAME records on the [Cloudinary docs](https://cloudinary.com/documentation/advanced_url_delivery_options#private_cdns_and_custom_delivery_hostnames_cnames).
diff --git a/packages/docs/src/content/docs/helpers/getcldimageurl/configuration.mdx b/packages/docs/src/content/docs/helpers/getcldimageurl/configuration.mdx
@@ -469,7 +469,7 @@ a background, or an object, which can take the following options:
 		{
 			prop: 'seed',
 			type: 'number',
-			example: () => (<code>3</code>),
+			example: () => <code>3</code>,
 		},
 	]}
 />
diff --git a/packages/docs/src/content/docs/helpers/getcldimageurl/index.mdx b/packages/docs/src/content/docs/helpers/getcldimageurl/index.mdx
@@ -15,5 +15,5 @@ const url = getCldImageUrl({
 	src: 'images/turtle',
 	height: 600,
 	width: 960,
-})
+});
 ```
diff --git a/packages/docs/src/content/docs/helpers/getcldogimageurl/index.mdx b/packages/docs/src/content/docs/helpers/getcldogimageurl/index.mdx
@@ -13,5 +13,5 @@ import { getCldOgImageUrl } from 'svelte-cloudinary';
 
 const url = getCldOgImageUrl({
 	src: 'images/turtle',
-})
+});
 ```
diff --git a/packages/docs/src/content/docs/index.mdx b/packages/docs/src/content/docs/index.mdx
@@ -30,14 +30,10 @@ import { CardGrid, Card } from '@astrojs/starlight/components';
 	<Card title="Social Cards" icon="comment">
 		Easiest way to create beautiful social cards in Svelte.
 	</Card>
-  <Card title="And More..." icon="list-format">
-    - Adaptive Bitrate Streaming
-    - Generative AI
-    - Text & Image Overlays
-    - ...
-  </Card>
+	<Card title="And More..." icon="list-format">
+		- Adaptive Bitrate Streaming - Generative AI - Text & Image Overlays -
+		...
+	</Card>
 </CardGrid>
 
-<center>
-### Transform & Deliver at Scale with Cloudinary
-</center>
+<center>### Transform & Deliver at Scale with Cloudinary</center>
diff --git a/packages/docs/src/content/docs/missing.mdx b/packages/docs/src/content/docs/missing.mdx
@@ -2,4 +2,4 @@
 title: 'Missing Page!'
 ---
 
-This page hasn't been ported over to v2 yet - you can check [the GitHub](https://github.com/cloudinary-community/svelte-cloudinary/issues) for updates.
+This page hasn't been ported over to v2 yet - you can check [the GitHub](https://github.com/cloudinary-community/svelte-cloudinary/issues) for updates.
diff --git a/packages/docs/src/theme.css b/packages/docs/src/theme.css
@@ -40,8 +40,8 @@
 [data-has-hero] a.primary {
 	color: var(--sl-color-white);
 	font-weight: 600;
-    font-size: 1.1rem;
-    letter-spacing: 0px;
+	font-size: 1.1rem;
+	letter-spacing: 0px;
 }
 
 [data-theme='light'][data-has-hero] a.primary {
@@ -51,9 +51,10 @@
 [data-has-hero] .page {
 	background:
 		linear-gradient(215deg, #ff3e0020, transparent 40%),
-		radial-gradient(#ff3e0020, transparent 40%) no-repeat -60vw -40vh / 105vw 200vh,
-		radial-gradient(#ff3e0020, transparent 65%) no-repeat 50% calc(100% + 20rem) /
-			60rem 30rem;
+		radial-gradient(#ff3e0020, transparent 40%) no-repeat -60vw -40vh /
+			105vw 200vh,
+		radial-gradient(#ff3e0020, transparent 65%) no-repeat 50%
+			calc(100% + 20rem) / 60rem 30rem;
 }
 
 [data-has-hero] header {
diff --git a/packages/docs/svelte.config.js b/packages/docs/svelte.config.js
@@ -2,4 +2,4 @@ import { vitePreprocess } from '@astrojs/svelte';
 
 export default {
 	preprocess: vitePreprocess(),
-}
+};
diff --git a/packages/docs/tsconfig.json b/packages/docs/tsconfig.json
@@ -1,11 +1,11 @@
 {
-  "extends": "astro/tsconfigs/strict",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "$assets/*": ["./src/assets/*"],
-      "$lib/*": ["./src/lib/*"]
-    }
-  },
-  "exclude": ["node_modules/**"]
-}
+	"extends": "astro/tsconfigs/strict",
+	"compilerOptions": {
+		"baseUrl": ".",
+		"paths": {
+			"$assets/*": ["./src/assets/*"],
+			"$lib/*": ["./src/lib/*"]
+		}
+	},
+	"exclude": ["node_modules/**"]
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +dist
 +.astro
 +node_modules
 +package.json
Original file line number	Diff line number	Diff line change
`@@ -498,7 +498,7 @@ a background, or an object, which can take the following options:`
`498`	`498`	`{`
`499`	`499`	`prop: 'seed',`
`500`	`500`	`type: 'number',`
`501`		`- example: () => (<code>3</code>),`
	`501`	`+ example: () => <code>3</code>,`
`502`	`502`	`},`
`503`	`503`	`]}`
`504`	`504`	`/>`
Original file line number	Diff line number	Diff line change
`@@ -469,7 +469,7 @@ a background, or an object, which can take the following options:`
`469`	`469`	`{`
`470`	`470`	`prop: 'seed',`
`471`	`471`	`type: 'number',`
`472`		`- example: () => (<code>3</code>),`
	`472`	`+ example: () => <code>3</code>,`
`473`	`473`	`},`
`474`	`474`	`]}`
`475`	`475`	`/>`